@flowplayer/player 3.35.0-rc → 3.35.0

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.
Files changed (95) hide show
  1. package/core.js +1 -1
  2. package/default.js +1 -1
  3. package/embed.js +2 -2
  4. package/package.json +1 -2364
  5. package/plugins/ads.js +1 -1
  6. package/plugins/analytics.js +1 -1
  7. package/plugins/rts.js +1 -1
  8. package/plugins/ssai.js +1 -1
  9. package/package/core/events.d.ts +0 -710
  10. package/package/core/events.js +0 -403
  11. package/package/core.js +0 -1
  12. package/package/default.js +0 -1
  13. package/package/embed.js +0 -7
  14. package/package/flowplayer.css +0 -1
  15. package/package/index.d.ts +0 -2238
  16. package/package/plugins/ads.d.ts +0 -4468
  17. package/package/plugins/ads.js +0 -7
  18. package/package/plugins/airplay.d.ts +0 -2152
  19. package/package/plugins/airplay.js +0 -1
  20. package/package/plugins/analytics.d.ts +0 -2146
  21. package/package/plugins/analytics.js +0 -1
  22. package/package/plugins/asel.d.ts +0 -2293
  23. package/package/plugins/asel.js +0 -1
  24. package/package/plugins/audio.d.ts +0 -2146
  25. package/package/plugins/audio.js +0 -1
  26. package/package/plugins/chapters.d.ts +0 -2155
  27. package/package/plugins/chapters.js +0 -1
  28. package/package/plugins/chromecast.d.ts +0 -2221
  29. package/package/plugins/chromecast.js +0 -1
  30. package/package/plugins/comscore.d.ts +0 -2146
  31. package/package/plugins/comscore.js +0 -1
  32. package/package/plugins/consent.d.ts +0 -2194
  33. package/package/plugins/consent.js +0 -1
  34. package/package/plugins/context-menu.d.ts +0 -2160
  35. package/package/plugins/context-menu.js +0 -1
  36. package/package/plugins/cuepoints.d.ts +0 -2270
  37. package/package/plugins/cuepoints.js +0 -1
  38. package/package/plugins/dash.d.ts +0 -2302
  39. package/package/plugins/dash.js +0 -2
  40. package/package/plugins/drm.d.ts +0 -2271
  41. package/package/plugins/drm.js +0 -1
  42. package/package/plugins/endscreen.d.ts +0 -2165
  43. package/package/plugins/endscreen.js +0 -1
  44. package/package/plugins/fas.d.ts +0 -2200
  45. package/package/plugins/fas.js +0 -1
  46. package/package/plugins/float-on-scroll.d.ts +0 -2234
  47. package/package/plugins/float-on-scroll.js +0 -1
  48. package/package/plugins/ga4.d.ts +0 -2146
  49. package/package/plugins/ga4.js +0 -1
  50. package/package/plugins/gemius.d.ts +0 -2171
  51. package/package/plugins/gemius.js +0 -1
  52. package/package/plugins/google-analytics.d.ts +0 -2146
  53. package/package/plugins/google-analytics.js +0 -1
  54. package/package/plugins/hls.d.ts +0 -2271
  55. package/package/plugins/hls.js +0 -1
  56. package/package/plugins/id3.d.ts +0 -2212
  57. package/package/plugins/id3.js +0 -1
  58. package/package/plugins/iframe.d.ts +0 -2147
  59. package/package/plugins/iframe.js +0 -1
  60. package/package/plugins/keyboard.d.ts +0 -2146
  61. package/package/plugins/keyboard.js +0 -1
  62. package/package/plugins/media-session.d.ts +0 -2146
  63. package/package/plugins/media-session.js +0 -1
  64. package/package/plugins/message.d.ts +0 -2205
  65. package/package/plugins/message.js +0 -1
  66. package/package/plugins/ovp.d.ts +0 -2208
  67. package/package/plugins/ovp.js +0 -1
  68. package/package/plugins/playlist.d.ts +0 -2465
  69. package/package/plugins/playlist.js +0 -1
  70. package/package/plugins/preview.d.ts +0 -2236
  71. package/package/plugins/preview.js +0 -1
  72. package/package/plugins/qsel.d.ts +0 -2236
  73. package/package/plugins/qsel.js +0 -1
  74. package/package/plugins/qul.d.ts +0 -2161
  75. package/package/plugins/qul.js +0 -1
  76. package/package/plugins/rts.d.ts +0 -2551
  77. package/package/plugins/rts.js +0 -25
  78. package/package/plugins/share.d.ts +0 -2181
  79. package/package/plugins/share.js +0 -1
  80. package/package/plugins/speed.d.ts +0 -2173
  81. package/package/plugins/speed.js +0 -1
  82. package/package/plugins/ssai.d.ts +0 -2502
  83. package/package/plugins/ssai.js +0 -7
  84. package/package/plugins/subtitles.d.ts +0 -2287
  85. package/package/plugins/subtitles.js +0 -1
  86. package/package/plugins/thumbnails.d.ts +0 -2164
  87. package/package/plugins/thumbnails.js +0 -1
  88. package/package/plugins/tizen.d.ts +0 -2152
  89. package/package/plugins/tizen.js +0 -1
  90. package/package/plugins/vtsel.d.ts +0 -2250
  91. package/package/plugins/vtsel.js +0 -1
  92. package/package/plugins/webos.d.ts +0 -2152
  93. package/package/plugins/webos.js +0 -1
  94. package/package/util/loader.d.ts +0 -2163
  95. package/package/util/loader.js +0 -63
