@clockworkdog/cogs-client 1.5.2 → 1.5.5

package/README.md

@@ -20,14 +20,6 @@ Include the script in your HTML page:
 
 ### NPM / Yarn
 
-If you haven't yet created a web project we recommend using Vite with Typescript:
-
-```shell
-yarn create vite my-custom-content --template vanilla-ts
-cd my-custom-content
-yarn
-```
-
 Then add `cogs-client` with NPM or Yarn:
 
 ```shell
@@ -38,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,7 +89,10 @@ 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 });
@@ -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) => {
@@ -114,6 +135,7 @@ class AudioPlayer {
                 // Non-preloaded clips don't yet have an HTML audio node
                 // so we need to set the audio output when it's playing
                 clipPlayer.player.once('play', () => {
+                    log('play() callback - setPlayerSinkId', { soundId });
                     setPlayerSinkId(clipPlayer.player, this.sinkId);
                 });
                 clipPlayer.player.once('stop', () => this.handleStoppedClip(path, playId, soundId), soundId);
@@ -130,19 +152,23 @@ class AudioPlayer {
                     loop,
                     volume,
                 };
+                log('CLIP -> play_requested');
                 // Once clip starts, check if it should actually be paused or stopped
                 // If not, then update state to 'playing'
                 clipPlayer.player.once('play', () => {
-                    const clipState = clipPlayer.activeClips[soundId].state;
-                    if (clipState.type === 'pause_requested') {
+                    var _a;
+                    log('play() callback - update state', { soundId });
+                    const clipState = (_a = clipPlayer.activeClips[soundId]) === null || _a === void 0 ? void 0 : _a.state;
+                    if ((clipState === null || clipState === void 0 ? void 0 : clipState.type) === 'pause_requested') {
                         log('Clip started playing but should be paused', { path, soundId });
                         this.pauseAudioClip(path, { fade: clipState.fade }, soundId, true);
                     }
-                    else if (clipState.type === 'stop_requested') {
+                    else if ((clipState === null || clipState === void 0 ? void 0 : clipState.type) === 'stop_requested') {
                         log('Clip started playing but should be stopped', { path, soundId });
                         this.stopAudioClip(path, { fade: clipState.fade }, soundId, true);
                     }
                     else {
+                        log('CLIP -> playing');
                         this.updateActiveAudioClip(path, soundId, (clip) => ({ ...clip, state: { type: 'playing' } }));
                     }
                 }, soundId);
@@ -152,6 +178,7 @@ class AudioPlayer {
                     clipPlayer.player.volume(0, soundId);
                     clipPlayer.player.mute(false, soundId);
                     clipPlayer.player.once('play', () => {
+                        log('play() callback - fade volume', { soundId });
                         fadeAudioPlayerVolume(clipPlayer.player, volume, fade * 1000, soundId);
                     }, soundId);
                 }
@@ -181,21 +208,25 @@ class AudioPlayer {
                             // Fade then pause
                             clipPlayer.player.once('fade', (soundId) => {
                                 clipPlayer.player.pause(soundId);
+                                log('CLIP -> paused (after fade)');
                                 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');
                             clip.state = { type: 'pausing' };
                         }
                         else {
                             // Pause now
                             clipPlayer.player.pause(soundId);
+                            log('CLIP -> paused');
                             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');
                         clip.state = { type: 'pause_requested', fade };
                     }
                 }
@@ -227,6 +258,7 @@ class AudioPlayer {
                             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);
+                            log('CLIP -> stopping');
                             clip.state = { type: 'stopping' };
                         }
                         else {
@@ -237,6 +269,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');
                         clip.state = { type: 'stop_requested', fade };
                     }
                 }