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