@flowplayer/player 3.34.3 → 3.35.0-rc

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