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