@signageos/front-applet 8.1.0 → 8.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundle.js +2 -2
- package/dist/bundle.js.map +1 -1
- package/docs/fpath/index.md +12 -250
- package/docs/sos/fileSystem.md +12 -12
- package/docs/sos/index.md +36 -12
- package/docs/sos/offline/cache.md +6 -6
- package/docs/sos/stream.md +1172 -37
- package/docs/sos/sync.md +2 -2
- package/docs/sos/video.md +515 -22
- package/docs/sos_management/security.md +4 -2
- package/docs/sos_management/wifi.md +9 -9
- package/es6/FrontApplet/FrontApplet.d.ts +31 -7
- package/es6/FrontApplet/FrontApplet.js +32 -8
- package/es6/FrontApplet/FrontApplet.js.map +1 -1
- package/es6/FrontApplet/Stream/IStreamTrackInfo.d.ts +34 -0
- package/es6/FrontApplet/Stream/Stream.d.ts +245 -20
- package/es6/FrontApplet/Stream/Stream.js +245 -20
- package/es6/FrontApplet/Stream/Stream.js.map +1 -1
- package/es6/FrontApplet/Stream/StreamProtocol.d.ts +4 -0
- package/es6/FrontApplet/Stream/StreamProtocol.js +4 -0
- package/es6/FrontApplet/Stream/StreamProtocol.js.map +1 -1
- package/es6/FrontApplet/Stream/streamEventProperties.d.ts +11 -1
- package/es6/FrontApplet/Stream/streamEvents.d.ts +26 -0
- package/es6/FrontApplet/Video/IOptions.d.ts +41 -0
- package/es6/FrontApplet/Video/IVideoEvent.d.ts +8 -0
- package/es6/FrontApplet/Video/IVideoEvent.js.map +1 -1
- package/es6/FrontApplet/Video/IVideoProperties.d.ts +3 -0
- package/es6/FrontApplet/Video/Video.d.ts +256 -19
- package/es6/FrontApplet/Video/Video.js +258 -22
- package/es6/FrontApplet/Video/Video.js.map +1 -1
- package/es6/bundle.d.ts +14 -1
- package/es6/bundle.js +5 -16
- package/es6/bundle.js.map +1 -1
- package/package.json +1 -1
|
@@ -28,7 +28,7 @@ getPinCode(): Promise<string>;
|
|
|
28
28
|
|
|
29
29
|
#### Possible errors
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
**41703**: Get PIN code failed because the PIN code has not been set yet.
|
|
32
32
|
|
|
33
33
|
<Separator />
|
|
34
34
|
|
|
@@ -48,4 +48,6 @@ setPinCode(pinCode: string): Promise<void>;
|
|
|
48
48
|
|
|
49
49
|
#### Possible errors
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
|
|
52
|
+
- **41701**: Invalid PIN code format (has to be 4-digits string).
|
|
53
|
+
- **41702**: PIN code 0000 is not allowed, use another PIN code.
|
|
@@ -66,7 +66,7 @@ A promise that resolves when the connection is established or if connection fail
|
|
|
66
66
|
|
|
67
67
|
#### Possible errors
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Error If the Wi-Fi state is not in the `client` state.
|
|
70
70
|
|
|
71
71
|
#### Example
|
|
72
72
|
|
|
@@ -108,7 +108,7 @@ disconnect(): Promise<void>;
|
|
|
108
108
|
|
|
109
109
|
#### Possible errors
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
Error If the Wi-Fi state is not in the `client` state.
|
|
112
112
|
|
|
113
113
|
<Separator />
|
|
114
114
|
|
|
@@ -133,7 +133,7 @@ enableAP(ssid: string, password: string): Promise<void>;
|
|
|
133
133
|
|
|
134
134
|
#### Possible errors
|
|
135
135
|
|
|
136
|
-
|
|
136
|
+
Error If the Wi-Fi state is in the `client` state.
|
|
137
137
|
|
|
138
138
|
<Separator />
|
|
139
139
|
|
|
@@ -147,7 +147,7 @@ enableClient(): Promise<void>;
|
|
|
147
147
|
|
|
148
148
|
#### Possible errors
|
|
149
149
|
|
|
150
|
-
|
|
150
|
+
Error If the Wi-Fi state is in the `ap` state.
|
|
151
151
|
|
|
152
152
|
<Separator />
|
|
153
153
|
|
|
@@ -173,7 +173,7 @@ If the device is not connected to any network, it returns `null`.
|
|
|
173
173
|
|
|
174
174
|
#### Possible errors
|
|
175
175
|
|
|
176
|
-
|
|
176
|
+
Error If the Wi-Fi state is not in the `client` state.
|
|
177
177
|
|
|
178
178
|
#### Example
|
|
179
179
|
|
|
@@ -201,7 +201,7 @@ The 2-letter country code from the ISO 3166 standard, or `null` if not set.
|
|
|
201
201
|
|
|
202
202
|
#### Possible errors
|
|
203
203
|
|
|
204
|
-
|
|
204
|
+
Error If the Wi-Fi state is not in the `client` state.
|
|
205
205
|
|
|
206
206
|
<Separator />
|
|
207
207
|
|
|
@@ -233,7 +233,7 @@ if client mode is enabled.
|
|
|
233
233
|
|
|
234
234
|
#### Possible errors
|
|
235
235
|
|
|
236
|
-
|
|
236
|
+
Error If the Wi-Fi state is in the `ap` state.
|
|
237
237
|
|
|
238
238
|
<Separator />
|
|
239
239
|
|
|
@@ -409,7 +409,7 @@ interface IScannedDevice {
|
|
|
409
409
|
|
|
410
410
|
#### Possible errors
|
|
411
411
|
|
|
412
|
-
|
|
412
|
+
Error If the Wi-Fi state is not in the `client` state.
|
|
413
413
|
|
|
414
414
|
<Separator />
|
|
415
415
|
|
|
@@ -431,4 +431,4 @@ setCountry(countryCode: string): Promise<void>;
|
|
|
431
431
|
|
|
432
432
|
#### Possible errors
|
|
433
433
|
|
|
434
|
-
|
|
434
|
+
Error If the Wi-Fi state is not in the `client` state.
|
|
@@ -23,18 +23,30 @@ import NativeCommands from './NativeCommands/NativeCommands';
|
|
|
23
23
|
import { WeinreData } from './Debug/IDebug';
|
|
24
24
|
import Connect from './Connect/Connect';
|
|
25
25
|
/**
|
|
26
|
-
* The `sos` API groups together all functionality the \@signageos/front-applet offers.
|
|
26
|
+
* The `sos` API groups together all functionality the \@signageos/front-applet offers. This is a basic object that provides you with access to
|
|
27
|
+
* all the applet functionality, such as device information, display control, video playback, and more.
|
|
27
28
|
*
|
|
28
|
-
*
|
|
29
|
+
* :::warning
|
|
30
|
+
* All calls to the sos object need to happen after `sos.onReady()` is resolved. After the sOS object is ready, there are global properties available, which can be used for applet customization and device identification.
|
|
31
|
+
* :::
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* // Simple example of using the sos API to play a video.
|
|
35
|
+
* import sos from '@signageos/front-applet';
|
|
36
|
+
*
|
|
37
|
+
* sos.onReady().then(async function () {
|
|
38
|
+
* startYourApplet(); // Example method to run
|
|
39
|
+
* // Any other code
|
|
40
|
+
* }
|
|
29
41
|
*/
|
|
30
42
|
export default class FrontApplet {
|
|
31
43
|
readonly window: Window & WeinreData;
|
|
32
44
|
private messagePrefix;
|
|
33
45
|
/**
|
|
34
|
-
* The `config` property is a Key-value dictionary of the applet configuration.
|
|
46
|
+
* The `config` property is a Key-value dictionary of the applet configuration. It is assigned on the device with timing via Box or SDK/Rest API.
|
|
35
47
|
*
|
|
36
48
|
* @since 1.5.0
|
|
37
|
-
* @
|
|
49
|
+
* @example // {@link https://developers.signageos.io/docs/sos-guides/configuration/ | How to use configuration}
|
|
38
50
|
*/
|
|
39
51
|
readonly config: Record<string, number | string | boolean>;
|
|
40
52
|
/**
|
|
@@ -46,13 +58,17 @@ export default class FrontApplet {
|
|
|
46
58
|
* 3. The `authHash` can be used as a universal identifier for your Applet application.
|
|
47
59
|
*
|
|
48
60
|
* @since 1.0.0
|
|
49
|
-
* @tutorial https://developers.signageos.io/docs/
|
|
61
|
+
* @tutorial https://developers.signageos.io/docs/sos-guides/device-identification
|
|
50
62
|
*/
|
|
51
63
|
readonly authHash: string;
|
|
52
64
|
/**
|
|
53
65
|
* The `appletVersion` is the version of the current applet.
|
|
54
66
|
*
|
|
55
67
|
* @since 4.5.0
|
|
68
|
+
* @example
|
|
69
|
+
* sos.onReady().then(async function () {
|
|
70
|
+
* console.log(sos.appletVersion); // e.g. "4.5.0"
|
|
71
|
+
* });
|
|
56
72
|
*/
|
|
57
73
|
readonly appletVersion: string;
|
|
58
74
|
readonly apiJsUri: string | undefined;
|
|
@@ -89,6 +105,8 @@ export default class FrontApplet {
|
|
|
89
105
|
* The `onReady()` method accepts an optional listener which is called after the sos API are loaded and ready. It also returns a promise
|
|
90
106
|
* which is resolved at the same time as the listener.
|
|
91
107
|
*
|
|
108
|
+
* @param listener Optional listener which is called when the sos API is ready.
|
|
109
|
+
* @return {Promise<void>} Promise which is resolved when the sos API is ready.
|
|
92
110
|
* @since 1.0.0
|
|
93
111
|
*
|
|
94
112
|
* @example
|
|
@@ -110,11 +128,17 @@ export default class FrontApplet {
|
|
|
110
128
|
* needs to be restarted as it's completely switching the playback 'loop/playlist'.
|
|
111
129
|
*
|
|
112
130
|
* @example
|
|
113
|
-
* sos.
|
|
131
|
+
* sos.onReady(async function () {
|
|
132
|
+
* // Some function which is called when the applet is ready
|
|
133
|
+
* sos.restore();
|
|
134
|
+
* });
|
|
114
135
|
*/
|
|
115
136
|
restore(): void;
|
|
116
137
|
/**
|
|
117
|
-
* The `refresh()` method initializes refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
|
|
138
|
+
* The `refresh()` method initializes the refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
|
|
139
|
+
*
|
|
140
|
+
* @return {Promise<void>} Promise that is resolved when the refresh is completed.
|
|
141
|
+
* @since 1.0.0
|
|
118
142
|
*
|
|
119
143
|
* @example
|
|
120
144
|
* await sos.refresh();
|
|
@@ -31,18 +31,30 @@ const ProofOfPlay_1 = __importDefault(require("./ProofOfPlay/ProofOfPlay"));
|
|
|
31
31
|
const NativeCommands_1 = __importDefault(require("./NativeCommands/NativeCommands"));
|
|
32
32
|
const Connect_1 = __importDefault(require("./Connect/Connect"));
|
|
33
33
|
/**
|
|
34
|
-
* The `sos` API groups together all functionality the \@signageos/front-applet offers.
|
|
34
|
+
* The `sos` API groups together all functionality the \@signageos/front-applet offers. This is a basic object that provides you with access to
|
|
35
|
+
* all the applet functionality, such as device information, display control, video playback, and more.
|
|
35
36
|
*
|
|
36
|
-
*
|
|
37
|
+
* :::warning
|
|
38
|
+
* All calls to the sos object need to happen after `sos.onReady()` is resolved. After the sOS object is ready, there are global properties available, which can be used for applet customization and device identification.
|
|
39
|
+
* :::
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* // Simple example of using the sos API to play a video.
|
|
43
|
+
* import sos from '@signageos/front-applet';
|
|
44
|
+
*
|
|
45
|
+
* sos.onReady().then(async function () {
|
|
46
|
+
* startYourApplet(); // Example method to run
|
|
47
|
+
* // Any other code
|
|
48
|
+
* }
|
|
37
49
|
*/
|
|
38
50
|
class FrontApplet {
|
|
39
51
|
window;
|
|
40
52
|
messagePrefix;
|
|
41
53
|
/**
|
|
42
|
-
* The `config` property is a Key-value dictionary of the applet configuration.
|
|
54
|
+
* The `config` property is a Key-value dictionary of the applet configuration. It is assigned on the device with timing via Box or SDK/Rest API.
|
|
43
55
|
*
|
|
44
56
|
* @since 1.5.0
|
|
45
|
-
* @
|
|
57
|
+
* @example // {@link https://developers.signageos.io/docs/sos-guides/configuration/ | How to use configuration}
|
|
46
58
|
*/
|
|
47
59
|
config = undefined;
|
|
48
60
|
/**
|
|
@@ -54,16 +66,20 @@ class FrontApplet {
|
|
|
54
66
|
* 3. The `authHash` can be used as a universal identifier for your Applet application.
|
|
55
67
|
*
|
|
56
68
|
* @since 1.0.0
|
|
57
|
-
* @tutorial https://developers.signageos.io/docs/
|
|
69
|
+
* @tutorial https://developers.signageos.io/docs/sos-guides/device-identification
|
|
58
70
|
*/
|
|
59
71
|
authHash = undefined;
|
|
60
72
|
/**
|
|
61
73
|
* The `appletVersion` is the version of the current applet.
|
|
62
74
|
*
|
|
63
75
|
* @since 4.5.0
|
|
76
|
+
* @example
|
|
77
|
+
* sos.onReady().then(async function () {
|
|
78
|
+
* console.log(sos.appletVersion); // e.g. "4.5.0"
|
|
79
|
+
* });
|
|
64
80
|
*/
|
|
65
81
|
appletVersion = undefined;
|
|
66
|
-
// volatile, set if the FrontApplet is running inside
|
|
82
|
+
// volatile, set if the FrontApplet is running inside an iframe
|
|
67
83
|
apiJsUri;
|
|
68
84
|
debug;
|
|
69
85
|
deviceInfo;
|
|
@@ -151,6 +167,8 @@ class FrontApplet {
|
|
|
151
167
|
* The `onReady()` method accepts an optional listener which is called after the sos API are loaded and ready. It also returns a promise
|
|
152
168
|
* which is resolved at the same time as the listener.
|
|
153
169
|
*
|
|
170
|
+
* @param listener Optional listener which is called when the sos API is ready.
|
|
171
|
+
* @return {Promise<void>} Promise which is resolved when the sos API is ready.
|
|
154
172
|
* @since 1.0.0
|
|
155
173
|
*
|
|
156
174
|
* @example
|
|
@@ -182,7 +200,10 @@ class FrontApplet {
|
|
|
182
200
|
* needs to be restarted as it's completely switching the playback 'loop/playlist'.
|
|
183
201
|
*
|
|
184
202
|
* @example
|
|
185
|
-
* sos.
|
|
203
|
+
* sos.onReady(async function () {
|
|
204
|
+
* // Some function which is called when the applet is ready
|
|
205
|
+
* sos.restore();
|
|
206
|
+
* });
|
|
186
207
|
*/
|
|
187
208
|
restore() {
|
|
188
209
|
void this.postMessage({ type: this.getMessage('restore') });
|
|
@@ -190,7 +211,10 @@ class FrontApplet {
|
|
|
190
211
|
this.forwardRestoreToFrontAppletWindows();
|
|
191
212
|
}
|
|
192
213
|
/**
|
|
193
|
-
* The `refresh()` method initializes refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
|
|
214
|
+
* The `refresh()` method initializes the refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
|
|
215
|
+
*
|
|
216
|
+
* @return {Promise<void>} Promise that is resolved when the refresh is completed.
|
|
217
|
+
* @since 1.0.0
|
|
194
218
|
*
|
|
195
219
|
* @example
|
|
196
220
|
* await sos.refresh();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FrontApplet.js","sourceRoot":"","sources":["../../src/FrontApplet/FrontApplet.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AACtC,gDAAsD;AAEtD,0DAAkC;AAClC,6DAAqC;AACrC,gEAAwC;AAExC,mHAA2F;AAC3F,gEAAwC;AACxC,mEAA2C;AAC3C,gEAAwC;AACxC,6DAAqC;AACrC,0DAAkC;AAClC,0DAAkC;AAClC,0DAAkC;AAClC,yEAAiD;AACjD,gEAAwC;AACxC,6DAAqC;AACrC,uDAA+B;AAC/B,yEAAiD;AACjD,qDAA2E;AAC3E,yEAAiD;AACjD,mEAA2C;AAC3C,gEAAwC;AACxC,kDAAqD;AACrD,oDAA4B;AAC5B,4EAAoD;AACpD,qFAA6D;AAE7D,gEAAwC;AAExC
|
|
1
|
+
{"version":3,"file":"FrontApplet.js","sourceRoot":"","sources":["../../src/FrontApplet/FrontApplet.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AACtC,gDAAsD;AAEtD,0DAAkC;AAClC,6DAAqC;AACrC,gEAAwC;AAExC,mHAA2F;AAC3F,gEAAwC;AACxC,mEAA2C;AAC3C,gEAAwC;AACxC,6DAAqC;AACrC,0DAAkC;AAClC,0DAAkC;AAClC,0DAAkC;AAClC,yEAAiD;AACjD,gEAAwC;AACxC,6DAAqC;AACrC,uDAA+B;AAC/B,yEAAiD;AACjD,qDAA2E;AAC3E,yEAAiD;AACjD,mEAA2C;AAC3C,gEAAwC;AACxC,kDAAqD;AACrD,oDAA4B;AAC5B,4EAAoD;AACpD,qFAA6D;AAE7D,gEAAwC;AAExC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAqB,WAAW;IAiEd;IACR;IAjET;;;;;OAKG;IACa,MAAM,GAA8C,SAAU,CAAC;IAE/E;;;;;;;;;;OAUG;IACa,QAAQ,GAAW,SAAU,CAAC;IAE9C;;;;;;;;OAQG;IACa,aAAa,GAAW,SAAU,CAAC;IAEnD,+DAA+D;IAC/C,QAAQ,CAAqB;IAE7B,KAAK,CAAQ;IACb,UAAU,CAAa;IACvB,OAAO,CAAU;IACjB,MAAM,CAAS;IACf,KAAK,CAAQ;IACb,OAAO,CAAU;IACjB,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,MAAM,CAAS;IACf,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,MAAM,CAAS;IACf,IAAI,CAAO;IACX,UAAU,CAAa;IACvB,UAAU,CAAa;IACvB,QAAQ,CAAW;IACnB,GAAG,CAAM;IACT,WAAW,CAAc;IACzB,OAAO,CAAU;IACjB,MAAM,CAAiB;IACvB,OAAO,CAAU;IAEzB,YAAY,CAAe;IAC3B,yBAAyB,CAAe;IACxC,4BAA4B,CAAsB;IAE1D,gBAAgB;IAChB,YACiB,MAA2B,EACnC,aAAqB;QADb,WAAM,GAAN,MAAM,CAAqB;QACnC,kBAAa,GAAb,aAAa,CAAQ;QAE7B,MAAM,YAAY,GAAG,IAAA,yBAAc,EAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEhF,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,yBAAyB,GAAG,IAAI,qBAAY,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnH,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAClF,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAc,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5D,IAAI,CAAC,4BAA4B,GAAG,IAAI,sCAA4B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5F,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,aAAa,GAAG,YAAY,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,WAAW,CAAC,IAAc;QAChC,MAAM,aAAa,GAAG,IAAA,8BAAkB,GAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,UAAU,CACrB,GAAG,EAAE,CACJ,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CACnC;YACC,aAAa;YACb,GAAG,IAAI;SACP,EACD,GAAG,CACH,CACF,CAAC;QACF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAoC,EAAE,MAA4B,EAAE,EAAE;YACzF,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,YAAiB,EAAE,EAAE;gBACxE,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;oBACxB,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;wBAC9B,MAAM,CAAC,IAAA,yBAAW,EAAC,YAAY,CAAC,KAAK,CAAC,KAAgC,CAAC,CAAC,CAAC;oBAC1E,CAAC;yBAAM,CAAC;wBACP,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;oBAC5B,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC/B,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,OAAO,CAAC,QAAqB;QACnC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAmB,EAAE,EAAE;YAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;gBACpC,OAAO,EAAE,CAAC;gBACV,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;oBACrC,QAAQ,EAAE,CAAC;gBACZ,CAAC;YACF,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,OAAO;QACb,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,kCAAkC,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;SACvC,CAAC,CAAC;IACJ,CAAC;IAEO,kCAAkC;QACzC,MAAM,IAAI,GAAG;YACZ,IAAI,EAAE,IAAI,CAAC,aAAa,GAAG,SAAS;SACpC,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAEO,oBAAoB;QAC3B,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAEO,YAAY;QACnB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACpG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACF,CAAC;IAEO,aAAa,CAAC,KAAmB;QACxC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YAC5B,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;wBACzC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC3E,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;wBACvC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;wBACzE,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;wBACpC,mBAAmB;wBACnB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;wBAC1B,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;wBACvC,mBAAmB;wBACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;wBAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;wBACnD,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;wBACpC,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;wBAC5C,mBAAmB;wBACnB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC;wBAClC,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;wBAC9B,kDAAkD;wBAClD,IAAI,CAAC,oBAAoB,EAAE,CAAC;wBAC5B,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;wBACrC,KAAK,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;wBACjF,MAAM;oBACP;wBACC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAClC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACpC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACxC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAC7C,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACtC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBACvC,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;iBAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,IAAI,CAAC,aAAa,GAAG,eAAe;wBACxC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;wBACpD,MAAM;oBACP,KAAK,IAAI,CAAC,aAAa,GAAG,YAAY;wBACrC,IAAI,CAAC,MAAM,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;wBACrD,MAAM;oBACP;wBACC,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC1D,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;IAEO,YAAY;QACnB,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtC,KAAK,MAAM,EAAE,CAAC;IACf,CAAC;CACD;AAlSD,8BAkSC;AAED,SAAS,QAAQ,CAAC,MAAiC;IAClD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC"}
|
|
@@ -1,12 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Available track types for media streams.
|
|
3
|
+
*/
|
|
1
4
|
export type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
|
|
2
5
|
export type ITrackInfo = ITrackVideoInfo | ITrackAudioInfo | ITrackTextInfo;
|
|
6
|
+
/**
|
|
7
|
+
* Interface representing stream track information.
|
|
8
|
+
*/
|
|
3
9
|
export interface ITrack<T extends TrackType> {
|
|
10
|
+
/**
|
|
11
|
+
* Type of the track, e.g., "VIDEO", "AUDIO", "TEXT".
|
|
12
|
+
*/
|
|
4
13
|
trackType: T;
|
|
14
|
+
/**
|
|
15
|
+
* MIME type of the track, e.g., "video/mp4", "audio/mp3", "text/vtt".
|
|
16
|
+
*/
|
|
5
17
|
mimeType: string;
|
|
18
|
+
/**
|
|
19
|
+
* Unique identifier for the track group.
|
|
20
|
+
* This is used to group tracks of the same type (e.g., multiple audio tracks).
|
|
21
|
+
*/
|
|
6
22
|
groupId: string;
|
|
23
|
+
/**
|
|
24
|
+
* Unique identifier for the track.
|
|
25
|
+
*/
|
|
7
26
|
trackIndex: number;
|
|
27
|
+
/**
|
|
28
|
+
* If the track is selected for playback.
|
|
29
|
+
*/
|
|
8
30
|
selected: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Selected language of subtitles or captions.
|
|
33
|
+
*/
|
|
9
34
|
language: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* If the track is supported by the device.
|
|
37
|
+
*/
|
|
10
38
|
supported: boolean;
|
|
11
39
|
}
|
|
12
40
|
export interface ITrackVideoInfo extends ITrack<'VIDEO'> {
|
|
@@ -16,8 +44,14 @@ export interface ITrackVideoInfo extends ITrack<'VIDEO'> {
|
|
|
16
44
|
};
|
|
17
45
|
}
|
|
18
46
|
export interface ITrackAudioInfo extends ITrack<'AUDIO'> {
|
|
47
|
+
/**
|
|
48
|
+
* Number of audio channels.
|
|
49
|
+
*/
|
|
19
50
|
channelCount: number;
|
|
20
51
|
}
|
|
21
52
|
export interface ITrackTextInfo extends ITrack<'TEXT'> {
|
|
53
|
+
/**
|
|
54
|
+
* Selected subtitles or captions.
|
|
55
|
+
*/
|
|
22
56
|
selection: string[];
|
|
23
57
|
}
|