Merge pull request #27 from apivideo/subtitle-methods

Add showSubtitles() / hideSubtitles() methods
apivideo · Jul 7, 2021 · 3f7c39b · 3f7c39b
2 parents f61b40d + 10b3ff3
commit 3f7c39b
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.2.8] - 2021-05-28
+- Add showSubtitles() / hideSubtitles() methods
+
 ## [1.2.7] - 2021-05-28
 - Add "token" in SdkOptions type
 

diff --git a/README.md b/README.md
@@ -73,17 +73,18 @@ The PlayerSdk constructor takes 2 parameters:
 - `options: SdkOptions` an object containing the player options. The available options are the following:
 
 
-|  Option name | Mandatory             | Type    | Description                                                                                                  |
-| -----------: | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------ |
-|           id | **yes**               | string  | the id of the video                                                                                          |
-|        token | yes for private video | string  | the [private video](https://api.video/blog/tutorials/tutorial-private-videos) url token                      |
-|         live | no (default: false)   | boolean | indicate that the video is a live one                                                                        |
-|     autoplay | no (default: false)   | boolean | start playing the video as soon as it is loaded                                                              |
-|        muted | no (default: false)   | boolean | the video is muted                                                                                           |
-|     metadata | no (default: empty)   | object  | object containing [metadata](https://api.video/blog/tutorials/dynamic-metadata) (see **Full example** below) |
-| hideControls | no (default: false)   | boolean | the controls are hidden                                                                                      |
-|    hideTitle | no (default: false)   | boolean | the video title is hidden                                                                                    |
-|         loop | no (default: false)   | boolean | once the video is finished it automatically starts again                                                     |
+|   Option name | Mandatory             | Type    | Description                                                                                                  |
+| ------------: | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------ |
+|            id | **yes**               | string  | the id of the video                                                                                          |
+|         token | yes for private video | string  | the [private video](https://api.video/blog/tutorials/tutorial-private-videos) url token                      |
+|          live | no (default: false)   | boolean | indicate that the video is a live one                                                                        |
+|      autoplay | no (default: false)   | boolean | start playing the video as soon as it is loaded                                                              |
+|         muted | no (default: false)   | boolean | the video is muted                                                                                           |
+|      metadata | no (default: empty)   | object  | object containing [metadata](https://api.video/blog/tutorials/dynamic-metadata) (see **Full example** below) |
+|  hideControls | no (default: false)   | boolean | the controls are hidden                                                                                      |
+|     hideTitle | no (default: false)   | boolean | the video title is hidden                                                                                    |
+| showSubtitles | no (default: false)   | boolean | the video subtitles are shown by default                                                                     |
+|          loop | no (default: false)   | boolean | once the video is finished it automatically starts again                                                     |
 
 
 The sdk instance can be used to control the video playback, and to listen to player events.
@@ -115,6 +116,10 @@ The sdk instance has the following methods:
 > Hide the player controls.
 #### `showControls()` 
 > Show the player controls.
+#### `hideSubtitles()` 
+> Hide the player subtitles.
+#### `showSubtitles()` 
+> Show the player subtitles.
 #### `setLoop(loop: boolean)`
 > Define if the video should be played in loop.
 #### `seek(time: number)` 

diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -11,6 +11,7 @@ declare type SdkOptions = {
     hideTitle?: boolean;
     iframeUrl?: string;
     token?: string;
+    showSubtitles?: boolean;
 };
 export declare class PlayerSdk {
     private static DEFAULT_IFRAME_URL;
@@ -29,6 +30,8 @@ export declare class PlayerSdk {
     play(): void;
     hideControls(): void;
     showControls(): void;
+    hideSubtitles(): void;
+    showSubtitles(): void;
     pause(): void;
     mute(): void;
     unmute(): void;

diff --git a/dist/index.js b/dist/index.js
diff --git a/index.ts b/index.ts
@@ -21,6 +21,7 @@ type SdkOptions = {
     hideTitle?: boolean;
     iframeUrl?: string;
     token?: string;
+    showSubtitles?: boolean;
 }
 
 export class PlayerSdk {
@@ -93,6 +94,12 @@ export class PlayerSdk {
     showControls() {
         this.postMessage({ message: 'showControls' });
     }
+    hideSubtitles() {
+        this.postMessage({ message: 'hideSubtitles' });
+    }
+    showSubtitles() {
+        this.postMessage({ message: 'showSubtitles' });
+    }
     pause() {
         this.postMessage({ message: 'pause' });
     }
@@ -200,6 +207,10 @@ export class PlayerSdk {
             url = addParameterInIframeHash("hide-title");
         }
 
+        if (options.showSubtitles === true) {
+            url = addParameterInIframeHash("show-subtitles");
+        }
+
         return url;
     }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@api.video/player-sdk",
-  "version": "1.2.7",
+  "version": "1.2.8",
   "description": "api.video player SDK",
   "repository": {
     "type": "git",