fixed on started event, added event on paused, on resumed and on stopped

chrisweb · chrisweb · commit 3f77cb92a883 · 2017-03-14T15:36:07.000+01:00
diff --git a/build/@types/web-audio-api-player/library/sound.d.ts b/build/@types/web-audio-api-player/library/sound.d.ts
@@ -9,21 +9,24 @@ export interface IOnProgress {
 export interface IOnEnded {
     (willPlayNext: boolean): void;
 }
-export interface IOnStarted {
-    (): void;
+export interface IOnAnyAction {
+    (playTimeOffset: number): void;
 }
 export interface ISoundAttributes {
     sources?: (ISoundSource | string)[] | string;
     id: number;
     playlistId?: number | null;
     loop?: boolean;
-    onLoading?: IOnProgress;
-    onPlaying?: IOnProgress;
-    onEnded?: IOnEnded;
-    onStarted?: IOnStarted;
     audioBuffer?: AudioBuffer | null;
     arrayBuffer?: ArrayBuffer | null;
     duration?: number | null;
+    onLoading?: IOnProgress;
+    onPlaying?: IOnProgress;
+    onEnded?: IOnEnded;
+    onStarted?: IOnAnyAction;
+    onStopped?: IOnAnyAction;
+    onPaused?: IOnAnyAction;
+    onResumed?: IOnAnyAction;
 }
 export interface ISound extends ISoundAttributes, IRequested {
     sourceNode: AudioBufferSourceNode | null;
@@ -40,6 +43,7 @@ export interface ISound extends ISoundAttributes, IRequested {
     sources: (ISoundSource | string)[];
     codec: string | null;
     duration: number | null;
+    firstTimePlayed: boolean;
 }
 export interface IOptions {
 }
@@ -63,9 +67,13 @@ export declare class PlayerSound implements ISound {
     loadingProgress: number;
     codec: string;
     duration: number | null;
+    firstTimePlayed: boolean;
     onLoading: IOnProgress;
     onPlaying: IOnProgress;
-    onStarted: IOnStarted;
     onEnded: IOnEnded;
+    onStarted: IOnAnyAction;
+    onStopped: IOnAnyAction;
+    onPaused: IOnAnyAction;
+    onResumed: IOnAnyAction;
     constructor(soundAttributes: ISoundAttributes);
 }
diff --git a/build/library/core.js b/build/library/core.js
diff --git a/build/library/sound.js b/build/library/sound.js
diff --git a/examples/simple-player/client/bootstrap.ts b/examples/simple-player/client/bootstrap.ts
@@ -32,11 +32,20 @@ $(function () {
             console.log('playing: ', playingProgress, maximumValue, currentValue);
             playerUI.setPlayingProgress(playingProgress);
         },
-        onStarted: () => {
-            console.log('started');
+        onStarted: (playTimeOffset) => {
+            console.log('started', playTimeOffset);
+        },
+        onPaused: (playTimeOffset) => {
+            console.log('paused', playTimeOffset);
+        },
+        onStopped: (playTimeOffset) => {
+            console.log('stopped', playTimeOffset);
+        },
+        onResumed: (playTimeOffset) => {
+            console.log('resumed', playTimeOffset);
         },
         onEnded: (willPlayNext) => {
-            console.log('ended');
+            console.log('ended', willPlayNext);
             if (!willPlayNext) {
                 playerUI.switchPlayerContext('on');
             }
@@ -58,11 +67,20 @@ $(function () {
             console.log('playing: ', playingProgress, maximumValue, currentValue);
             playerUI.setPlayingProgress(playingProgress);
         },
-        onStarted: () => {
-            console.log('started');
+        onStarted: (playTimeOffset) => {
+            console.log('started', playTimeOffset);
+        },
+        onPaused: (playTimeOffset) => {
+            console.log('paused', playTimeOffset);
+        },
+        onStopped: (playTimeOffset) => {
+            console.log('stopped', playTimeOffset);
+        },
+        onResumed: (playTimeOffset) => {
+            console.log('resumed', playTimeOffset);
         },
         onEnded: (willPlayNext) => {
-            console.log('ended');
+            console.log('ended', willPlayNext);
             if (!willPlayNext) {
                 playerUI.switchPlayerContext('on');
             }
diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "0.6.0",
+  "version": "0.6.1",
   "devDependencies": {
     "@types/webaudioapi": "0.0.27",
     "gulp": "^3.9.1",
diff --git a/source/library/core.ts b/source/library/core.ts
@@ -407,8 +407,7 @@ export class PlayerCore {
             loop: sound.loop,
             onEnded: () => {
                 this._onEnded();
-            },
-            onPlay: () => { }
+            }
         };
 
         // create a new source node
@@ -430,10 +429,17 @@ export class PlayerCore {
             // start(when, offset, duration)
             sourceNode.start(0, sound.playTimeOffset);
 
+            // trigger resumed event
+            if (sound.onResumed !== null && !sound.firstTimePlayed) {
+                sound.onResumed(sound.playTimeOffset);
+            }
+
             // trigger started event
-            if (sound.onStarted !== null && sound.playTimeOffset === 0) {
+            if (sound.onStarted !== null && sound.firstTimePlayed) {
 
-                sound.onStarted();
+                sound.onStarted(sound.playTimeOffset);
+
+                sound.firstTimePlayed = false;
 
             }
 
@@ -487,7 +493,13 @@ export class PlayerCore {
 
             }
 
-            this.stop();
+            // reset the is first time sound is being played to true
+            currentSound.firstTimePlayed = true;
+
+            // reset the playTimeOffset
+            currentSound.playTimeOffset = 0;
+
+            this._stop(currentSound);
 
             if (nextSound !== null) {
 
@@ -669,6 +681,11 @@ export class PlayerCore {
 
         sound.playTimeOffset += timeAtPause - sound.startTime;
 
+        // trigger paused event
+        if (sound.onPaused !== null) {
+            sound.onPaused(sound.playTimeOffset);
+        }
+
         this._stop(sound);
 
     }
@@ -682,6 +699,15 @@ export class PlayerCore {
             return;
         }
 
+        // reset the is first time sound is being played to true
+        sound.firstTimePlayed = true;
+
+        // trigger stopped event
+        if (sound.onStopped !== null) {
+            sound.onStopped(sound.playTimeOffset);
+        }
+
+        // reset the playTimeOffset
         sound.playTimeOffset = 0;
 
         this._stop(sound);
diff --git a/source/library/sound.ts b/source/library/sound.ts
@@ -18,8 +18,8 @@ export interface IOnEnded {
     (willPlayNext: boolean): void;
 }
 
-export interface IOnStarted {
-    (): void;
+export interface IOnAnyAction {
+    (playTimeOffset: number): void;
 }
 
 export interface ISoundAttributes {
@@ -29,13 +29,18 @@ export interface ISoundAttributes {
     id: number;
     playlistId?: number | null;
     loop?: boolean;
-    onLoading?: IOnProgress;
-    onPlaying?: IOnProgress;
-    onEnded?: IOnEnded;
-    onStarted?: IOnStarted;
     audioBuffer?: AudioBuffer | null;
     arrayBuffer?: ArrayBuffer | null;
     duration?: number | null;
+
+    // events
+    onLoading?: IOnProgress;
+    onPlaying?: IOnProgress;
+    onEnded?: IOnEnded;
+    onStarted?: IOnAnyAction;
+    onStopped?: IOnAnyAction;
+    onPaused?: IOnAnyAction;
+    onResumed?: IOnAnyAction;
 }
 
 export interface ISound extends ISoundAttributes, IRequested {
@@ -53,6 +58,7 @@ export interface ISound extends ISoundAttributes, IRequested {
     sources: (ISoundSource | string)[];
     codec: string | null;
     duration: number | null;
+    firstTimePlayed: boolean;
 }
 
 export interface IOptions {
@@ -81,11 +87,16 @@ export class PlayerSound implements ISound {
     public loadingProgress: number;
     public codec: string;
     public duration: number | null;
+    public firstTimePlayed: boolean;
 
+    // events
     public onLoading: IOnProgress;
     public onPlaying: IOnProgress;
-    public onStarted: IOnStarted;
     public onEnded: IOnEnded;
+    public onStarted: IOnAnyAction;
+    public onStopped: IOnAnyAction;
+    public onPaused: IOnAnyAction;
+    public onResumed: IOnAnyAction;
 
     constructor(soundAttributes: ISoundAttributes) {
 
@@ -99,11 +110,14 @@ export class PlayerSound implements ISound {
         this.id = soundAttributes.id;
         this.playlistId = soundAttributes.playlistId || null;
         this.loop = soundAttributes.loop || false;
+
         // the user can set the duration manually
         // this is usefull if we need to convert the position percentage into seconds but don't want to preload the song
         // to get the duration the song has to get preloaded as the duration is a property of the audioBuffer
         this.duration = soundAttributes.duration || null;
 
+        this.firstTimePlayed = true;
+
         if (typeof soundAttributes.onLoading === 'function') {
             this.onLoading = soundAttributes.onLoading;
         } else {
@@ -128,6 +142,24 @@ export class PlayerSound implements ISound {
             this.onEnded = null;
         }
 
+        if (typeof soundAttributes.onStopped === 'function') {
+            this.onStopped = soundAttributes.onStopped;
+        } else {
+            this.onStopped = null;
+        }
+
+        if (typeof soundAttributes.onPaused === 'function') {
+            this.onPaused = soundAttributes.onPaused;
+        } else {
+            this.onPaused = null;
+        }
+
+        if (typeof soundAttributes.onResumed === 'function') {
+            this.onResumed = soundAttributes.onResumed;
+        } else {
+            this.onResumed = null;
+        }
+
         let arrayBufferType: string = typeof soundAttributes.arrayBuffer;
 
         if (arrayBufferType === 'ArrayBuffer') {
