@hopecloud/jetstream-player 0.3.3 → 0.3.4

package/dist/index.d.ts

@@ -9,7 +9,7 @@ export declare class JetstreamPlayer {
     pause(): void;
     mute(): void;
     unmute(): void;
-    isMuted(): Promise<unknown>;
+    isMuted(): Promise<boolean>;
     playNext(): void;
     playPrevious(): void;
     seekTo(seconds: number): void;

package/docs/usage/player-events.md

@@ -5,8 +5,9 @@
 ### Next events are available in this version of the library:
 
 - `onEnded()`
-- `playVideo()`
-- `pauseVideo()`
+- `onPlayVideo()`
+- `onPauseVideo()`
+- `onVolumeChange()`
 
 This list is not exhaustive. New events can be added as needed.
 
@@ -17,17 +18,17 @@ import { JetstreamPlayer } from '@hopecloud/jetstream-player';
 
 setup() {
   let player: JetstreamPlayer | null;
-  
+
   onMounted(() => {
     player = new JetstreamPlayer('#iframe1');
-    
+
     player.onEnded(() => {
       console.log('Video is ENDED');
-    })
-    
+    });
+
     ...
-  })
-}
+  });
+},
 ```
 
 ### Pay attention ☝️⬇️
@@ -46,9 +47,9 @@ This event is called when a video or a video in a playlist ends. For example, if
 ```js
 import { JetstreamPlayer } from '@hopecloud/jetstream-player';
 
-setup() { 
+setup() {
   const players = [];
- 
+
   onMounted(() => {
     players.push(new JetstreamPlayer('#iframe1'));
     players.push(new JetstreamPlayer('#iframe2'));
@@ -57,10 +58,10 @@ setup() {
       console.log('Video 2 is ENDED');
     });
   });
-}
+},
 ```
 
-## `playVideo()` event 
+## `onPlayVideo()` event
 
 This event is a listener that fires when any video or playlist on your page starts playing. If your page has one or more embedded iframes and a video starts playing in the first window, event will be triggered for first player.
 
@@ -69,21 +70,21 @@ This event is a listener that fires when any video or playlist on your page star
 ```js
 import { JetstreamPlayer } from '@hopecloud/jetstream-player';
 
