@clockworkdog/cogs-client 1.5.3 → 1.5.6

package/README.md

@@ -30,6 +30,10 @@ yarn add @clockworkdog/cogs-client
 
 ## Usage
 
+### Create a `cogs-plugin-manifest.json` file
+
+See [PluginManifestJson](https://clockwork-dog.github.io/cogs-client-lib/interfaces/PluginManifestJson.html) for details of what to include.
+
 ### Import the library
 
 #### Browser

package/dist/AudioPlayer.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const howler_1 = require("howler");
 const urls_1 = require("./helpers/urls");
-const DEBUG = true;
+const DEBUG = false;
 // Check an iOS-only property (See https://developer.mozilla.org/en-US/docs/Web/API/Navigator#non-standard_properties)
 const IS_IOS = typeof navigator.standalone !== 'undefined';
 class AudioPlayer {
@@ -89,10 +89,13 @@ class AudioPlayer {
         this.updateAudioClipPlayer(path, (clipPlayer) => {
             // Paused clips need to be played again
             const pausedSoundIds = Object.entries(clipPlayer.activeClips)
-                .filter(([, { state }]) => state.type === 'paused' || state.type === 'pausing')
+                .filter(([, { state }]) => state.type === 'paused')
+                .map(([id]) => parseInt(id));
+            const pausingSoundIds = Object.entries(clipPlayer.activeClips)
+                .filter(([, { state }]) => state.type === 'pausing')
                 .map(([id]) => parseInt(id));
             pausedSoundIds.forEach((soundId) => {
-                log('Resuming paused clip', { soundId });
+                log('Resuming paused clip', soundId);
                 clipPlayer.player.play(soundId);
             });
             // Clips with pause requested no longer need to pause, they can continue playing now
@@ -100,7 +103,25 @@ class AudioPlayer {
                 .filter(([, { state }]) => state.type === 'pause_requested')
                 .map(([id]) => parseInt(id));
             // If no currently paused/pausing/pause_requested clips, play a new clip
-            const newSoundIds = pausedSoundIds.length > 0 || pauseRequestedSoundIds.length > 0 ? [] : [clipPlayer.player.play()];
+            const newSoundIds = pausedSoundIds.length > 0 || pausingSoundIds.length > 0 || pauseRequestedSoundIds.length > 0 ? [] : [clipPlayer.player.play()];
+            // Pausing clips are technically currently playing as far as Howler is concerned
+            pausingSoundIds.forEach((soundId) => {
+                log('Stopping fade and resuming pausing clip', soundId);
+                // Stop the fade callback
+                clipPlayer.player.off('fade', undefined, soundId);
+                // Set loop property
+                clipPlayer.player.loop(loop, soundId);
+                // Update state to 'playing'
+                this.updateActiveAudioClip(path, soundId, (clip) => ({ ...clip, state: { type: 'playing' } }));
+                // Set volume, or start a new fade
+                if (isFadeValid(fade)) {
+                    // Start fade when clip starts
+                    fadeAudioPlayerVolume(clipPlayer.player, volume, fade * 1000, soundId);
+                }
+                else {
+                    setAudioPlayerVolume(clipPlayer.player, volume, soundId);
+                }
+            });
             // paused and pause_requested clips treated the same, they should have their properties
             // updated with the latest play action's properties
             [...pausedSoundIds, ...pauseRequestedSoundIds, ...newSoundIds].forEach((soundId) => {
@@ -130,6 +151,7 @@ class AudioPlayer {
                     loop,
                     volume,
                 };
+                log('CLIP -> play_requested', soundId);
                 // Once clip starts, check if it should actually be paused or stopped
                 // If not, then update state to 'playing'
                 clipPlayer.player.once('play', () => {
@@ -144,6 +166,7 @@ class AudioPlayer {
                         this.stopAudioClip(path, { fade: clipState.fade }, soundId, true);
                     }
                     else {
+                        log('CLIP -> playing', soundId);
                         this.updateActiveAudioClip(path, soundId, (clip) => ({ ...clip, state: { type: 'playing' } }));
                     }
                 }, soundId);
@@ -182,21 +205,25 @@ class AudioPlayer {
                             // Fade then pause
                             clipPlayer.player.once('fade', (soundId) => {
                                 clipPlayer.player.pause(soundId);
+                                log('CLIP -> paused (after fade)', soundId);
                                 this.updateActiveAudioClip(path, soundId, (clip) => ({ ...clip, state: { type: 'paused' } }));
                                 this.notifyClipStateListeners(clip.playId, path, 'paused');
                             }, soundId);
                             fadeAudioPlayerVolume(clipPlayer.player, 0, fade * 1000, soundId);
+                            log('CLIP -> pausing', soundId);
                             clip.state = { type: 'pausing' };
                         }
                         else {
                             // Pause now
                             clipPlayer.player.pause(soundId);
+                            log('CLIP -> paused', soundId);
                             clip.state = { type: 'paused' };
                             this.notifyClipStateListeners(clip.playId, path, 'paused');
                         }
                     }
                     // Clip hasn't started playing yet, or has already had pause_requested (but fade may have changed so update here)
                     else if (clip.state.type === 'play_requested' || clip.state.type === 'pause_requested') {
+                        log('CLIP -> pause_requested', soundId);
                         clip.state = { type: 'pause_requested', fade };
                     }
                 }
@@ -206,9 +233,10 @@ class AudioPlayer {
         });
     }
     stopAudioClip(path, { fade }, onlySoundId, allowIfStopRequested) {
-        var _a, _b;
+        var _a, _b, _c;
+        log('Stop audio clip', { activeClips: (_a = this.audioClipPlayers[path]) === null || _a === void 0 ? void 0 : _a.activeClips });
         // No active clips to stop
-        if (Object.keys((_b = (_a = this.audioClipPlayers[path]) === null || _a === void 0 ? void 0 : _a.activeClips) !== null && _b !== void 0 ? _b : {}).length === 0) {
+        if (Object.keys((_c = (_b = this.audioClipPlayers[path]) === null || _b === void 0 ? void 0 : _b.activeClips) !== null && _c !== void 0 ? _c : {}).length === 0) {
             return;
         }
         this.updateAudioClipPlayer(path, (clipPlayer) => {
@@ -227,10 +255,16 @@ class AudioPlayer {
                             clipPlayer.player.off('fade', soundId);
                             fadeAudioPlayerVolume(clipPlayer.player, 0, fade * 1000, soundId);
                             // Set callback after starting new fade, otherwise it will fire straight away as the previous fade is cancelled
-                            clipPlayer.player.once('fade', (soundId) => clipPlayer.player.stop(soundId), soundId);
+                            clipPlayer.player.once('fade', (soundId) => {
+                                clipPlayer.player.loop(false, soundId);
+                                clipPlayer.player.stop(soundId), soundId;
+                            });
+                            log('CLIP -> stopping', soundId);
                             clip.state = { type: 'stopping' };
                         }
                         else {
+                            log('Stop clip', soundId);
+                            clipPlayer.player.loop(false, soundId);
                             clipPlayer.player.stop(soundId);
                         }
                     }
@@ -238,6 +272,7 @@ class AudioPlayer {
                     // or has pause_requested, but stop takes precedence
                     else if (clip.state.type === 'play_requested' || clip.state.type === 'pause_requested' || clip.state.type === 'stop_requested') {
                         log("Trying to stop clip which hasn't started playing yet", { path, soundId });
+                        log('CLIP -> stop_requested', soundId);
                         clip.state = { type: 'stop_requested', fade };
                     }
                 }
@@ -439,9 +474,8 @@ function setAudioPlayerVolume(howl, volume, soundId) {
 /**
  * Fade to audio volume
  *
- * This doesn't work on iOS (volume is read-only) so at least mute it if the volume is zero
+ * Note: This doesn't work on iOS (volume is read-only)
  */
 function fadeAudioPlayerVolume(howl, volume, fade, soundId) {
-    howl.mute(false, soundId);
     howl.fade(howl.volume(soundId), volume, fade, soundId);
 }