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