-setup() { 
+setup() {
   const players = [];
- 
+
   onMounted(() => {
     players.push(new JetstreamPlayer('#iframe1'));
     players.push(new JetstreamPlayer('#iframe2'));
 
-    players[0]?.playVideo(() => {
+    players[0]?.onPlayVideo(() => {
       console.log('Video 1 is PLAYING');
     });
   });
-}
+},
 ```
 
-## `pauseVideo()` event
+## `onPauseVideo()` event
 
 This event is a listener that fires when any video or playlist on your page paused. If your page has one or more embedded iframes and a video paused in the second window, event will be triggered for second player.
 
@@ -92,16 +93,39 @@ This event is a listener that fires when any video or playlist on your page paus
 ```js
 import { JetstreamPlayer } from '@hopecloud/jetstream-player';
 
-setup() { 
+setup() {
   const players = [];
- 
+
   onMounted(() => {
     players.push(new JetstreamPlayer('#iframe1'));
     players.push(new JetstreamPlayer('#iframe2'));
 
-    players[1]?.pauseVideo(() => {
+    players[1]?.onPauseVideo(() => {
       console.log('Video 2 is PAUSED');
     });
   });
-}
+},
+```
+
+## `onVolumeChange()` event
+
+This event is a listener that fires when any video or playlist on your page change volume. If your page has one or more embedded iframes and a video paused in the second window, event will be triggered for second player.
+
+### Example of use:
+
+```js
+import { JetstreamPlayer } from '@hopecloud/jetstream-player';
+
+setup() {
+  const players = [];
+
+  onMounted(() => {
+    players.push(new JetstreamPlayer('#iframe1'));
+    players.push(new JetstreamPlayer('#iframe2'));
+
+    players[1]?.onVolumeChange(() => {
+      console.log('Video 2 was changed volume');
+    });
+  });
+},
 ```

package/docs/usage/player-methods.md

@@ -7,7 +7,9 @@
 - `play()`
 - `pause()`
 - `seekTo()`
-- `playNext()`
+- `mute()`
+- `unmute()`
+- `isMuted()`
 - `playPrevious()`
 
 This list is not exhaustive. New methods can be added to the library as needed.
@@ -19,24 +21,24 @@ import { JetstreamPlayer } from '@hopecloud/jetstream-player';
 
 setup() {
   let player: JetstreamPlayer | null;
-  
+
   onMounted(() => {
     player = new JetstreamPlayer('#iframe1');
-  })
+  });
 
   const playVideo = () => {
     player.play();
-  }
-  
+  };
+
   const pauseVideo = () => {
     player.pause();
-  }
+  };
 
   return {
-   playVideo,
-   pauseVideo,
-  }
-}
+    playVideo,
+    pauseVideo,
+  };
+},
 ```
 
 ## `play()` `pause()` methods
@@ -53,6 +55,75 @@ Modern browsers don't provide an opportunity to avoid this setting. Therefore, f
 
 If the video or playlist has **sound settings off** `(muted)`, then all methods work in normal mode.
 
+## `mute()` method
+Mute function set media volume to silent.
+
+```js
+import { JetstreamPlayer } from '@hopecloud/jetstream-player';
+
+setup() {
+  let player: JetstreamPlayer | null;
+
+  onMounted(() => {
+    player = new JetstreamPlayer('#iframe1');
+  });
+
+  const muteVideo = () => {
+    player.mute();
+  };
+
+  return {
+    muteVideo,
+  };
+},
+```
+
+## `unmute()` method
+Cancel volume mute.
+
+```js
+import { JetstreamPlayer } from '@hopecloud/jetstream-player';
+
+setup() {
+  let player: JetstreamPlayer | null;
+
+  onMounted(() => {
+    player = new JetstreamPlayer('#iframe1');
+  });
+
+  const unmuteVideo = () => {
+    player.unmute();
+  };
+
+  return {
+    unmuteVideo,
+  };
+},
+```
+
+## `isMuted()` method
+Returns `true` if the player volume is muted, `false` if not.
+
+```js
+import { JetstreamPlayer } from '@hopecloud/jetstream-player';
+
+setup() {
+  let player: JetstreamPlayer | null;
+
+  onMounted(() => {
+    player = new JetstreamPlayer('#iframe1');
+  });
+
+  const isMutedVideo = () => {
+    player.isMuted();
+  };
+
+  return {
+    isMutedVideo,
+  };
+},
+```
+
 ## `seekTo(seconds: Number)` method
 
 Seeks to a specified time in the video. If the player is paused when the function is called, it will remain paused. If the function is called from another state (playing), the player will play the video.
@@ -69,19 +140,19 @@ import { JetstreamPlayer } from '@hopecloud/jetstream-player';
 
 setup() {
   let player: JetstreamPlayer | null;
-  
+
   onMounted(() => {
     player = new JetstreamPlayer('#iframe1');
-  })
+  });
 
   const seekTo = () => {
     player.seekTo(45); // Set time on 45 second
-  }
+  };
 
   return {
-   seekTo
-  }
-}
+    seekTo
+  };
+},
 ```
 
 ## `playNext()` `playPrevious()` methods
@@ -94,10 +165,10 @@ import { JetstreamPlayer } from '@hopecloud/jetstream-player';
 
 setup() {
   let playlistPlayer: JetstreamPlayer | null;
-  
+
   onMounted(() => {
     playlistPlayer = new JetstreamPlayer('#iframe1');
-  })
+  });
 
   const playNextVideo = () => {
     playlistPlayer.playNext();
@@ -108,8 +179,8 @@ setup() {
   };
 
   return {
-   playNextVideo,
-   playPreviousVideo,
-  }
-}
+    playNextVideo,
+    playPreviousVideo,
+  };
+}.
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hopecloud/jetstream-player",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "Embeddable player for Jetstream videos",
   "scripts": {
     "build": "tsc",