@@ -1,2221 +0,0 @@
1
- import type { Get } from 'type-fest';
2
- import type { Level } from 'hls.js';
3
- import type { Paths } from 'type-fest';
4
- import type { Representation } from 'dashjs';
5
- import type { Translation } from '@flowplayer/translations';
6
- import type { TupleToUnion } from 'type-fest';
7
-
8
- /* Excluded from this release type: AnyLoader */
9
-
10
- declare namespace applications {
11
- export {
12
- STABLE,
13
- CANARY
14
- }
15
- }
16
-
17
- declare type ArrayToIntersection<T extends Array<unknown>> = T extends [
18
- infer Current,
19
- ...infer Remaining
20
- ] ? Current & ArrayToIntersection<Remaining> : unknown;
21
-
22
- /**
23
- * Each loader must
24
- */
25
- declare type _AttachedEventCheck = {
26
- on(event: `${string}:attached`, handler: (e: FPEvent<unknown>) => void): Player;
27
- };
28
-
29
- /* Excluded from this release type: AUDIO_ONLY_SOURCE */
30
-
31
- /* Excluded from this release type: AudioOnlySourceEventDetail */
32
-
33
- declare const audioSegmentFormat: {
34
- readonly AAC: "aac";
35
- readonly AC3: "ac3";
36
- readonly E_AC3: "e_ac3";
37
- readonly FMP4: "fmp4";
38
- readonly MP3: "mp3";
39
- readonly TS: "ts";
40
- readonly TS_AAC: "ts_aac";
41
- };
42
-
43
- declare const AUTOPLAY = "is-autoplay";
44
-
45
- /**
46
- * @public
47
- */
48
- declare type Autoplay = BitOpts | boolean;
49
-
50
- declare enum AutoplayOpts {
51
- OFF = 0,
52
- ON = 1,
53
- AUDIO_REQUIRED = 2
54
- }
55
-
56
- /* Excluded from this release type: BEFORE_PAUSE */
57
-
58
- /* Excluded from this release type: BEFORE_PLAY */
59
-
60
- /**
61
- * @public
62
- */
63
- declare type BeforePauseEventDetail = {
64
- forced: boolean;
65
- };
66
-
67
- /**
68
- * @public
69
- */
70
- declare type BeforePlayEventDetail = {
71
- forced: boolean;
72
- };
73
-
74
- /**
75
- * @public
76
- */
77
- declare type BitOpts = number;
78
-
79
- /**
80
- * @public
81
- */
82
- declare const /**
83
- @public
84
- * when a new player is inserted into the HTML
85
- */ /**
86
- * @public
87
- */
88
- CAN_PLAY = "canplay";
89
-
90
- /**
91
- * the canary (latest release as quick as we can cut it, perfect for testing your code base against what is coming down the line) release for our Chromecast Receiver application
92
- */
93
- declare const CANARY = "6F71FA7C";
94
-
95
- /**
96
- * @public
97
- * The Chromecast plugin adds support for casting the video to Chromecast.
98
- * See {@link https://developer.wowza.com/docs/wowza-flowplayer/plugins/chromecast/|Official documentation}
99
- */
100
- declare const Chromecast: PluginCtor<NoInfer<ChromecastConfig>, NoInfer<Player>> & NoInfer<ChromecastAPI>;
101
- export default Chromecast;
102
-
103
- /**
104
- * @public
105
- */
106
- export declare type ChromecastAPI = {
107
- hlsSegmentFormat: {
108
- audio: typeof audioSegmentFormat;
109
- video: typeof videoSegmentFormat;
110
- };
111
- };
112
-
113
- /**
114
- * @public
115
- */
116
- export declare type ChromecastConfig = ConfigWith<{
117
- /**
118
- * Config for the Chromecast plugin
119
- */
120
- chromecast?: ChromecastConfigObject;
121
- }>;
122
-
123
- /**
124
- * @public
125
- */
126
- export declare interface ChromecastConfigObject {
127
- /**
128
- * Turns off anonymous crossorigin requests and, instead, sends cookies
129
- */
130
- crossOrigin?: boolean;
131
- /* Excluded from this release type: app */
132
- /**
133
- * The format of an HLS audio segment. Default value: ts
134
- */
135
- hlsSegmentFormat?: (typeof audioSegmentFormat)[keyof typeof audioSegmentFormat];
136
- /**
137
- * The format of an HLS video segment. Default value: mpeg2_ts
138
- */
139
- hlsVideoSegmentFormat?: (typeof videoSegmentFormat)[keyof typeof videoSegmentFormat];
140
- }
141
-
142
- /**
143
- * @public
144
- */
145
- declare const /**
146
- @public
147
- * when a new player is inserted into the HTML
148
- */ /**
149
- * @public
150
- */
151
- CLICK = "click";
152
-
153
- /**
154
- * For plugins that add new properties to all source types, combine their src-mixins into one SourceObject
155
- * @example
156
- * ```
157
- * type Combined = CombineGlobalSrcExtensions<DRMPlugin, PluginWithFooFieldInSrc> // Combined = SourceObject<DRMConfig & FooFieldConfig>
158
- * ```
159
- */
160
- declare type CombineGlobalSrcExtensions<PluginSrcs extends unknown[]> = HasGlobalSrcExtensios<PluginSrcs> extends false ? SourceObj : SourceObj & ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
161
-
162
- /**
163
- * For plugins that define a new src type, make a union of all new src.type declarations
164
- * @example
165
- * ```
166
- * type Combined = CombineNewSourceTypes<RTSPlugin, SSAIPlugin> // Combined = DRMConfig | FooFieldConfig
167
- * ```
168
- */
169
- declare type CombineNewSourceTypes<PluginSrcs extends unknown[]> = TupleToUnion<FilterNewSourceTypes<PluginSrcs>>;
170
-
171
- declare type CombineSrc<PluginSrcs extends unknown[]> = UnsafeSource<CombineGlobalSrcExtensions<PluginSrcs> | (CombineNewSourceTypes<PluginSrcs> & CombineGlobalSrcExtensions<PluginSrcs>)>;
172
-
173
- /* Excluded from this release type: Component */
174
-
175
- /* Excluded from this release type: Components */
176
-
177
- /* Excluded from this release type: CONFIG */
178
-
179
- /**
180
- * @public
181
- */
182
- declare interface Config {
183
- src?: UnsafeSource;
184
- preload?: "none" | "metadata" | "auto";
185
- controls?: boolean;
186
- lang?: string;
187
- start_time?: number;
188
- autopause?: boolean;
189
- rewind?: boolean;
190
- loop?: boolean;
191
- /**
192
- * an access token for the media
193
- * @public
194
- */
195
- playback_token?: string;
196
- /* Excluded from this release type: seamless */
197
- retry?: boolean;
198
- autoplay?: Autoplay;
199
- start_quality?: BitOpts;
200
- live?: boolean;
201
- poster?: string;
202
- disabled?: boolean;
203
- muted?: boolean;
204
- /* Excluded from this release type: is_native */
205
- /**
206
- * bitflags for UI options
207
- */
208
- ui?: BitOpts;
209
- /**
210
- * your user access token
211
- */
212
- token?: string;
213
- /* Excluded from this release type: duration */
214
- /**
215
- * can the content be seeked to any position
216
- */
217
- seekable?: boolean;
218
- multiplay?: boolean;
219
- ratio?: number | string;
220
- logo?: string;
221
- logo_href?: string;
222
- logo_alt_text?: string;
223
- title?: string;
224
- description?: string;
225
- /**
226
- * the number of seconds to have in the buffer before dvr is activated
227
- */
228
- seconds_to_dvr?: number;
229
- }
230
-
231
- /* Excluded from this release type: ConfigEventDetail */
232
-
233
- /**
234
- * @public
235
- */
236
- declare type ConfigWith<T> = Config & T;
237
-
238
- declare type ConfigWithSourceExtensions<PluginBareConfigs extends unknown[]> = Omit<ConfigWith<ArrayToIntersection<PluginBareConfigs>>, "src"> & {
239
- src?: CombineSrc<PickSrcExtensions<PluginBareConfigs>>;
240
- };
241
-
242
- /* Excluded from this release type: CONTENT_REAL_LOAD_START */
243
-
244
- /**
245
- * @public
246
- */
247
- declare const /**
248
- @public
249
- * when a new player is inserted into the HTML
250
- */ /**
251
- * @public
252
- */
253
- CONTEXT_MENU = "contextmenu";
254
-
255
- /**
256
- * @public
257
- */
258
- declare type ContextMenuEventDetail = null;
259
-
260
- /**
261
- * @public
262
- * @deprecated
263
- * when a cuepoint becomes inactive
264
- */
265
- declare const /**
266
- @public
267
- * when a new player is inserted into the HTML
268
- */ /**
269
- * @public
270
- * @deprecated
271
- * when a cuepoint becomes inactive
272
- */
273
- CUEPOINT_END = "cuepointend";
274
-
275
- /**
276
- * @public
277
- * @deprecated
278
- * when a cuepoint is active
279
- */
280
- declare const /**
281
- @public
282
- * when a new player is inserted into the HTML
283
- */ /**
284
- * @public
285
- * @deprecated
286
- * when a cuepoint is active
287
- */
288
- CUEPOINT_START = "cuepointstart";
289
-
290
- /**
291
- * @public
292
- * @deprecated
293
- * cuepoints parsing is asynchronous
294
- * you cannot rely on them existing until
295
- * this event is emitted
296
- */
297
- declare const /**
298
- @public
299
- * when a new player is inserted into the HTML
300
- */ /**
301
- * @public
302
- * @deprecated
303
- * cuepoints parsing is asynchronous
304
- * you cannot rely on them existing until
305
- * this event is emitted
306
- */
307
- CUEPOINTS = "cuepoints";
308
-
309
- /**
310
- * @public
311
- */
312
- declare const /**
313
- @public
314
- * when a new player is inserted into the HTML
315
- */ /**
316
- * @public
317
- */
318
- DATA = "loadeddata";
319
-
320
- /**
321
- * @public
322
- */
323
- declare const /**
324
- @public
325
- * when a new player is inserted into the HTML
326
- */ /**
327
- * @public
328
- */
329
- DBL_CLICK = "dblclick";
330
-
331
- declare const DESTROYED = "is-destroyed";
332
-
333
- /* Excluded from this release type: DeviceId */
334
-
335
- declare const DISABLED = "is-disabled";
336
-
337
- /**
338
- * @public
339
- */
340
- declare const /**
341
- @public
342
- * when a new player is inserted into the HTML
343
- */ /**
344
- * @public
345
- */
346
- DURATION_CHANGE = "durationchange";
347
-
348
- /**
349
- * @public
350
- * when the player has started playing dvr content
351
- */
352
- declare const /**
353
- @public
354
- * when a new player is inserted into the HTML
355
- */ /**
356
- * @public
357
- * when the player has started playing dvr content
358
- */
359
- DVR = "dvr";
360
-
361
- /**
362
- * @public
363
- */
364
- declare type DvrEventDetail = number;
365
-
366
- declare const ENDED = "is-ended";
367
-
368
- /**
369
- * @public
370
- */
371
- declare const /**
372
- @public
373
- * when a new player is inserted into the HTML
374
- */ /**
375
- * @public
376
- */
377
- ENDED_2 = "ended";
378
-
379
- declare type EnsureOnAttached<P extends Function, T extends Player> = ExtractPureAPI<T> extends _AttachedEventCheck ? P : "Loaders must implement on('<pluginname>:attached') event";
380
-
381
- /**
382
- * @public
383
- */
384
- declare const /**
385
- @public
386
- * when a new player is inserted into the HTML
387
- */ /**
388
- * @public
389
- */
390
- ERROR = "error";
391
-
392
- declare const ERRORED = "is-error";
393
-
394
- declare namespace events {
395
- export {
396
- MOUNT,
397
- RETRY,
398
- ERROR,
399
- CONTEXT_MENU,
400
- CLICK,
401
- DBL_CLICK,
402
- KEYUP,
403
- KEYDOWN,
404
- LOAD,
405
- MOUSE_ENTER,
406
- MOUSE_LEAVE,
407
- MOUSE_UP,
408
- MOUSE_DOWN,
409
- MOUSE_MOVE,
410
- TOUCH_START,
411
- TOUCH_MOVE,
412
- TOUCH_END,
413
- TOUCH_CANCEL,
414
- RESIZE,
415
- SCROLL,
416
- FULLSCREEN_ENTER,
417
- FULLSCREEN_EXIT,
418
- FULLSCREEN_CHANGE,
419
- METADATA,
420
- DATA,
421
- PROGRESS,
422
- TIME_UPDATE,
423
- LOAD_START,
424
- VOLUME_CHANGE,
425
- PAUSE,
426
- PLAYING_2 as PLAYING,
427
- PLAY,
428
- WAITING_2 as WAITING,
429
- CAN_PLAY,
430
- ENDED_2 as ENDED,
431
- SEEKED,
432
- SEEKING_2 as SEEKING,
433
- DURATION_CHANGE,
434
- VIEW_ENTER,
435
- VIEW_LEAVE,
436
- SOURCE,
437
- REAP,
438
- QUALITIES,
439
- QUALITY_CHANGE,
440
- VIDEO_TRACKS,
441
- SET_QUALITY,
442
- VIDEO_TRACK_SELECT,
443
- RECOMMENDATIONS_READY,
444
- LANDSCAPE,
445
- PORTRAIT,
446
- DVR,
447
- LIVE,
448
- RECOVER,
449
- CUEPOINTS,
450
- CUEPOINT_START,
451
- CUEPOINT_END,
452
- STANDARD_ERROR
453
- }
454
- }
455
-
456
- declare type ExtractBareConfig<Plugins extends PluginCtor> = Plugins extends PluginCtor<ConfigWith<infer ConfigType>> ? ConfigType : never;
457
-
458
- declare type ExtractPluginPlayerExtension<Plugin extends PluginCtor> = Plugin extends PluginCtor<infer _uConfigType, PlayerWith<infer PluginPlayer>> ? PluginPlayer : never;
459
-
460
- declare type ExtractPureAPI<T> = T extends PlayerWith<infer PureAPI> ? PureAPI : never;
461
-
462
- declare type ExtractSrcExtension<PluginBareConfig> = Get<PluginBareConfig, "src"> extends UnsafeSource<infer SrcMixinType> ? SrcMixinType : never;
463
-
464
- declare const FEATURE_USAGE = "flowplayer:feature";
465
-
466
- /* Excluded from this release type: FeatureUsageEventDetail */
467
-
468
- declare type FilterNewSourceTypes<PluginSrcs extends unknown[]> = {
469
- [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
470
- type: string;
471
- } ? PluginSrcs[Index] : never;
472
- };
473
-
474
- /**
475
- * @public
476
- */
477
- declare type FlowplayerCustomElementRegistry = Map<string, string>;
478
-
479
- declare class FlowplayerError extends Error {
480
- readonly message: string;
481
- readonly flowplayerErrorCode: FlowplayerErrorCode;
482
- readonly config: FlowplayerErrorConfig;
483
- static getErrorKey(code: FlowplayerErrorCode): FlowplayerErrorCodeName;
484
- readonly id: string;
485
- readonly isFatal: boolean;
486
- readonly errorKey: string;
487
- constructor(message: string, flowplayerErrorCode: FlowplayerErrorCode, config?: FlowplayerErrorConfig);
488
- toJSON(): {
489
- message: string;
490
- flowplayer_error_code: FlowplayerErrorCode;
491
- id: string;
492
- root_error_id: string | undefined;
493
- resource: string | undefined;
494
- is_fatal: boolean;
495
- is_retry: boolean;
496
- };
497
- }
498
-
499
- declare type FlowplayerErrorCode = (typeof FlowplayerErrorCodeMap)[keyof typeof FlowplayerErrorCodeMap];
500
-
501
- declare const FlowplayerErrorCodeMap: {
502
- /** Unknown */
503
- readonly Unknown: "00-00";
504
- /** Media Section */
505
- readonly MediaUnknown: "01-00";
506
- readonly MediaUnavailable: "01-01";
507
- readonly MediaUnsupportedVideoFormat: "01-02";
508
- readonly MediaUnsupportedAudioFormat: "01-03";
509
- readonly MediaBitrateExceeded: "01-04";
510
- readonly MediaBufferOverread: "01-05";
511
- readonly MediaIntegerOverflow: "01-06";
512
- readonly MediaQuotaExceeded: "01-07";
513
- readonly MediaInvalidCompositionDuration: "01-08";
514
- readonly MediaInvalidCompositionSourceDuration: "01-09";
515
- readonly MediaInvalidCompositionSourceStartTime: "01-10";
516
- readonly MediaMalformedDepth: "01-11";
517
- /** Playback Section */
518
- readonly PlaybackUnknown: "02-00";
519
- readonly PlaybackVideoBufferUnderRun: "02-01";
520
- readonly PlaybackAudioBufferUnderRun: "02-02";
521
- readonly PlaybackVideoBufferingTimeout: "02-03";
522
- readonly PlaybackAudioBufferingTimeout: "02-04";
523
- readonly PlaybackManifestParseError: "02-05";
524
- readonly PlaybackVideoDecodeError: "02-06";
525
- readonly PlaybackAudioDecodeError: "02-07";
526
- readonly PlaybackDroppedFramesExceeded: "02-08";
527
- readonly PlaybackPlayheadExceedsDuration: "02-09";
528
- readonly PlaybackUnsupportedDevice: "02-10";
529
- readonly PlaybackManifestLoadError: "02-11";
530
- readonly PlaybackManifestLoadTimeout: "02-12";
531
- readonly PlaybackManifestParsingError: "02-13";
532
- readonly PlaybackManifestIncompatibleCodecs: "02-14";
533
- readonly PlaybackLevelEmptyError: "02-15";
534
- readonly PlaybackLevelLoadError: "02-16";
535
- readonly PlaybackLevelLoadTimeout: "02-17";
536
- readonly PlaybackLevelSwitchError: "02-18";
537
- readonly PlaybackAudioTrackLoadError: "02-19";
538
- readonly PlaybackAudioTrackLoadTimeout: "02-20";
539
- readonly PlaybackFragLoadError: "02-21";
540
- readonly PlaybackFragLoadTimeout: "02-22";
541
- readonly PlaybackFragDecryptError: "02-23";
542
- readonly PlaybackFragParsingError: "02-24";
543
- readonly PlaybackFragGap: "02-25";
544
- readonly PlaybackRemuxAllocError: "02-26";
545
- readonly PlaybackBufferAddCodecError: "02-27";
546
- readonly PlaybackBufferIncompatibleCodecs: "02-28";
547
- readonly PlaybackBufferAppendError: "02-29";
548
- readonly PlaybackBufferStalledError: "02-30";
549
- readonly PlaybackBufferFullError: "02-31";
550
- readonly PlaybackBufferSeekOverHole: "02-32";
551
- readonly PlaybackBufferNudgeOnStall: "02-33";
552
- readonly PlaybackInternalException: "02-34";
553
- readonly PlaybackInternalAborted: "02-35";
554
- readonly PlaybackManifestLoaderFailure: "02-36";
555
- readonly PlaybackSegmentBaseLoaderError: "02-37";
556
- readonly PlaybackTimeSyncFailed: "02-38";
557
- readonly PlaybackFragmentLoaderFailure: "02-39";
558
- readonly PlaybackAppendError: "02-40";
559
- readonly PlaybackRemoveError: "02-41";
560
- readonly PlaybackDataUpdateFailed: "02-42";
561
- readonly PlaybackManifestNoStreams: "02-43";
562
- readonly PlaybackUnknownManifestType: "02-44";
563
- readonly PlaybackDashInsufficientSegmentInfo: "02-45";
564
- readonly PlaybackDashNoRepresentations: "02-46";
565
- readonly PlaybackDashNoAdaptationSets: "02-47";
566
- readonly PlaybackDashNoInitSegment: "02-48";
567
- readonly PlaybackDashUnsupportedContainerFormat: "02-49";
568
- readonly PlaybackDashKeySystemMismatch: "02-50";
569
- readonly PlaybackMultipleKeyIDs: "02-51";
570
- readonly PlaybackDashConflictingKeyIDs: "02-52";
571
- readonly PlaybackRestrictedStreams: "02-53";
572
- readonly PlaybackHlsMasterAndMediaTags: "02-54";
573
- readonly PlaybackRepresentationIdConflict: "02-55";
574
- readonly PlaybackHlsUnsupportedKeyFormats: "02-56";
575
- readonly PlaybackManifestNoVariants: "02-57";
576
- readonly PlaybackHlsUndeclaredVariables: "02-58";
577
- readonly PlaybackAes128InvalidKeyLength: "02-59";
578
- readonly PlaybackDashConflictingAes128Keys: "02-60";
579
- readonly PlaybackDashUnsupportedAes128Encryption: "02-61";
580
- readonly PlaybackManifestPatchMismatch: "02-62";
581
- readonly PlaybackEmptyMediaPlaylist: "02-63";
582
- readonly PlaybackNonContiguousCompositionTrack: "02-64";
583
- readonly PlaybackDecoderNotFound: "02-65";
584
- readonly PlaybackDecoderTemporarilyUnavailable: "02-66";
585
- readonly PlaybackIncompatibleAsset: "02-67";
586
- readonly PlaybackNoCompatibleExternalDisplay: "02-69";
587
- readonly PlaybackOutOfMemory: "02-70";
588
- readonly PlaybackToneMappingFailed: "02-71";
589
- readonly PlaybackVideoCompositorFailed: "02-72";
590
- /** Network Section */
591
- readonly NetworkUnknown: "03-00";
592
- readonly NetworkNoInternet: "03-01";
593
- readonly NetworkRequestTimeout: "03-02";
594
- readonly NetworkUnableToResolveHost: "03-03";
595
- readonly NetworkResourceNotFound: "03-04";
596
- readonly NetworkExpiredUrl: "03-05";
597
- readonly NetworkUrlResolutionFailed: "03-06";
598
- readonly NetworkDownloadErrorIdManifest: "03-07";
599
- readonly NetworkDownloadErrorIdSidx: "03-08";
600
- readonly NetworkDownloadErrorIdContent: "03-09";
601
- readonly NetworkDownloadErrorIdInitialization: "03-10";
602
- readonly NetworkDownloadErrorIdXlink: "03-11";
603
- readonly NetworkHttpRequestFailed: "03-12";
604
- readonly NetworkMaxRetriesExceeded: "03-13";
605
- readonly NetworkSegmentMissing: "03-14";
606
- /** HTTP Error Codes */
607
- readonly NetworkHttp400BadRequest: "03-400";
608
- readonly NetworkHttp401Unauthorized: "03-401";
609
- readonly NetworkHttp402PaymentRequired: "03-402";
610
- readonly NetworkHttp403Forbidden: "03-403";
611
- readonly NetworkHttp404NotFound: "03-404";
612
- readonly NetworkHttp405MethodNotAllowed: "03-405";
613
- readonly NetworkHttp406NotAcceptable: "03-406";
614
- readonly NetworkHttp407ProxyAuthenticationRequired: "03-407";
615
- readonly NetworkHttp408RequestTimeout: "03-408";
616
- readonly NetworkHttp409Conflict: "03-409";
617
- readonly NetworkHttp410Gone: "03-410";
618
- readonly NetworkHttp411LengthRequired: "03-411";
619
- readonly NetworkHttp412PreconditionFailed: "03-412";
620
- readonly NetworkHttp413PayloadTooLarge: "03-413";
621
- readonly NetworkHttp414URITooLong: "03-414";
622
- readonly NetworkHttp415UnsupportedMediaType: "03-415";
623
- readonly NetworkHttp416RangeNotSatisfiable: "03-416";
624
- readonly NetworkHttp417ExpectationFailed: "03-417";
625
- readonly NetworkHttp418ImATeapot: "03-418";
626
- readonly NetworkHttp421MisdirectedRequest: "03-421";
627
- readonly NetworkHttp422UnprocessableEntity: "03-422";
628
- readonly NetworkHttp423Locked: "03-423";
629
- readonly NetworkHttp424FailedDependency: "03-424";
630
- readonly NetworkHttp425TooEarly: "03-425";
631
- readonly NetworkHttp426UpgradeRequired: "03-426";
632
- readonly NetworkHttp428PreconditionRequired: "03-428";
633
- readonly NetworkHttp429TooManyRequests: "03-429";
634
- readonly NetworkHttp431RequestHeaderFieldsTooLarge: "03-431";
635
- readonly NetworkHttp451UnavailableForLegalReasons: "03-451";
636
- readonly NetworkHttp500InternalServerError: "03-500";
637
- readonly NetworkHttp501NotImplemented: "03-501";
638
- readonly NetworkHttp502BadGateway: "03-502";
639
- readonly NetworkHttp503ServiceUnavailable: "03-503";
640
- readonly NetworkHttp504GatewayTimeout: "03-504";
641
- readonly NetworkHttp505HTTPVersionNotSupported: "03-505";
642
- readonly NetworkHttp506VariantAlsoNegotiates: "03-506";
643
- readonly NetworkHttp507InsufficientStorage: "03-507";
644
- readonly NetworkHttp508LoopDetected: "03-508";
645
- readonly NetworkHttp510NotExtended: "03-510";
646
- readonly NetworkHttp511NetworkAuthenticationRequired: "03-511";
647
- /** Content Protection Section */
648
- readonly ContentProtectionUnknown: "04-00";
649
- readonly ContentProtectionConcurrentStreamLimitExceeded: "04-01";
650
- readonly ContentProtectionEntitlementRefused: "04-02";
651
- readonly ContentProtectionLicenseExpired: "04-03";
652
- readonly ContentProtectionBadLicenseRequest: "04-04";
653
- readonly ContentProtectionLicenseServerTimeout: "04-05";
654
- readonly ContentProtectionInsufficientHDCPSupport: "04-06";
655
- readonly ContentProtectionGeoRestricted: "04-07";
656
- readonly ContentProtectionParentalControlRestricted: "04-08";
657
- readonly ContentProtectionCDNUnauthorized: "04-09";
658
- readonly ContentProtectionInvalidAccessToken: "04-10";
659
- readonly ContentProtectionKeySystemNoKeys: "04-11";
660
- readonly ContentProtectionKeySystemNoAccess: "04-12";
661
- readonly ContentProtectionKeySystemNoSession: "04-13";
662
- readonly ContentProtectionKeySystemNoConfiguredLicense: "04-14";
663
- readonly ContentProtectionKeySystemCertificateRequestFailed: "04-15";
664
- readonly ContentProtectionKeySystemCertificateUpdateFailed: "04-16";
665
- /** Key System: Session update failed */
666
- readonly ContentProtectionKeySystemSessionUpdateFailed: "04-17";
667
- /** Key System: Status output restricted */
668
- readonly ContentProtectionKeySystemStatusOutputRestricted: "04-18";
669
- /** Key System: Status internal error */
670
- readonly ContentProtectionKeySystemStatusInternalError: "04-19";
671
- /** Key Load Error */
672
- readonly ContentProtectionKeyLoadError: "04-20";
673
- /** Key Load Timeout */
674
- readonly ContentProtectionKeyLoadTimeout: "04-21";
675
- /** Capability MediaKeys Error */
676
- readonly ContentProtectionCapabilityMediaKeysError: "04-22";
677
- /** Manifest indicated protected content, but unable to determine key systems */
678
- readonly ContentProtectionManifestKeySystemUnknown: "04-23";
679
- /**
680
- * None of the requested key system configurations are available.
681
- * Possible reasons:
682
- * - Key system not supported
683
- * - Requested features (e.g., persistent state) not supported
684
- * - User denied access in prompt
685
- * - Key system unavailable in insecure contexts (requires HTTPS)
686
- */
687
- readonly ContentProtectionKeySystemUnavailable: "04-24";
688
- /** Browser found requested key system, but failed to create CDM instance */
689
- readonly ContentProtectionCDMCreationFailed: "04-25";
690
- /** Browser created CDM instance but failed to attach it to the video */
691
- readonly ContentProtectionCDMAttachFailed: "04-26";
692
- /** CDM rejected the server certificate (malformed or unsupported format) */
693
- readonly ContentProtectionCDMServerCertificateRejected: "04-27";
694
- /** CDM refused to create a session for unknown reasons */
695
- readonly ContentProtectionCDMSessionCreationFailed: "04-28";
696
- /** CDM unable to generate a license request due to malformed or unsupported init data */
697
- readonly ContentProtectionCDMLicenseRequestFailed: "04-29";
698
- /** License response rejected by the CDM (invalid/malformed response) */
699
- readonly ContentProtectionCDMLicenseResponseRejected: "04-30";
700
- /** Manifest does not specify DRM info, but content is encrypted */
701
- readonly ContentProtectionManifestMissingDRMInfo: "04-31";
702
- /** No license server was provided for the key system signaled by the manifest */
703
- readonly ContentProtectionLicenseServerMissing: "04-32";
704
- /** A required offline session was removed, affecting playback */
705
- readonly ContentProtectionOfflineSessionRemoved: "04-33";
706
- /** Error while executing init data transformation */
707
- readonly ContentProtectionInitDataTransformationError: "04-34";
708
- /** Server certificate request failed */
709
- readonly ContentProtectionServerCertificateRequestFailed: "04-35";
710
- /** HDCP version does not meet the requirements */
711
- readonly ContentProtectionInsufficientHDCPVersion: "04-36";
712
- /** Error when checking HDCP version */
713
- readonly ContentProtectionHDCPVersionCheckFailed: "04-37";
714
- /** Ads Section */
715
- readonly AdsUnknown: "08-00";
716
- readonly AdsVastParseError: "08-100";
717
- readonly AdsInvalidVastSchema: "08-101";
718
- readonly AdsVastVersionNotSupported: "08-102";
719
- readonly AdsUnexpectedAdType: "08-200";
720
- readonly AdsCreativeLinearityMismatch: "08-201";
721
- readonly AdsCreativeDurationMismatch: "08-202";
722
- readonly AdsCreativeSizeMismatch: "08-203";
723
- readonly AdsWrapperVastError: "08-300";
724
- readonly AdsVastResponseRedirectTimeout: "08-301";
725
- readonly AdsWrapperLimitReached: "08-302";
726
- readonly AdsVastResponseEmpty: "08-303";
727
- readonly AdsLinearAdDisplayError: "08-400";
728
- readonly AdsMediaFileNotFound: "08-401";
729
- readonly AdsMediaFileUnavailable: "08-402";
730
- readonly AdsUnsupportedMimeType: "08-403";
731
- readonly AdsUnableToDisplayMediaFile: "08-405";
732
- readonly AdsMezzanineFileMissing: "08-406";
733
- readonly AdsMezzanineFileDownloaded: "08-407";
734
- readonly AdsRejectedAd: "08-408";
735
- readonly AdsInteractiveCreativeError: "08-409";
736
- readonly AdsVerificationNodeExecutionError: "08-410";
737
- readonly AdsNonLinearAdDisplayError: "08-500";
738
- readonly AdsNonLinearAdSizeMismatch: "08-501";
739
- readonly AdsNonLinearAdFetchError: "08-502";
740
- readonly AdsNonLinearUnsupportedType: "08-503";
741
- readonly AdsCompanionAdDisplayError: "08-600";
742
- readonly AdsCompanionAdSizeMismatch: "08-601";
743
- readonly AdsRequiredCompanionAdError: "08-602";
744
- readonly AdsCompanionAdFetchError: "08-603";
745
- readonly AdsUndefinedVastError: "08-900";
746
- readonly AdsUnknownVpaidError: "08-901";
747
- readonly AdsVastDocumentEmpty: "08-999";
748
- };
749
-
750
- declare type FlowplayerErrorCodeName = keyof typeof FlowplayerErrorCodeMap;
751
-
752
- declare type FlowplayerErrorConfig = Partial<{
753
- isFatal: boolean;
754
- showErrorUI: boolean;
755
- isRetry: boolean;
756
- resource: string;
757
- rootErrorId: string;
758
- retryOpts: Partial<{
759
- retry: (typeof RetryMap)[keyof typeof RetryMap];
760
- retryTimeout: number;
761
- }>;
762
- }> & Record<string, any>;
763
-
764
- declare type FlowplayerErrorEventDetail = {
765
- error: FlowplayerError;
766
- };
767
-
768
- /**
769
- * @public
770
- */
771
- declare type FlowplayerStates = typeof states;
772
-
773
- /**
774
- * @public
775
- */
776
- declare interface FlowplayerUMD extends FlowplayerUMDBase {
777
- /**
778
- * Configure flowplayer and display it in the UI
779
- * @param selector - query selector of the HTML element where player will render
780
- * @param config - configuration of flowplayer
781
- */
782
- (selector: string, config?: Config): Player;
783
- /**
784
- * Configure flowplayer and display it in the UI
785
- * @param element - HTML element where player will render
786
- * @param config - configuration of flowplayer
787
- */
788
- (element: HTMLElement, config?: Config): Player;
789
- /**
790
- * Configure flowplayer and display it in the UI
791
- * @param selector - query selector of the HTML element where player will render
792
- * @param config - configuration of flowplayer
793
- */
794
- <T>(selector: string, config?: ConfigWith<T>): Player;
795
- /**
796
- * Configure flowplayer and display it in the UI
797
- * @param element - HTML element where player will render
798
- * @param config - configuration of flowplayer
799
- */
800
- <T>(element: HTMLElement, config?: ConfigWith<T>): Player;
801
- /**
802
- * Register plugins in flowplayer
803
- * @returns flowplayer instance with registered plugins
804
- */
805
- <PluginCtors extends PluginCtor[]>(...plugins: PluginCtors): FlowplayerUMDWithPlugins<MergeConfigs<PluginCtors>, PlayerWith<MergePlayerExtensions<PluginCtors>>>;
806
- }
807
-
808
- declare interface FlowplayerUMDBase {
809
- /**
810
- * All player instances on the page
811
- */
812
- instances: Player[];
813
- /**
814
- * Flowplayer core events
815
- */
816
- events: typeof events;
817
- /**
818
- * Flowplayer ui states map
819
- */
820
- states: FlowplayerStates;
821
- /**
822
- * Flowplayer errors map
823
- */
824
- errors: typeof FlowplayerErrorCodeMap;
825
- quality: typeof QualityOpts;
826
- autoplay: typeof AutoplayOpts;
827
- commit: string;
828
- version: string;
829
- /**
830
- * Flowplayer's custom element registry
831
- */
832
- customElements: FlowplayerCustomElementRegistry;
833
- /* Excluded from this release type: extensions */
834
- /* Excluded from this release type: defaultElements */
835
- /* Excluded from this release type: components */
836
- /* Excluded from this release type: support */
837
- /* Excluded from this release type: jwt */
838
- /* Excluded from this release type: loaders */
839
- /**
840
- * @public
841
- * Translations dictionaries to be used with `@flowplayer/translations` package
842
- *
843
- * See [official documentation](https://developer.wowza.com/docs/wowza-flowplayer/player/translations/)
844
- */
845
- i18n: typeof I18n;
846
- }
847
-
848
- /**
849
- * @public
850
- */
851
- declare interface FlowplayerUMDWithPlugins<ConfigWithPlugins extends Config = Config, PluginPlayer extends Player = Player> extends FlowplayerUMDBase {
852
- /**
853
- * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
854
- * @param selector - query selector of the HTML element where player will render
855
- * @param config - Configuration of the flowplayer and the attached plugins
856
- */
857
- (selector: string, config?: ConfigWithPlugins): PlayerWithOpts<PluginPlayer, ConfigWithPlugins>;
858
- /**
859
- * Configure flowplayer, it's attached plugins and display flowplayer it in the UI
860
- * @param element - HTML element where player will render
861
- * @param config - Configuration of the flowplayer and the attached plugins
862
- */
863
- (element: HTMLElement, config?: ConfigWithPlugins): PlayerWithOpts<PluginPlayer, ConfigWithPlugins>;
864
- }
865
-
866
- /**
867
- * @public
868
- */
869
- declare interface FPEvent<T> extends CustomEvent<T> {
870
- /**
871
- * @deprecated
872
- the data attribute has been migrated to details to match the CustomEvent spec
873
- more info: https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent
874
- */
875
- data?: T;
876
- }
877
-
878
- declare const FULLSCREEN = "is-fullscreen";
879
-
880
- /**
881
- * @public
882
- */
883
- declare const /**
884
- @public
885
- * when a new player is inserted into the HTML
886
- */ /**
887
- * @public
888
- */
889
- FULLSCREEN_CHANGE = "fullscreenchange";
890
-
891
- /**
892
- * @public
893
- */
894
- declare const /**
895
- @public
896
- * when a new player is inserted into the HTML
897
- */ /**
898
- * @public
899
- */
900
- FULLSCREEN_ENTER = "fullscreenenter";
901
-
902
- /**
903
- * @public
904
- */
905
- declare const /**
906
- @public
907
- * when a new player is inserted into the HTML
908
- */ /**
909
- * @public
910
- */
911
- FULLSCREEN_EXIT = "fullscreenexit";
912
-
913
- declare const GRABBING = "is-grabbing";
914
-
915
- declare const HAS_POSTER = "has-poster";
916
-
917
- declare type HasGlobalSrcExtensios<PluginSrcs extends unknown[]> = ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
918
-
919
- declare type HasSrcExtensions<PluginBareConfigs extends unknown[]> = TupleToUnion<PickSrcExtensions<PluginBareConfigs>> extends never ? false : true;
920
-
921
- declare const HOVERED = "is-hovered";
922
-
923
- declare class I18n implements Plugin_2 {
924
- static pluginName: string;
925
- static en: {
926
- ads: {
927
- ad: string;
928
- ads: string;
929
- advertisement: string;
930
- indicator: string;
931
- adchoices: string;
932
- };
933
- audio: {
934
- button_txt: string;
935
- menu_title: string;
936
- };
937
- cc: {
938
- button: string;
939
- menu_title: string;
940
- options: string;
941
- tracks: string;
942
- reset: string;
943
- colors: {
944
- Black: string;
945
- Blue: string;
946
- Cyan: string;
947
- Green: string;
948
- Magenta: string;
949
- Red: string;
950
- White: string;
951
- Yellow: string;
952
- };
953
- edgeStyle: {
954
- None: string;
955
- "Drop shadow": string;
956
- Raised: string;
957
- Depressed: string;
958
- Outline: string;
959
- };
960
- fontFamily: {
961
- "Monospaced Serif": string;
962
- "Proportional Serif": string;
963
- "Monospaced Sans-Serif": string;
964
- "Proportional Sans-Serif": string;
965
- Casual: string;
966
- Cursive: string;
967
- };
968
- properties: {
969
- fontFamily: string;
970
- fontSize: string;
971
- fontColor: string;
972
- fontOpacity: string;
973
- backgroundColor: string;
974
- backgroundOpacity: string;
975
- characterEdgeStyle: string;
976
- };
977
- };
978
- chromecast: {
979
- start: string;
980
- stop: string;
981
- };
982
- core: {
983
- exit_fullscreen: string;
984
- fullscreen: string;
985
- mute: string;
986
- muted: string;
987
- pause: string;
988
- play: string;
989
- seconds: string;
990
- timeline_aria_label: string;
991
- unmute: string;
992
- volume: string;
993
- close: string;
994
- "skip-next": string;
995
- "skip-prev": string;
996
- };
997
- ovp: {
998
- starting_in: string;
999
- };
1000
- playlist: {
1001
- cancel: string;
1002
- up_next: string;
1003
- autoplay: string;
1004
- now_playing: string;
1005
- turn_off_autoplay: string;
1006
- playlist: string;
1007
- };
1008
- qsel: {
1009
- menu_title: string;
1010
- };
1011
- share: {
1012
- clipboard_failure: string;
1013
- clipboard_success: string;
1014
- embed: string;
1015
- link: string;
1016
- menu_title: string;
1017
- };
1018
- speed: {
1019
- menu_title: string;
1020
- };
1021
- vtsel: {
1022
- button_txt: string;
1023
- menu_title: string;
1024
- };
1025
- };
1026
- init(config: Config, _root: never, video: Player): void;
1027
- /* Excluded from this release type: _nonLanguageFields */
1028
- /* Excluded from this release type: languagesLoaded */
1029
- }
1030
-
1031
- declare const IN_VIEWPORT = "is-in-viewport";
1032
-
1033
- /* Excluded from this release type: INTERSECTIONCHANGE */
1034
-
1035
- /* Excluded from this release type: IntersectionChangeEventDetail */
1036
-
1037
- declare const IS_SOURCE_PROCESSING = "is-source-processing";
1038
-
1039
- declare type JSONPlayer = any;
1040
-
1041
- /**
1042
- * @public
1043
- */
1044
- declare const /**
1045
- @public
1046
- * when a new player is inserted into the HTML
1047
- */ /**
1048
- * @public
1049
- */
1050
- KEYDOWN = "keydown";
1051
-
1052
- /**
1053
- * @public
1054
- */
1055
- declare const /**
1056
- @public
1057
- * when a new player is inserted into the HTML
1058
- */ /**
1059
- * @public
1060
- */
1061
- KEYUP = "keyup";
1062
-
1063
- /**
1064
- * @public
1065
- */
1066
- declare type KeyValue = Record<string, any>;
1067
-
1068
- /**
1069
- * @public
1070
- */
1071
- declare const /**
1072
- @public
1073
- * when a new player is inserted into the HTML
1074
- */ /**
1075
- * @public
1076
- */
1077
- LANDSCAPE = "landscape";
1078
-
1079
- /**
1080
- * @public
1081
- * when src is a livestream
1082
- */
1083
- declare const /**
1084
- @public
1085
- * when a new player is inserted into the HTML
1086
- */ /**
1087
- * @public
1088
- * when src is a livestream
1089
- */
1090
- LIVE = "live";
1091
-
1092
- declare const LIVE_2 = "is-live";
1093
-
1094
- declare const LIVE_SEEKED = "is-live-seeked";
1095
-
1096
- /**
1097
- * @public
1098
- */
1099
- declare type LiveEventDetail = null;
1100
-
1101
- /**
1102
- * @public
1103
- */
1104
- declare const /**
1105
- @public
1106
- * when a new player is inserted into the HTML
1107
- */ /**
1108
- * @public
1109
- */
1110
- LOAD = "load";
1111
-
1112
- /**
1113
- * @public
1114
- */
1115
- declare const /**
1116
- @public
1117
- * when a new player is inserted into the HTML
1118
- */ /**
1119
- * @public
1120
- */
1121
- LOAD_START = "loadstart";
1122
-
1123
- declare const LOADED = "is-loaded";
1124
-
1125
- /**
1126
- * @public A plugin that supports loading new media formats. Use 'class MyPlugin implements Loader\<...\>' when writing your custom Loader
1127
- * @typeParam PluginPlayer- Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
1128
- */
1129
- declare interface Loader<PluginOwnConfig extends KeyValue, // FIXME extends Config
1130
- PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwnConfig, PluginPlayer> {
1131
- onload: EnsureOnAttached<(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayer>, src: SourceObj) => void, PluginPlayer>;
1132
- wants<S = SourceObj>(srcString: SourceStr, srcObj: S, config: ConfigWith<PluginOwnConfig>): boolean;
1133
- wants<S = KeyValue>(srcString: SourceStr, srcObj: SourceWith<S>, config: ConfigWith<PluginOwnConfig>): boolean;
1134
- }
1135
-
1136
- declare const LOADING = "is-loading";
1137
-
1138
- /* Excluded from this release type: LOCAL */
1139
-
1140
- declare type MapToBareConfigs<Plugins extends PluginCtor[]> = {
1141
- [PluginType in keyof Plugins]: ExtractBareConfig<Plugins[PluginType]>;
1142
- };
1143
-
1144
- declare type MapToPlayerExtensions<Plugins extends PluginCtor[]> = {
1145
- [PluginIndex in keyof Plugins]: ExtractPluginPlayerExtension<Plugins[PluginIndex]>;
1146
- };
1147
-
1148
- declare const MENU_OPENED = "has-menu-opened";
1149
-
1150
- /**
1151
- * Combines plugin config and returns a type derived from Config
1152
- */
1153
- declare type MergeConfigs<Plugins extends PluginCtor[]> = MergePluginConfigs<MapToBareConfigs<Plugins>>;
1154
-
1155
- declare type MergePlayerExtensions<Plugins extends PluginCtor[]> = ArrayToIntersection<MapToPlayerExtensions<Plugins>>;
1156
-
1157
- declare type MergePluginConfigs<PluginBareConfigs extends unknown[]> = HasSrcExtensions<PluginBareConfigs> extends true ? ConfigWithSourceExtensions<PluginBareConfigs> : ConfigWith<ArrayToIntersection<PluginBareConfigs>>;
1158
-
1159
- /**
1160
- * @public
1161
- * general video events flowplayer uses internally
1162
- * https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events
1163
- */
1164
- declare const /**
1165
- @public
1166
- * when a new player is inserted into the HTML
1167
- */ /**
1168
- * @public
1169
- * general video events flowplayer uses internally
1170
- * https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events
1171
- */
1172
- METADATA = "loadedmetadata";
1173
-
1174
- /**
1175
- @public
1176
- * when a new player is inserted into the HTML
1177
- */
1178
- declare const /**
1179
- @public
1180
- * when a new player is inserted into the HTML
1181
- */ /**
1182
- @public
1183
- * when a new player is inserted into the HTML
1184
- */ MOUNT = "mount";
1185
-
1186
- /**
1187
- * @public
1188
- */
1189
- declare type MountEventDetail = null;
1190
-
1191
- /**
1192
- * @public
1193
- */
1194
- declare const /**
1195
- @public
1196
- * when a new player is inserted into the HTML
1197
- */ /**
1198
- * @public
1199
- */
1200
- MOUSE_DOWN = "mousedown";
1201
-
1202
- /**
1203
- * @public
1204
- */
1205
- declare const /**
1206
- @public
1207
- * when a new player is inserted into the HTML
1208
- */ /**
1209
- * @public
1210
- */
1211
- MOUSE_ENTER = "mouseenter";
1212
-
1213
- /**
1214
- * @public
1215
- */
1216
- declare const /**
1217
- @public
1218
- * when a new player is inserted into the HTML
1219
- */ /**
1220
- * @public
1221
- */
1222
- MOUSE_LEAVE = "mouseleave";
1223
-
1224
- /**
1225
- * @public
1226
- */
1227
- declare const /**
1228
- @public
1229
- * when a new player is inserted into the HTML
1230
- */ /**
1231
- * @public
1232
- */
1233
- MOUSE_MOVE = "mousemove";
1234
-
1235
- /**
1236
- * @public
1237
- */
1238
- declare const /**
1239
- @public
1240
- * when a new player is inserted into the HTML
1241
- */ /**
1242
- * @public
1243
- */
1244
- MOUSE_UP = "mouseup";
1245
-
1246
- declare const MUTED = "is-muted";
1247
-
1248
- declare const NO_CONTROLS = "no-controls";
1249
-
1250
- declare const NO_DVR = "no-timeline";
1251
-
1252
- /* Excluded from this release type: NON_RECOVERABLE_ERROR */
1253
-
1254
- /* Excluded from this release type: NonRecoverableErrorEventDetail */
1255
-
1256
- /* Excluded from this release type: NQState */
1257
-
1258
- /**
1259
- * @public
1260
- */
1261
- declare type OVPMetadata = {
1262
- player_id?: string;
1263
- media_id?: string;
1264
- ad_keywords?: string;
1265
- title?: string;
1266
- description?: string;
1267
- category_name?: string;
1268
- duration?: number;
1269
- tags?: string;
1270
- };
1271
-
1272
- /**
1273
- * @public
1274
- */
1275
- declare const /**
1276
- @public
1277
- * when a new player is inserted into the HTML
1278
- */ /**
1279
- * @public
1280
- */
1281
- PAUSE = "pause";
1282
-
1283
- declare const PAUSED = "is-paused";
1284
-
1285
- declare type PickGlobalSrcExtension<PluginSrcs extends unknown[]> = {
1286
- [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
1287
- type: string;
1288
- } ? unknown : PluginSrcs[Index];
1289
- };
1290
-
1291
- /**
1292
- * Maps incoming array to the src extension type
1293
- * @example
1294
- * ```
1295
- * PickSrcExtensions<[
1296
- * {configProp: boolean, src: UnsafeSource<{srcProp: boolean}>},
1297
- * {}
1298
- * ]> // = [{srcProp: boolean}, never]
1299
- * ```
1300
- */
1301
- declare type PickSrcExtensions<PluginBareConfigs extends unknown[]> = {
1302
- [PluginType in keyof PluginBareConfigs]: ExtractSrcExtension<PluginBareConfigs[PluginType]>;
1303
- };
1304
-
1305
- /**
1306
- * @public
1307
- */
1308
- declare const /**
1309
- @public
1310
- * when a new player is inserted into the HTML
1311
- */ /**
1312
- * @public
1313
- */
1314
- PLAY = "play";
1315
-
1316
- /**
1317
- * @public
1318
- */
1319
- declare type Player = HTMLVideoElement & PlayerEventOverloads & {
1320
- /* Excluded from this release type: renderPlugin */
1321
- /**
1322
- * Disables and enables the player.
1323
- * @param flag -Forces disabled mode (true) or enabled mode (false). Disabled player cannot be seeked forward.
1324
- */
1325
- toggleDisable: (flag?: boolean) => void;
1326
- /* Excluded from this release type: original_src */
1327
- /**
1328
- * The root element of the video player. This is the immediate parent element of the video tag.
1329
- */
1330
- root: PlayerRoot;
1331
- /* Excluded from this release type: playerState */
1332
- /* Excluded from this release type: reaper */
1333
- /* Excluded from this release type: hasState */
1334
- /* Excluded from this release type: transitionState */
1335
- /**
1336
- * Toggles between playing and paused mode.
1337
- * @param on - Forces the playback (true) or paused state (false). Use this for initial playback of a source configured with setSrc() and when changing the state.
1338
- */
1339
- togglePlay(on?: boolean): Promise<void>;
1340
- /* Excluded from this release type: toggleFullScreen */
1341
- /**
1342
- * @public
1343
- * Toggles between normal and fullscreen mode. The optional flag attribute forces the normal sized (false) or fullscreen (false) mode.
1344
- * The custom fullscreenenter and fullscreenexit events are sent respectively.
1345
- */
1346
- toggleFullScreen(on?: boolean): void;
1347
- /* Excluded from this release type: toggleMute */
1348
- /**
1349
- * Toggles between muted and original volume level.
1350
- */
1351
- toggleMute(): void;
1352
- /**
1353
- * Removes a Flowplayer instance from `flowplayer.instances` and emits the `flowplayer.events.REAP` event, enabling cleanup of unsafe resources.
1354
- */
1355
- destroy(): void;
1356
- /* Excluded from this release type: render */
1357
- /* Excluded from this release type: render */
1358
- createComponents(...args: string[]): HTMLElement[];
1359
- /**
1360
- * Adds or changes configuration object. Usually used in conjunction with `setSrc()`. You can use all top-level config options like `subtitle:` , `logo:`, `ima:` etc.
1361
- * @example
1362
- * ```
1363
- * setOpts({
1364
- * subtitles:{
1365
- * tracks:[
1366
- * {
1367
- * src: "1.vtt",
1368
- * label: "English",
1369
- * default: true
1370
- * }, {
1371
- * src: "2.vtt",
1372
- * label: "Spanish",
1373
- * default : false }]},
1374
- * logo: "https://myserver.com/logo.png"
1375
- * })
1376
- * ```
1377
- */
1378
- setOpts(config: Config): void;
1379
- /**
1380
- * Sets the video source to be played. The src attribute can be a string or an object similar to the src property.
1381
- */
1382
- setSrc(sources: UnsafeSource): void;
1383
- /* Excluded from this release type: setSrc */
1384
- /* Excluded from this release type: setAttrs */
1385
- /* Excluded from this release type: opt */
1386
- /* Excluded from this release type: enqueueSeek */
1387
- /* Excluded from this release type: setState */
1388
- setState(state: PlayerState, flag: boolean): void;
1389
- /* Excluded from this release type: toJSON */
1390
- /**
1391
- * Adds a language to the project. See {@link https://developer.wowza.com/docs/wowza-flowplayer/player/translations/#using-npm| Official documentation}
1392
- */
1393
- i18n(k: TranslationKey): string;
1394
- i18n(k: string, fallback: string): string;
1395
- /* Excluded from this release type: deviceId */
1396
- /* Excluded from this release type: live_state */
1397
- /**
1398
- * A reference to the configuration state of the player.
1399
- */
1400
- opts: Config;
1401
- /* Excluded from this release type: plugins */
1402
- /* Excluded from this release type: dvr_offset */
1403
- message?: {
1404
- events: Record<string, string>;
1405
- };
1406
- /**
1407
- * A boolean specifying whether the player is disabled and the user cannot seek forward using the mouse or keyboard.
1408
- * Player is disabled and enabled with the `toggleDisable()` method.
1409
- */
1410
- disabled: boolean;
1411
- /* Excluded from this release type: started */
1412
- /* Excluded from this release type: token */
1413
- /* Excluded from this release type: _customElements */
1414
- /* Excluded from this release type: _storage */
1415
- };
1416
-
1417
- declare type PlayerCustomEventName = keyof PlayerCustomEventsDetailMap;
1418
-
1419
- declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap & {
1420
- [REAP]: ReapEventDetail;
1421
- [SOURCE]: SourceEventDetail;
1422
- [MOUNT]: MountEventDetail;
1423
- [LIVE]: LiveEventDetail;
1424
- [DVR]: DvrEventDetail;
1425
- [RETRY]: RetryEventDetail;
1426
- [RECOVER]: RecoverEventDetail;
1427
- [QUALITIES]: QualitiesEventDetail;
1428
- [QUALITY_CHANGE]: QualityChangeEventDetail;
1429
- [STANDARD_ERROR]: FlowplayerErrorEventDetail;
1430
- /* Excluded from this release type: audioonlysource */
1431
- /* Excluded from this release type: renderplugin */
1432
- /* Excluded from this release type: "seek:queued" */
1433
- /* Excluded from this release type: "seek:cancel" */
1434
- /* Excluded from this release type: "plugin:registered" */
1435
- /* Excluded from this release type: intersectionchange */
1436
- /* Excluded from this release type: "flowplayer:feature" */
1437
- /* Excluded from this release type: beforeplay */
1438
- /* Excluded from this release type: beforepause */
1439
- /* Excluded from this release type: state */
1440
- /* Excluded from this release type: config */
1441
- /* Excluded from this release type: "error:fatal" */
1442
- };
1443
-
1444
- declare type PlayerCustomEventsOverloads = {
1445
- /**
1446
- * Sent when the player interface is completely rendered and you can access all the elements with CSS and JavaScript. Due to the way mounting works, this event is only accessible inside of a custom extension.
1447
- */
1448
- on(event: typeof MOUNT, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof MOUNT]>) => void): Player;
1449
- /**
1450
- * Sent when an error occurs. Learn more about error handling.
1451
- */
1452
- on(// FIXME - this event is in context-menu plugin
1453
- event: typeof CONTEXT_MENU, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof CONTEXT_MENU]>) => void): Player;
1454
- /* Excluded from this release type: on */
1455
- /* Excluded from this release type: on */
1456
- /* Excluded from this release type: on */
1457
- /**
1458
- * Sent when the player becomes visible for the user.
1459
- */
1460
- on(event: typeof VIEW_ENTER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof VIEW_ENTER]>) => void): Player;
1461
- /**
1462
- * Sent when the player leaves the users viewport and is longer visible.
1463
- */
1464
- on(event: typeof VIEW_LEAVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof VIEW_LEAVE]>) => void): Player;
1465
- /**
1466
- * Sent right before the player src attribute is set. This allows you to change the video URL before playback.
1467
- */
1468
- on(event: typeof SOURCE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof SOURCE]>) => void): Player;
1469
- /**
1470
- * Emitted when an Error recovery is attempted
1471
- */
1472
- on(event: typeof RECOVER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOVER]>) => void): Player;
1473
- /**
1474
- * Sent when a flowplayer instance is about to be removed from the DOM, and any unsafe references are about to be reaped, which allows Single Page Applications to perform the necessary resource cleanups. This is important when working with front-end frameworks like React. This event should never be emitted directly, only listened to.
1475
- */
1476
- on(event: typeof REAP, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof REAP]>) => void): Player;
1477
- /**
1478
- * Emitted when a player will retry to reload
1479
- */
1480
- on(event: typeof RETRY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RETRY]>) => void): Player;
1481
- /* Excluded from this release type: on */
1482
- /**
1483
- * Emitted when the set of underlying qualities has changed.
1484
- */
1485
- on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
1486
- /**
1487
- * Emitted when the media changes quality.
1488
- */
1489
- on(event: typeof QUALITY_CHANGE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITY_CHANGE]>) => void): Player;
1490
- /**
1491
- * Emitted when a standard FlowplayerError is encountered
1492
- */
1493
- on(event: typeof STANDARD_ERROR, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof STANDARD_ERROR]>) => void): Player;
1494
- /* Excluded from this release type: on */
1495
- /**
1496
- * Listen to this event to create a recommendations grid using the data passed with the event.
1497
- */
1498
- on(event: typeof RECOMMENDATIONS_READY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOMMENDATIONS_READY]>) => void): Player;
1499
- /* Excluded from this release type: on */
1500
- /* Excluded from this release type: on */
1501
- /**
1502
- * when the player has started playing dvr content
1503
- */
1504
- on(event: typeof DVR, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof DVR]>) => void): Player;
1505
- /**
1506
- * when src is a livestream
1507
- */
1508
- on(event: typeof LIVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE]>) => void): Player;
1509
- /* Excluded from this release type: on */
1510
- /* Excluded from this release type: on */
1511
- /* Excluded from this release type: on */
1512
- /* Excluded from this release type: on */
1513
- /* Excluded from this release type: on */
1514
- /* Excluded from this release type: on */
1515
- /**
1516
- * TODO: this is a workaround, since not all event overloads are typed. when all plugin work is finished, remove this
1517
- * https://wowzamedia.jira.com/browse/PLAY-653
1518
- */
1519
- on<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1520
- /* Excluded from this release type: on */
1521
- /**
1522
- * Same as `on()`, but the handler function is executed only once.
1523
- */
1524
- once<T extends PlayerCustomEventName>(event: T, handler: (e: FPEvent<PlayerCustomEventsDetailMap[T]>) => void): Player;
1525
- /**
1526
- * Same as `on()`, but the handler function is executed only once.
1527
- */
1528
- once<T extends PlayerNativeEventName>(event: T, handler: (e: PlayerNativeEventsDetailMap[T]) => void): Player;
1529
- once<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1530
- /**
1531
- * Removes the event handler with the specified event type.
1532
- */
1533
- off<T extends PlayerCustomEventName>(event: T, handler: (e: FPEvent<PlayerCustomEventsDetailMap[T]>) => void): Player;
1534
- /**
1535
- * Removes the event handler with the specified event type.
1536
- */
1537
- off<T extends PlayerNativeEventName>(event: T, handler: (e: PlayerNativeEventsDetailMap[T]) => void): Player;
1538
- /**
1539
- * Removes the event handler with the specified event type.
1540
- */
1541
- off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1542
- /* Excluded from this release type: poll */
1543
- emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1544
- emit(event: never, data?: never): Player;
1545
- /* Excluded from this release type: emit */
1546
- /* Excluded from this release type: emit */
1547
- };
1548
-
1549
- declare type PlayerEmittableCustomEventsDetailMap = {
1550
- [CONTEXT_MENU]: ContextMenuEventDetail;
1551
- [VIEW_ENTER]: ViewEnterEventDetail;
1552
- [VIEW_LEAVE]: ViewLeaveEventDetail;
1553
- [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
1554
- };
1555
-
1556
- declare type PlayerEmittableEventNames = keyof PlayerEmittableCustomEventsDetailMap;
1557
-
1558
- /**
1559
- * @public
1560
- */
1561
- declare type PlayerEventOverloads = PlayerNativeEventsOverloads & PlayerCustomEventsOverloads;
1562
-
1563
- declare type PlayerNativeEventName = keyof PlayerNativeEventsDetailMap;
1564
-
1565
- declare type PlayerNativeEventsDetailMap = HTMLVideoElementEventMap;
1566
-
1567
- declare type PlayerNativeEventsOverloads = {
1568
- on<K extends keyof PlayerNativeEventsDetailMap>(event: K, handler: (ev: PlayerNativeEventsDetailMap[K]) => void): Player;
1569
- };
1570
-
1571
- /**
1572
- * @public
1573
- * The root element of the video player. This is the immediate parent element of the video tag.
1574
- */
1575
- declare type PlayerRoot = HTMLElement & {
1576
- /* Excluded from this release type: prevWidth */
1577
- };
1578
-
1579
- /**
1580
- * @public
1581
- */
1582
- declare type PlayerState = FlowplayerStates[keyof FlowplayerStates];
1583
-
1584
- /* Excluded from this release type: _PlayerState */
1585
-
1586
- /* Excluded from this release type: PlayerStates */
1587
-
1588
- /**
1589
- * @public
1590
- */
1591
- declare type PlayerWith<T> = T & Player;
1592
-
1593
- declare type PlayerWithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = {
1594
- /* Excluded from this release type: on */
1595
- } & Omit<PluginPlayer, "opts" | "setOpts"> & {
1596
- opts: PluginConfig;
1597
- setOpts: (config: PluginConfig) => void;
1598
- };
1599
-
1600
- declare const PLAYING = "is-playing";
1601
-
1602
- /**
1603
- * @public
1604
- */
1605
- declare const /**
1606
- @public
1607
- * when a new player is inserted into the HTML
1608
- */ /**
1609
- * @public
1610
- */
1611
- PLAYING_2 = "playing";
1612
-
1613
- /**
1614
- * @public
1615
- */
1616
- declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
1617
- /**
1618
- * a plugin must always implement the init method so a player instance knows how to initialize it
1619
- */
1620
- init(config: PluginConfig, container: PlayerRoot, player: PluginPlayer): void;
1621
- }
1622
-
1623
- /* Excluded from this release type: PLUGIN_REGISTERED */
1624
-
1625
- /**
1626
- * @public
1627
- */
1628
- declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
1629
- new (umd: FlowplayerUMD, player: Player): Plugin_2<PluginConfig, PluginPlayer>;
1630
- pluginName: string;
1631
- }
1632
-
1633
- /* Excluded from this release type: PluginRegisteredEventDetail */
1634
-
1635
- declare type PluginStates = string;
1636
-
1637
- /**
1638
- * @public
1639
- */
1640
- declare const /**
1641
- @public
1642
- * when a new player is inserted into the HTML
1643
- */ /**
1644
- * @public
1645
- */
1646
- PORTRAIT = "portrait";
1647
-
1648
- /**
1649
- * @public
1650
- */
1651
- declare const /**
1652
- @public
1653
- * when a new player is inserted into the HTML
1654
- */ /**
1655
- * @public
1656
- */
1657
- PROGRESS = "progress";
1658
-
1659
- /**
1660
- * @public
1661
- */
1662
- declare type QselOption = (Level & {
1663
- level: number;
1664
- }) | Representation | {
1665
- name: string | number;
1666
- encodingId: string;
1667
- spatialLayerId: number;
1668
- temporalLayerId: number;
1669
- maxSpatialLayerId: number;
1670
- maxTemporalLayerId: number;
1671
- height: number;
1672
- width: number;
1673
- };
1674
-
1675
- /**
1676
- * @public
1677
- * emitted whenever a list of qualities has been made available
1678
- * when index 0 is the highest quality and index 0+N is the lowest
1679
- */
1680
- declare const /**
1681
- @public
1682
- * when a new player is inserted into the HTML
1683
- */ /**
1684
- * @public
1685
- * emitted whenever a list of qualities has been made available
1686
- * when index 0 is the highest quality and index 0+N is the lowest
1687
- */
1688
- QUALITIES = "qualities";
1689
-
1690
- /**
1691
- * @public
1692
- */
1693
- declare type QualitiesEventDetail = QselOption[];
1694
-
1695
- /**
1696
- * @public
1697
- * emitted whenever the media changes quality
1698
- */
1699
- declare const /**
1700
- @public
1701
- * when a new player is inserted into the HTML
1702
- */ /**
1703
- * @public
1704
- * emitted whenever the media changes quality
1705
- */
1706
- QUALITY_CHANGE = "qualitychange";
1707
-
1708
- /**
1709
- * @public
1710
- */
1711
- declare type QualityChangeEventDetail = {
1712
- before?: (Level & {
1713
- level?: number;
1714
- }) | Representation;
1715
- after: (Level & {
1716
- level?: number;
1717
- }) | Representation;
1718
- plugin: string;
1719
- automatic: boolean;
1720
- /* Excluded from this release type: downscale */
1721
- };
1722
-
1723
- declare enum QualityOpts {
1724
- LOW = 1,
1725
- MEDIUM = 2,
1726
- HIGH = 4
1727
- }
1728
-
1729
- /**
1730
- * @public
1731
- * emitted when it is safe to clean up a fp instance
1732
- */
1733
- declare const /**
1734
- @public
1735
- * when a new player is inserted into the HTML
1736
- */ /**
1737
- * @public
1738
- * emitted when it is safe to clean up a fp instance
1739
- */
1740
- REAP = "reap";
1741
-
1742
- /**
1743
- * @public
1744
- */
1745
- declare type ReapEventDetail = null;
1746
-
1747
- /**
1748
- * @public
1749
- */
1750
- declare type RecommendationItem = {
1751
- poster?: string;
1752
- src?: UnsafeSource;
1753
- title?: string;
1754
- description?: string;
1755
- metadata: OVPMetadata;
1756
- chapters?: {
1757
- src: string;
1758
- };
1759
- thumbnails?: {
1760
- src: string;
1761
- };
1762
- subtitles?: string[];
1763
- };
1764
-
1765
- /**
1766
- * @public
1767
- */
1768
- declare const /**
1769
- @public
1770
- * when a new player is inserted into the HTML
1771
- */ /**
1772
- * @deprecated please use Endscreen.events.RECOMMENDATIONS_READY / flowplayer.endscreen.events.RECOMMENDATIONS_READY
1773
- **/
1774
- /**
1775
- * @public
1776
- */
1777
- RECOMMENDATIONS_READY = "recommendationsready";
1778
-
1779
- /**
1780
- * @public
1781
- */
1782
- declare type RecommendationsReadyEventDetail = {
1783
- playlist: RecommendationItem[];
1784
- };
1785
-
1786
- /**
1787
- * @public
1788
- * emitted when an Error recovery is attempted
1789
- */
1790
- declare const /**
1791
- @public
1792
- * when a new player is inserted into the HTML
1793
- */ /**
1794
- * @public
1795
- * emitted when an Error recovery is attempted
1796
- */
1797
- RECOVER = "recover";
1798
-
1799
- /**
1800
- * @public
1801
- */
1802
- declare type RecoverEventDetail = null;
1803
-
1804
- /* Excluded from this release type: REMOTE_SESSION_ENDED */
1805
-
1806
- /* Excluded from this release type: REMOTE_SESSION_STARTED */
1807
-
1808
- /* Excluded from this release type: RENDER_PLUGIN */
1809
-
1810
- /**
1811
- * @public
1812
- */
1813
- declare type RenderPluginEventDetail = HTMLElement;
1814
-
1815
- /**
1816
- * @public
1817
- */
1818
- declare const /**
1819
- @public
1820
- * when a new player is inserted into the HTML
1821
- */ /**
1822
- * @public
1823
- */
1824
- RESIZE = "resize";
1825
-
1826
- /**
1827
- * @public
1828
- */
1829
- declare const /**
1830
- @public
1831
- * when a new player is inserted into the HTML
1832
- */ /**
1833
- * @public
1834
- */
1835
- RETRY = "retry";
1836
-
1837
- /**
1838
- * @public
1839
- */
1840
- declare type RetryEventDetail = FlowplayerErrorEventDetail;
1841
-
1842
- declare const RetryMap: {
1843
- readonly ON: "on";
1844
- readonly WITHOUT_RECOVERY: "without_recovery";
1845
- readonly OFF: "off";
1846
- };
1847
-
1848
- declare const RTL = "is-rtl";
1849
-
1850
- declare const SampleRate: {
1851
- /**
1852
- * for new features with low adoption rates, or features that are likely to not be used frequently, will include every single instance in the sample.
1853
- */
1854
- readonly All: 1;
1855
- /**
1856
- * for events we anticipate receive a lot of usage and maybe happen frequently per session
1857
- */
1858
- readonly High: 0.1;
1859
- /**
1860
- * for events that can happen quickly, but not in massive amounts
1861
- */
1862
- readonly Medium: 0.01;
1863
- /**
1864
- * for very high volume events where you only want to sample a low amount of them (think volumechange | timeupdate)
1865
- */
1866
- readonly Low: 0.001;
1867
- /**
1868
- * placeholder for never sampling something, useful in situations where we want to add code to sample, but maybe not turn it on just yet.
1869
- */
1870
- readonly None: 0;
1871
- };
1872
-
1873
- /**
1874
- * @public
1875
- */
1876
- declare const /**
1877
- @public
1878
- * when a new player is inserted into the HTML
1879
- */ /**
1880
- * @public
1881
- */
1882
- SCROLL = "scroll";
1883
-
1884
- declare const SEAMLESS = "is-seamless";
1885
-
1886
- /* Excluded from this release type: SEEK_CANCEL */
1887
-
1888
- /* Excluded from this release type: SEEK_QUEUED */
1889
-
1890
- declare const SEEKABLE = "is-seekable";
1891
-
1892
- /* Excluded from this release type: SeekCancelEventDetail */
1893
-
1894
- /**
1895
- * @public
1896
- */
1897
- declare const /**
1898
- @public
1899
- * when a new player is inserted into the HTML
1900
- */ /**
1901
- * @public
1902
- */
1903
- SEEKED = "seeked";
1904
-
1905
- declare const SEEKING = "is-seeking";
1906
-
1907
- /**
1908
- * @public
1909
- */
1910
- declare const /**
1911
- @public
1912
- * when a new player is inserted into the HTML
1913
- */ /**
1914
- * @public
1915
- */
1916
- SEEKING_2 = "seeking";
1917
-
1918
- /* Excluded from this release type: SeekQueuedEventDetail */
1919
-
1920
- /**
1921
- * @public
1922
- * @deprecated please use Qsel.events.SET_QUALITY
1923
- */
1924
- declare const /**
1925
- @public
1926
- * when a new player is inserted into the HTML
1927
- */ /**
1928
- * @public
1929
- * @deprecated please use Qsel.events.SET_QUALITY
1930
- */
1931
- SET_QUALITY = "quality:set";
1932
-
1933
- declare const SMALL = "is-small";
1934
-
1935
- /**
1936
- * @public
1937
- * emitted when a valid source is found prior to mounting
1938
- */
1939
- declare const /**
1940
- @public
1941
- * when a new player is inserted into the HTML
1942
- */ /**
1943
- * @public
1944
- * emitted when a valid source is found prior to mounting
1945
- */
1946
- SOURCE = "src";
1947
-
1948
- /**
1949
- * @public
1950
- */
1951
- declare type SourceEventDetail = SourceObj;
1952
-
1953
- /**
1954
- * @public
1955
- */
1956
- declare type SourceObj<T = unknown> = {
1957
- src?: SourceStr;
1958
- /**
1959
- * the MIME type (example `video/mp4` or `application/x-mpegurl`)
1960
- */
1961
- type?: string;
1962
- } & T;
1963
-
1964
- /**
1965
- * @public
1966
- */
1967
- declare type SourceStr = string;
1968
-
1969
- /**
1970
- * @public
1971
- */
1972
- declare type SourceWith<T> = SourceObj & T;
1973
-
1974
- /**
1975
- * the stable release for our Chromecast Receiver application
1976
- */
1977
- declare const STABLE = "940D4BE4";
1978
-
1979
- /**
1980
- * @public
1981
- * emitted to handle playback related errors
1982
- */
1983
- declare const /**
1984
- @public
1985
- * when a new player is inserted into the HTML
1986
- */ /**
1987
- * @public
1988
- * emitted to handle playback related errors
1989
- */
1990
- STANDARD_ERROR = "flowplayer:error";
1991
-
1992
- declare const STARTING = "is-starting";
1993
-
1994
- /* Excluded from this release type: STATE */
1995
-
1996
- /* Excluded from this release type: StateEventDetail */
1997
-
1998
- declare namespace states {
1999
- export {
2000
- PLAYING,
2001
- FULLSCREEN,
2002
- PAUSED,
2003
- MUTED,
2004
- LOADED,
2005
- LOADING,
2006
- STARTING,
2007
- SEEKING,
2008
- GRABBING,
2009
- DISABLED,
2010
- SMALL,
2011
- TINY,
2012
- RTL,
2013
- TV,
2014
- ENDED,
2015
- LIVE_2 as LIVE,
2016
- ERRORED,
2017
- WAITING,
2018
- AUTOPLAY,
2019
- SEAMLESS,
2020
- TOGGLING,
2021
- LIVE_SEEKED,
2022
- NO_DVR,
2023
- HAS_POSTER,
2024
- WILL_PLAY,
2025
- WILL_PAUSE,
2026
- MENU_OPENED,
2027
- TOUCHED,
2028
- HOVERED,
2029
- TOUCH_DEVICE,
2030
- WILL_SEEK,
2031
- SEEKABLE,
2032
- IN_VIEWPORT,
2033
- NO_CONTROLS,
2034
- DESTROYED,
2035
- IS_SOURCE_PROCESSING
2036
- }
2037
- }
2038
-
2039
- /**
2040
- * @public
2041
- */
2042
- declare const /**
2043
- @public
2044
- * when a new player is inserted into the HTML
2045
- */ /**
2046
- * @public
2047
- */
2048
- TIME_UPDATE = "timeupdate";
2049
-
2050
- declare const TINY = "is-tiny";
2051
-
2052
- declare const TOGGLING = "is-toggling";
2053
-
2054
- /**
2055
- * @public
2056
- */
2057
- declare const /**
2058
- @public
2059
- * when a new player is inserted into the HTML
2060
- */ /**
2061
- * @public
2062
- */
2063
- TOUCH_CANCEL = "touchcancel";
2064
-
2065
- declare const TOUCH_DEVICE = "is-touch-device";
2066
-
2067
- /**
2068
- * @public
2069
- */
2070
- declare const /**
2071
- @public
2072
- * when a new player is inserted into the HTML
2073
- */ /**
2074
- * @public
2075
- */
2076
- TOUCH_END = "touchend";
2077
-
2078
- /**
2079
- * @public
2080
- */
2081
- declare const /**
2082
- @public
2083
- * when a new player is inserted into the HTML
2084
- */ /**
2085
- * @public
2086
- */
2087
- TOUCH_MOVE = "touchmove";
2088
-
2089
- /**
2090
- * @public
2091
- */
2092
- declare const /**
2093
- @public
2094
- * when a new player is inserted into the HTML
2095
- */ /**
2096
- * @public
2097
- */
2098
- TOUCH_START = "touchstart";
2099
-
2100
- declare const TOUCHED = "is-touched";
2101
-
2102
- /**
2103
- * @public
2104
- * All possible full paths to each translation, i.e. "core.mute"| "core.play" | "ads.ad" etc.
2105
- * This type is useful for developers using translation querying based on path, like in lodash's get()
2106
- */
2107
- declare type TranslationKey = Paths<Translation, {
2108
- leavesOnly: true;
2109
- }>;
2110
-
2111
- declare type TSampleRate = typeof SampleRate;
2112
-
2113
- declare const TV = "is-tv";
2114
-
2115
- /**
2116
- * @public
2117
- */
2118
- declare type UnsafeSource<SrcMixin = unknown> = SourceStr | SourceObj<SrcMixin> | Array<SourceStr | SourceObj<SrcMixin>>;
2119
-
2120
- declare type ValidSampleRate = TSampleRate[keyof TSampleRate];
2121
-
2122
- /**
2123
- * @public
2124
- * emitted when a video track is selected
2125
- */
2126
- declare const /**
2127
- @public
2128
- * when a new player is inserted into the HTML
2129
- */ /**
2130
- * @public
2131
- * emitted when a video track is selected
2132
- */
2133
- VIDEO_TRACK_SELECT = "tracks:video:select";
2134
-
2135
- /**
2136
- * @public
2137
- * emitted whenever multiple video tracks are detected
2138
- */
2139
- declare const /**
2140
- @public
2141
- * when a new player is inserted into the HTML
2142
- */ /**
2143
- * @public
2144
- * emitted whenever multiple video tracks are detected
2145
- */
2146
- VIDEO_TRACKS = "videoTracks";
2147
-
2148
- declare const videoSegmentFormat: {
2149
- readonly FMP4: "fmp4";
2150
- readonly MPEG2_TS: "mpeg2_ts";
2151
- };
2152
-
2153
- /**
2154
- * @public
2155
- * when a player enters the viewpoint
2156
- */
2157
- declare const /**
2158
- @public
2159
- * when a new player is inserted into the HTML
2160
- */ /**
2161
- * @public
2162
- * when a player enters the viewpoint
2163
- */
2164
- VIEW_ENTER = "viewenter";
2165
-
2166
- /**
2167
- * @public
2168
- * when a player leaves the viewport
2169
- */
2170
- declare const /**
2171
- @public
2172
- * when a new player is inserted into the HTML
2173
- */ /**
2174
- * @public
2175
- * when a player leaves the viewport
2176
- */
2177
- VIEW_LEAVE = "viewleave";
2178
-
2179
- /**
2180
- * @public
2181
- */
2182
- declare type ViewEnterEventDetail = null;
2183
-
2184
- /**
2185
- * @public
2186
- */
2187
- declare type ViewLeaveEventDetail = null;
2188
-
2189
- /**
2190
- * @public
2191
- */
2192
- declare const /**
2193
- @public
2194
- * when a new player is inserted into the HTML
2195
- */ /**
2196
- * @public
2197
- */
2198
- VOLUME_CHANGE = "volumechange";
2199
-
2200
- declare const WAITING = "is-waiting";
2201
-
2202
- /**
2203
- * @public
2204
- */
2205
- declare const /**
2206
- @public
2207
- * when a new player is inserted into the HTML
2208
- */ /**
2209
- * @public
2210
- */
2211
- WAITING_2 = "waiting";
2212
-
2213
- /* Excluded from this release type: WEBKIT_NEEDKEY */
2214
-
2215
- declare const WILL_PAUSE = "will-pause";
2216
-
2217
- declare const WILL_PLAY = "will-play";
2218
-
2219
- declare const WILL_SEEK = "will-seek";
2220
-
2221
- export { }