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