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