@signageos/front-applet 6.0.0 → 6.1.1

package/docs/js-api/js-video-stream.md

@@ -21,18 +21,27 @@ Methods to play or stop video streams.
 | `prepare()`        | Prepare video stream in the background                           | 4.7.0           |
 | `play()`           | Start playing video stream                                       | 1.0.18          |
 | `stop()`           | Stop video stream                                                | 1.0.18          |
+| `getTracks()`      | Get all tracks of the stream                                     | 6.1.0           |
+| `selectTrack()`    | Select track of the stream                                       | 6.1.0           |
+| `resetTrack()`     | Reset track of the stream                                        | 6.1.0           |
 | `onConnected()`    | Calls a listener callback when stream connects                   | 1.0.20          |
 | `onDisconnected()` | Calls a listener callback when stream disconnects                | 1.0.20          |
 | `onError()`        | Calls a listener callback when an unexpected stream error occurs | 1.0.20          |
 | `onPlay()`         | Calls a listener callback when stream starts playing             | 5.12.0          |
 | `onStop()`         | Calls a listener callback when stream stops                      | 5.12.0          |
 | `onPrepare()`      | Calls a listener callback when stream prepares                   | 5.12.0          |
+| `onTracksChanged()`| Calls a listener callback when stream tracks change              | 6.1.0           |
 :::
 
 ::: alert alert--warning
 Are you using **Samsung Tizen** to play streams? [Read more about limitation and Tizen-specific details](https://docs.signageos.io/hc/en-us/articles/4405387373458).
 :::
 
+::: alert alert--danger
+Be aware version of JS API (v6.0.0+) changed how stream functions `play()` and `prepare()` work. For using an options object
+you need to our latest core app versions. If you are using older core app versions, you need to use deprecated format.
+:::
+
 ## prepare()
 Calls the internal player and prepares a video stream in memory, so it can later start playing instantaneously.
 
@@ -49,18 +58,44 @@ If you want to play a video stream in full screen mode, use x = y = 0 and width
 | `y`            | Number                      | <div class="red">Yes</div>   | Stream y-position on the screen               |
 | `width`        | Number                      | <div class="red">Yes</div>   | Stream width on the screen 	                  |
 | `height`		 | Number                      | <div class="red">Yes</div>   | Stream height on the screen 	              |
-| `options`      | Object                      | <div class="red">Yes</div>    | Additional options for the stream             |
+| `options`      | Object                      | <div class="red">Yes</div>    | Additional options for the stream            |
 :::
 
 ### Options object
 ::: table-responsive
 |      Key        | Type                        | Required                     | Description                                   |
 | ------------    | --------------------------- | :--------------------------: | --------------------------------------------- |
-| `protocol`     | String                      | <div class="red">Yes</div> | Protocol that the stream is using             |
+| `protocol`     | String                      | <div class="red">Yes</div>    | Protocol that the stream is using             |
 |^^|^^|^^| Types: `HLS`, `RTP`, `HTTP`, `UDP`, `RTMP`, `RTSP`. |
-| `background`    | Boolean                     | <div class="yellow">No</div>    | Prepare stream in the background              |
+| `background`    | Boolean                     | <div class="yellow">No</div>    | Prepare stream in the background           |
+| `trackSelection`| Object                      | <div class="yellow">No</div>    | Track selection options                    |
+| `drm`           | Object                      | <div class="yellow">No</div>    | DRM options                                |
+:::
+
+### Track selection object
+::: table-responsive
+|      Key        | Type                        | Required                     | Description                                   |
+| ------------    | --------------------------- | :--------------------------: | --------------------------------------------- |
+| `maxAudioChannelCount` | Number               | <div class="yellow">No</div>    | Maximum number of audio channels to play    |
+| `minVideoSize`  | Object                      | <div class="yellow">No</div>    | Minimum video size to play                  |
+|^^|^^|^^| Object with `width` and `height` properties |
+| `maxVideoSize`  | Object                      | <div class="yellow">No</div>    | Maximum video size to play                  |
+|^^|^^|^^| Object with `width` and `height` properties |
+| `preferredAudioLanguages` | Array of strings | <div class="yellow">No</div>    | Preferred audio languages to play           |
+| `preferredTextLanguages` | Array of strings  | <div class="yellow">No</div>    | Preferred text languages to play            |
+:::
+
+### DRM object
+::: table-responsive
+|      Key        | Type                        | Required                     | Description                                   |
+| ------------    | --------------------------- | :--------------------------: | --------------------------------------------- |
+| `scheme`        | String                      | <div class="red">Yes</div>    | DRM scheme                                   |
+|^^|^^|^^| Types: `CommonPSSH`, `ClearKey`, `Widevine`, `PlayReady` or own value |
+| `licenseUri`    | String                      | <div class="red">Yes</div>    | DRM license URI                              |
+| `licenseRequestHeaders` | Object             | <div class="yellow">No</div>    | DRM license request headers                 |
 :::
 
+
 ### Javascript syntax
 ```javascript
 // Example with specific protocol type
@@ -118,6 +153,9 @@ If you want to play a video stream in full screen mode, use x = y = 0 and width
 |^^|^^|^^| Default value: false |
 | `autoReconnectInterval` | Number              | <div class="yellow">No</div>    | Interval in miliseconds between reconnect attempts |
 |^^|^^|^^| Default value: 30000 ms |
+| `volume`        | Number                      | <div class="yellow">No</div>    | Volume of the stream                          |
+| `trackSelection`| Object                      | <div class="yellow">No</div>    | Track selection options                       |
+| `drm`           | Object                      | <div class="yellow">No</div>    | DRM options                                   |
 :::
 
 ### Javascript syntax
@@ -170,6 +208,84 @@ await sos.stream.stop(uri,  x,  y,  width,  height);
 | `height`		 | Number                      | <div class="red">Yes</div> | Stream height on the screen 	                |
 :::
 
+## getTracks()
+Get all tracks of the selected stream.
+
+### Javascript syntax
+```javascript
+const videoId = {
+    uri: 'http://example.com/stream.m3u8',
+    x: 0,
+    y: 0,
+    width: 1920,
+    height: 1080,
+};
+
+const tracks = await sos.stream.getTracks(videoId); // Promise<ITrackInfo[]>
+```
+
+### Parameters:
+::: table-responsive
+|      Param     | Type                        | Required                   | Description                                   |
+| -------------- | --------------------------- | :------------------------: | --------------------------------------------- |
+| `videoId`      | Object                      | <div class="red">Yes</div> | Video ID object of selected stream            |
+:::
+
+### Example of returned value
+```javascript
+[
+    {
+        trackType: 'VIDEO', // string - AUDIO, VIDEO, TEXT
+        mimeType: 'video/mp4', // string
+        videoSize: { // object
+            width: 1920, // number
+            height: 1080, // number
+        },
+        groupId: '1', // string
+        trackIndex: 1, // number
+        selected: true, // boolean
+        language: 'en', // string
+        supported: true, // boolean
+    }
+]
+```
+
+## selectTrack()
+Select track of the selected stream.
+
+### Javascript syntax
+```javascript
+await sos.stream.selectTrack(videoId, trackType, groupId, trackIndex); // Promise<void>
+```
+
+### Parameters:
+::: table-responsive
+|      Param     | Type                        | Required                   | Description                                   |
+| -------------- | --------------------------- | :------------------------: | --------------------------------------------- |
+| `videoId`      | Object                      | <div class="red">Yes</div> | Video ID object of selected stream            |
+| `trackType`    | String                      | <div class="red">Yes</div> | Track type - `AUDIO`, `VIDEO`, `TEXT`         |
+| `groupId`      | String                      | <div class="red">Yes</div> | Group ID of selected track                    |
+| `trackIndex`   | Number                      | <div class="red">Yes</div> | Index of selected track                       |
+:::
+
+## resetTrack()
+Reset track of the selected stream.
+
+### Javascript syntax
+```javascript
+await sos.stream.resetTrack(videoId, trackType); // Promise<void>
+await sos.stream.resetTrack(videoId, trackType, groupId); // Promise<void>
+```
+
+### Parameters:
+::: table-responsive
+|      Param     | Type                        | Required                   | Description                                   |
+| -------------- | --------------------------- | :------------------------: | --------------------------------------------- |
+| `videoId`      | Object                      | <div class="red">Yes</div> | Video ID object of selected stream            |
+| `trackType`    | String                      | <div class="red">Yes</div> | Track type - `AUDIO`, `VIDEO`, `TEXT`         |
+| `groupId`      | String                      | <div class="yellow">No</div> | Group ID of selected track                  |
+:::
+
 ## Event onConnected()
 Calls a listener callback everytime `connected` event is emitted.
 
@@ -230,38 +346,76 @@ sos.stream.onPrepare((event) => {
 });
 ```
 
+## Event onTracksChanged()
+Calls a listener callback everytime `tracks_changed` event is emitted.
+
+### Javascript syntax
+```javascript
+sos.stream.onTracksChanged((event) => {
+    // do something
+});
+```
+
 ## Stream events
 All stream events have the same format.
 
-`type` property contains string with the event type. Type can be `connected`, `disconnected` or `error`.
+`type` property contains string with the event type. Type can be `connected`, `disconnected`, `error` or `tracks_changed`.
 
 `srcArguments` property contains parameters of the source stream, that emitted the event.
 That way, if multiple streams are playing at once, you can associate the events with each stream instance.
 
-Example event:
+Example of **connected**, **disconnected** event:
 ```json
 {
-  "type": "connected",
+  "type": "<type>",
   "srcArguments": {
     "uri": "<uri>",
     "x": 0,
     "y": 0,
     "width": 1920,
     "height": 1080,
-    "options": {
-        "protocol": "RTP",
-        "background": false,
-        "autoReconnect": true,
-        "autoReconnectInterval": 30000,
-    },
+    "protocol": "HTTP"
   }
 }
 ```
 
+Example of **tracks_changed** event:
+```json
+{
+  "type": "tracks_changed",
+  "srcArguments": {
+    "uri": "<uri>",
+    "x": 0,
+    "y": 0,
+    "width": 1920,
+    "height": 1080,
+    "tracks": [] // Array of ITrackInfo
+  }
+}
+```
+
+Example of **error** event:
+```json
+{
+  "type": "error",
+  "srcArguments": {
+    "uri": "<uri>",
+    "x": 0,
+    "y": 0,
+    "width": 1920,
+    "height": 1080,
+    "protocol": "HTTP"
+  },
+  "errorMessage": "Some error message"
+}
+```
+
 ## Usage with Typescript
 You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
 
 ```typescript
+type StreamProtocol = 'HLS' | 'RTP' | 'HTTP' | 'UDP' | 'RTMP' | 'RTSP';
+type DrmScheme = "CommonPSSH" | "ClearKey" | "Widevine" | "PlayReady" | string;
 interface StreamEvent {
     type: 'connected' | 'disconnected' | 'error' | 'stop' | 'prepare' | 'play',
     srcArguments: {
@@ -270,40 +424,91 @@ interface StreamEvent {
         y: number;
         width: number;
         height: number;
+        protocol?: StreamProtocol;
     },
+}
+interface IVideoProperties {
+    uri: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+type TrackType = 'AUDIO' | 'VIDEO' | 'TEXT';
+type ITrackInfo = IVideoTrack | IAudioTrack | ITextTrack;
+interface ITrack<T extends TrackType> {
+    trackType: T;
+	mimeType: string;
+	groupId: string;
+	trackIndex: number;
+	selected: boolean;
+	language: string | null;
+	supported: boolean;
+}
+interface IVideoTrack extends ITrack<'VIDEO'> {
+    videoSize: { width: number; height: number };
+}
+interface IAudioTrack extends ITrack<'AUDIO'> {
+    channelCount: number;
+}
+interface ITextTrack extends ITrack<'TEXT'> {
+    selection: 'default' | 'forced' | 'autoselect';
+}
+prepare(
+    uri: string;
+	x: number;
+	y: number;
+	width: number;
+	height: number;
     options: {
-        protocol: string;
+        protocol: StreamProtocol;
         background?: boolean;
         autoReconnect?: boolean;
         autoReconnectInterval?: number;
+        trackSelection?: {
+		    maxAudioChannelCount?: number;
+		    minVideoSize?: { width: number; height: number };
+		    maxVideoSize?: { width: number; height: number };
+		    preferredAudioLanguages?: string[];
+		    preferredTextLanguages?: string[];
+	    };
+	    drm?: {
+		    scheme: DrmScheme;
+		    licenseUri: string;
+		    licenseRequestHeaders: { [key: string]: string };
+	    };
     }
-}
+): Promise<void>;
 play(
-	uri:  string;
-	x:  number;
-	y:  number;
-	width:  number;
-	height:  number;
+	uri: string;
+	x: number;
+	y: number;
+	width: number;
+	height: number;
     options: {
-        protocol:  'HLS'  |  'RTP'  |  'HTTP'  |  'UDP'  |  'RTMP'  |  'RTSP';
+        protocol: StreamProtocol;
         background?: boolean;
         autoReconnect?: boolean;
         autoReconnectInterval?: number;
     }
 ): Promise<void>;
 stop(
-	uri:  string,
-	x:  number,
-	y:  number,
-	width:  number,
-	height:  number
+	uri: string,
+	x: number,
+	y: number,
+	width: number,
+	height: number
 ): Promise<void>;
+getTracks(videoId: IVideoProperties): Promise<ITrackInfo[]>;
+selectTrack(videoId: IVideoProperties, trackType: TrackType, groupId: string, trackIndex: number): Promise<void>;
+resetTrack(videoId: IVideoProperties, trackType: TrackType, groupId?: string): Promise<void>;
 onConnected(listener: (event: StreamEvent) => void): void;
 onDisconnected(listener: (event: StreamEvent) => void): void;
-onError(listener: (event: StreamEvent) => void): void;
+onError(listener: (event: StreamErrorEvent) => void): void;
 onPlay(listener: (event: StreamEvent) => void): void;
 onStop(listener: (event: StreamEvent) => void): void;
 onPrepare(listener: (event: StreamEvent) => void): void;
+onTracksChanged(listener: (event: StreamTracksChangedEvent) => void): void;
 ```
 
 ## Errors
@@ -315,4 +520,8 @@ Although we are doing our best, following errors may occur when working with the
 | 41401 | AppletStreamError | Invalid stream protocol type: `protocol` |
 | 51301 | InternalStreamError | Couldn't stop the stream before playing the new one. |
 | 51301 | InternalStreamError | Couldn't stop the stream. |
+| 51302 | InternalStreamError | Couldn't prepare the stream. |
+| 51303 | InternalStreamError | Couldn't get stream tracks. |
+| 51304 | InternalStreamError | Couldn't select stream track. |
+| 51305 | InternalStreamError | Couldn't reset stream track. |
 :::

package/es6/FrontApplet/Input/Input.js

@@ -39,8 +39,14 @@ class Input {
         this.eventEmitter.removeAllListeners();
     }
     dispatchEventToParent(event) {
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
-            this.window.parent.document.dispatchEvent(new KeyboardEvent('keyup', event));
+            if ((_c = (_b = (_a = this.window) === null || _a === void 0 ? void 0 : _a.parent) === null || _b === void 0 ? void 0 : _b.document) === null || _c === void 0 ? void 0 : _c.dispatchEvent) {
+                this.window.parent.document.dispatchEvent(new KeyboardEvent('keyup', event));
+            }
+            else {
+                console.warn('Parent window or document is not defined');
+            }
         });
     }
     getMessage(name) {

package/es6/FrontApplet/Input/Input.js.map

@@ -1 +1 @@
-{"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/Input.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAAsC;AAItC,mDAA4C;AAE5C,MAAqB,KAAK;IAIzB,YAA4B,MAAc,EAAU,aAAqB;QAA7C,WAAM,GAAN,MAAM,CAAQ;QAAU,kBAAa,GAAb,aAAa,CAAQ;QACxE,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;IACpG,CAAC;IAEM,OAAO,CAAC,QAA6B;QAC3C,kBAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAEM,iBAAiB,CAAC,IAAsB;QAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,MAAM,UAAU,GAAgB;oBAC/B,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;gBAC5C,MAAM;YACP,QAAQ;SACR;IACF,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC;IACxC,CAAC;IAEa,qBAAqB,CAAC,KAAoB;;YACvD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9E,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;;AAtCF,wBAuCC;AAtCc,oBAAc,GAAW,OAAO,CAAC"}
+{"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/Input.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAAsC;AAItC,mDAA4C;AAE5C,MAAqB,KAAK;IAIzB,YAA4B,MAAc,EAAU,aAAqB;QAA7C,WAAM,GAAN,MAAM,CAAQ;QAAU,kBAAa,GAAb,aAAa,CAAQ;QACxE,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;IACpG,CAAC;IAEM,OAAO,CAAC,QAA6B;QAC3C,kBAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAEM,iBAAiB,CAAC,IAAsB;QAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,MAAM,UAAU,GAAgB;oBAC/B,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;gBAC5C,MAAM;YACP,QAAQ;SACR;IACF,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC;IACxC,CAAC;IAEa,qBAAqB,CAAC,KAAoB;;;YACvD,IAAI,MAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,MAAM,0CAAE,QAAQ,0CAAE,aAAa,EAAE;gBACjD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;aAC7E;iBAAM;gBACN,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;aACzD;;KACD;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;;AA1CF,wBA2CC;AA1Cc,oBAAc,GAAW,OAAO,CAAC"}

package/es6/FrontApplet/Stream/IStreamMessage.d.ts

@@ -1,6 +1,4 @@
 import IMessage from '../IMessage';
-import IStreamEventProperties from './IStreamEventProperties';
-declare type IStreamMessage = IMessage & IStreamEventProperties & {
-    errorMessage?: string;
-};
+import { IStreamErrorEventProperties, IStreamEventProperties, IStreamTracksChangedEventProperties } from './streamEventProperties';
+declare type IStreamMessage = IMessage & IStreamEventProperties & IStreamErrorEventProperties & IStreamTracksChangedEventProperties;
 export default IStreamMessage;

package/es6/FrontApplet/Stream/IStreamTrackInfo.d.ts

@@ -0,0 +1,23 @@
+export declare type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
+export declare type ITrackInfo = ITrackVideoInfo | ITrackAudioInfo | ITrackTextInfo;
+export interface ITrack<T extends TrackType> {
+    trackType: T;
+    mimeType: string;
+    groupId: string;
+    trackIndex: number;
+    selected: boolean;
+    language: string | null;
+    supported: boolean;
+}
+export interface ITrackVideoInfo extends ITrack<'VIDEO'> {
+    videoSize: {
+        width: number;
+        height: number;
+    };
+}
+export interface ITrackAudioInfo extends ITrack<'AUDIO'> {
+    channelCount: number;
+}
+export interface ITrackTextInfo extends ITrack<'TEXT'> {
+    selection: string[];
+}

package/es6/FrontApplet/Stream/{IStreamEventListener.js → IStreamTrackInfo.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=IStreamEventListener.js.map
+//# sourceMappingURL=IStreamTrackInfo.js.map

package/es6/FrontApplet/Stream/IStreamTrackInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStreamTrackInfo.js","sourceRoot":"","sources":["../../../src/FrontApplet/Stream/IStreamTrackInfo.ts"],"names":[],"mappings":""}

package/es6/FrontApplet/Stream/Stream.d.ts

@@ -1,18 +1,24 @@
 import IPostMessage from '../IPostMessage';
 import StreamProtocol from './StreamProtocol';
 import IStreamMessage from './IStreamMessage';
-import IStreamEventListener from './IStreamEventListener';
-import { IStreamOptions } from '../Video/IOptions';
+import { IStreamOptions, IStreamPrepareOptions } from '../Video/IOptions';
+import { ITrackInfo, TrackType } from './IStreamTrackInfo';
+import { IStreamErrorEventListener, IStreamEventListener, IStreamTracksChangedEventListener } from './streamListeners';
+import IVideoProperties from '../Video/IVideoProperties';
 export default class Stream {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
     private eventEmitter;
-    constructor(messagePrefix: string, postMessage: IPostMessage<void>);
-    prepare(uri: string, x: number, y: number, width: number, height: number, options?: IStreamOptions | keyof typeof StreamProtocol): Promise<void>;
-    play(uri: string, x: number, y: number, width: number, height: number, options?: IStreamOptions | keyof typeof StreamProtocol): Promise<void>;
-    stop(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
-    onError(listener: IStreamEventListener<'error'>): void;
+    constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    prepare(uri: string, x: number, y: number, width: number, height: number, options?: IStreamPrepareOptions | keyof typeof StreamProtocol): Promise<any>;
+    play(uri: string, x: number, y: number, width: number, height: number, options?: IStreamOptions | keyof typeof StreamProtocol): Promise<any>;
+    stop(uri: string, x: number, y: number, width: number, height: number): Promise<any>;
+    getTracks(videoId: IVideoProperties): Promise<ITrackInfo[]>;
+    selectTrack(videoId: IVideoProperties, trackType: TrackType, groupId: string, trackIndex: number): Promise<void>;
+    resetTrack(videoId: IVideoProperties, trackType: TrackType, groupId?: string): Promise<void>;
+    onTracksChanged(listener: IStreamTracksChangedEventListener): void;
+    onError(listener: IStreamErrorEventListener): void;
     onConnected(listener: IStreamEventListener<'connected'>): void;
     onDisconnected(listener: IStreamEventListener<'disconnected'>): void;
     onPrepare(listener: IStreamEventListener<'prepare'>): void;

package/es6/FrontApplet/Stream/Stream.js

@@ -1,7 +1,15 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = require("events");
-const StreamProtocol_1 = require("./StreamProtocol");
 const AppletStreamError_1 = require("../Error/AppletStreamError");
 const ErrorCodes_1 = require("../Error/ErrorCodes");
 const Validate_1 = require("../Validate/Validate");
@@ -13,13 +21,24 @@ class Stream {
         this.eventEmitter = new events_1.EventEmitter();
     }
     prepare(uri, x, y, width, height, options) {
-        let streamOptions = {};
+        let streamOptions;
         if (typeof options === 'string') {
             streamOptions = { protocol: options };
         }
-        else if (options === null || options === void 0 ? void 0 : options.protocol) {
+        else {
             streamOptions = options;
         }
+        let protocol = undefined;
+        if ((streamOptions === null || streamOptions === void 0 ? void 0 : streamOptions.protocol) && streamOptions.protocol !== undefined) {
+            protocol = streamOptions.protocol;
+        }
+        if (protocol && typeof protocol !== 'string') {
+            throw new AppletStreamError_1.default({
+                kind: 'appletStreamError',
+                message: 'Invalid format of protocol, must be string.',
+                code: ErrorCodes_1.default.STREAM_INVALID_PROTOCOL_TYPE,
+            });
+        }
         this.checkParamsValidity(uri, x, y, width, height);
         this.createAndEmitEvent('prepare', {
             type: 'prepare',
@@ -29,7 +48,7 @@ class Stream {
                 y,
                 width,
                 height,
-                options: streamOptions,
+                protocol,
             },
         });
         return this.postMessage({
@@ -39,31 +58,32 @@ class Stream {
             y,
             width,
             height,
+            protocol,
             options: streamOptions,
         });
     }
     play(uri, x, y, width, height, options) {
-        let streamOptions = {};
+        let streamOptions;
         if (typeof options === 'string') {
             // Legacy format
             streamOptions = { protocol: options };
         }
-        else if (options === null || options === void 0 ? void 0 : options.protocol) {
+        else {
             // New format
             streamOptions = options;
         }
+        let protocol = undefined;
+        if ((streamOptions === null || streamOptions === void 0 ? void 0 : streamOptions.protocol) && streamOptions.protocol !== undefined) {
+            protocol = streamOptions.protocol;
+        }
         this.checkParamsValidity(uri, x, y, width, height);
         ({ x, y, width, height } = coordinationsHelper_1.sanitizeCoordinations({ x, y, width, height }));
-        let uppercaseProtocol;
-        if (options && typeof streamOptions.protocol !== 'undefined') {
-            uppercaseProtocol = streamOptions.protocol.toUpperCase(); // backwards compatibility, old format was lowercase
-            if (Object.keys(StreamProtocol_1.default).indexOf(uppercaseProtocol) < 0) {
-                throw new AppletStreamError_1.default({
-                    kind: 'appletStreamError',
-                    message: 'Invalid stream protocol type: ' + streamOptions.protocol,
-                    code: ErrorCodes_1.default.STREAM_INVALID_PROTOCOL_TYPE,
-                });
-            }
+        if (protocol && typeof protocol !== 'string') {
+            throw new AppletStreamError_1.default({
+                kind: 'appletStreamError',
+                message: 'Invalid format of protocol, must be string.',
+                code: ErrorCodes_1.default.STREAM_INVALID_PROTOCOL_TYPE,
+            });
         }
         this.createAndEmitEvent('play', {
             type: 'play',
@@ -73,7 +93,7 @@ class Stream {
                 y,
                 width,
                 height,
-                options: streamOptions,
+                protocol,
             },
         });
         return this.postMessage({
@@ -83,6 +103,7 @@ class Stream {
             y,
             width,
             height,
+            protocol,
             options: streamOptions,
         });
     }
@@ -108,6 +129,36 @@ class Stream {
             height,
         });
     }
+    getTracks(videoId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Validate_1.default({ videoId }).required().object();
+            const { tracks } = yield this.postMessage({ type: this.getMessage('get_tracks'), videoId });
+            return tracks;
+        });
+    }
+    selectTrack(videoId, trackType, groupId, trackIndex) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Validate_1.default({ videoId }).required().object();
+            Validate_1.default({ trackType }).required().string();
+            Validate_1.default({ groupId }).required().string();
+            Validate_1.default({ trackIndex }).required().number();
+            return this.postMessage({ type: this.getMessage('select_track'), videoId, trackType, groupId, trackIndex });
+        });
+    }
+    resetTrack(videoId, trackType, groupId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Validate_1.default({ videoId }).required().object();
+            Validate_1.default({ trackType }).required().string();
+            if (groupId) {
+                Validate_1.default({ groupId }).string();
+            }
+            return this.postMessage({ type: this.getMessage('reset_track'), videoId, trackType, groupId });
+        });
+    }
+    onTracksChanged(listener) {
+        Validate_1.default({ listener }).required().function();
+        this.eventEmitter.on('tracks_changed', listener);
+    }
     onError(listener) {
         Validate_1.default({ listener }).required().function();
         this.eventEmitter.on('error', listener);
@@ -133,6 +184,7 @@ class Stream {
         this.eventEmitter.on('stop', listener);
     }
     handleMessageData(data) {
+        var _a, _b, _c, _d, _e, _f;
         switch (data.type) {
             case this.getMessage('error'):
                 this.createAndEmitEvent('error', {
@@ -143,7 +195,7 @@ class Stream {
                         y: data.y,
                         width: data.width,
                         height: data.height,
-                        options: data.options,
+                        protocol: (_b = (_a = data.options) === null || _a === void 0 ? void 0 : _a.protocol) !== null && _b !== void 0 ? _b : data.protocol,
                     },
                     errorMessage: data.errorMessage,
                 });
@@ -157,7 +209,7 @@ class Stream {
                         y: data.y,
                         width: data.width,
                         height: data.height,
-                        options: data.options,
+                        protocol: (_d = (_c = data.options) === null || _c === void 0 ? void 0 : _c.protocol) !== null && _d !== void 0 ? _d : data.protocol,
                     },
                 });
                 break;
@@ -170,8 +222,21 @@ class Stream {
                         y: data.y,
                         width: data.width,
                         height: data.height,
-                        options: data.options,
+                        protocol: (_f = (_e = data.options) === null || _e === void 0 ? void 0 : _e.protocol) !== null && _f !== void 0 ? _f : data.protocol,
+                    },
+                });
+                break;
+            case this.getMessage('tracks_changed'):
+                this.createAndEmitEvent('tracks_changed', {
+                    type: 'tracks_changed',
+                    srcArguments: {
+                        uri: data.uri,
+                        x: data.x,
+                        y: data.y,
+                        width: data.width,
+                        height: data.height,
                     },
+                    tracks: data.tracks,
                 });
                 break;
             default: