@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,2205 @@
1
+ import type { Get } from 'type-fest';
2
+ import type { Level } from 'hls.js';
3
+ import type { Paths } from 'type-fest';
4
+ import type { Representation } from 'dashjs';
5
+ import type { Translation } from '@flowplayer/translations';
6
+ import type { TupleToUnion } from 'type-fest';
7
+
8
+ /* Excluded from this release type: AnyLoader */
9
+
10
+ declare type ArrayToIntersection<T extends Array<unknown>> = T extends [
11
+ infer Current,
12
+ ...infer Remaining
13
+ ] ? Current & ArrayToIntersection<Remaining> : unknown;
14
+
15
+ /**
16
+ * Each loader must
17
+ */
18
+ declare type _AttachedEventCheck = {
19
+ on(event: `${string}:attached`, handler: (e: FPEvent<unknown>) => void): Player;
20
+ };
21
+
22
+ /* Excluded from this release type: AUDIO_ONLY_SOURCE */
23
+
24
+ /* Excluded from this release type: AudioOnlySourceEventDetail */
25
+
26
+ declare const AUTOPLAY = "is-autoplay";
27
+
28
+ /**
29
+ * @public
30
+ */
31
+ declare type Autoplay = BitOpts | boolean;
32
+
33
+ declare enum AutoplayOpts {
34
+ OFF = 0,
35
+ ON = 1,
36
+ AUDIO_REQUIRED = 2
37
+ }
38
+
39
+ /* Excluded from this release type: BEFORE_PAUSE */
40
+
41
+ /* Excluded from this release type: BEFORE_PLAY */
42
+
43
+ /**
44
+ * @public
45
+ */
46
+ declare type BeforePauseEventDetail = {
47
+ forced: boolean;
48
+ };
49
+
50
+ /**
51
+ * @public
52
+ */
53
+ declare type BeforePlayEventDetail = {
54
+ forced: boolean;
55
+ };
56
+
57
+ /**
58
+ * @public
59
+ */
60
+ declare type BitOpts = number;
61
+
62
+ /**
63
+ * @public
64
+ */
65
+ declare const /**
66
+ @public
67
+ * when a new player is inserted into the HTML
68
+ */ /**
69
+ * @public
70
+ */
71
+ CAN_PLAY = "canplay";
72
+
73
+ /**
74
+ * @public
75
+ */
76
+ declare const /**
77
+ @public
78
+ * when a new player is inserted into the HTML
79
+ */ /**
80
+ * @public
81
+ */
82
+ CLICK = "click";
83
+
84
+ /**
85
+ * For plugins that add new properties to all source types, combine their src-mixins into one SourceObject
86
+ * @example
87
+ * ```
88
+ * type Combined = CombineGlobalSrcExtensions<DRMPlugin, PluginWithFooFieldInSrc> // Combined = SourceObject<DRMConfig & FooFieldConfig>
89
+ * ```
90
+ */
91
+ declare type CombineGlobalSrcExtensions<PluginSrcs extends unknown[]> = HasGlobalSrcExtensios<PluginSrcs> extends false ? SourceObj : SourceObj & ArrayToIntersection<PickGlobalSrcExtension<PluginSrcs>>;
92
+
93
+ /**
94
+ * For plugins that define a new src type, make a union of all new src.type declarations
95
+ * @example
96
+ * ```
97
+ * type Combined = CombineNewSourceTypes<RTSPlugin, SSAIPlugin> // Combined = DRMConfig | FooFieldConfig
98
+ * ```
99
+ */
100
+ declare type CombineNewSourceTypes<PluginSrcs extends unknown[]> = TupleToUnion<FilterNewSourceTypes<PluginSrcs>>;
101
+
102
+ declare type CombineSrc<PluginSrcs extends unknown[]> = UnsafeSource<CombineGlobalSrcExtensions<PluginSrcs> | (CombineNewSourceTypes<PluginSrcs> & CombineGlobalSrcExtensions<PluginSrcs>)>;
103
+
104
+ /* Excluded from this release type: Component */
105
+
106
+ /* Excluded from this release type: Components */
107
+
108
+ /* Excluded from this release type: CONFIG */
109
+
110
+ /**
111
+ * @public
112
+ */
113
+ declare interface Config {
114
+ src?: UnsafeSource;
115
+ preload?: "none" | "metadata" | "auto";
116
+ controls?: boolean;
117
+ lang?: string;
118
+ start_time?: number;
119
+ autopause?: boolean;
120
+ rewind?: boolean;
121
+ loop?: boolean;
122
+ /**
123
+ * an access token for the media
124
+ * @public
125
+ */
126
+ playback_token?: string;
127
+ /* Excluded from this release type: seamless */
128
+ retry?: boolean;
129
+ autoplay?: Autoplay;
130
+ start_quality?: BitOpts;
131
+ live?: boolean;
132
+ poster?: string;
133
+ disabled?: boolean;
134
+ muted?: boolean;
135
+ /* Excluded from this release type: is_native */
136
+ /**
137
+ * bitflags for UI options
138
+ */
139
+ ui?: BitOpts;
140
+ /**
141
+ * your user access token
142
+ */
143
+ token?: string;
144
+ /* Excluded from this release type: duration */
145
+ /**
146
+ * can the content be seeked to any position
147
+ */
148
+ seekable?: boolean;
149
+ multiplay?: boolean;
150
+ ratio?: number | string;
151
+ logo?: string;
152
+ logo_href?: string;
153
+ logo_alt_text?: string;
154
+ title?: string;
155
+ description?: string;
156
+ /**
157
+ * the number of seconds to have in the buffer before dvr is activated
158
+ */
159
+ seconds_to_dvr?: number;
160
+ }
161
+
162
+ /* Excluded from this release type: ConfigEventDetail */
163
+
164
+ /**
165
+ * @public
166
+ */
167
+ declare type ConfigWith<T> = Config & T;
168
+
169
+ declare type ConfigWithSourceExtensions<PluginBareConfigs extends unknown[]> = Omit<ConfigWith<ArrayToIntersection<PluginBareConfigs>>, "src"> & {
170
+ src?: CombineSrc<PickSrcExtensions<PluginBareConfigs>>;
171
+ };
172
+
173
+ /* Excluded from this release type: CONTENT_REAL_LOAD_START */
174
+
175
+ /**
176
+ * @public
177
+ */
178
+ declare const /**
179
+ @public
180
+ * when a new player is inserted into the HTML
181
+ */ /**
182
+ * @public
183
+ */
184
+ CONTEXT_MENU = "contextmenu";
185
+
186
+ /**
187
+ * @public
188
+ */
189
+ declare type ContextMenuEventDetail = null;
190
+
191
+ /**
192
+ * @public
193
+ * @deprecated
194
+ * when a cuepoint becomes inactive
195
+ */
196
+ declare const /**
197
+ @public
198
+ * when a new player is inserted into the HTML
199
+ */ /**
200
+ * @public
201
+ * @deprecated
202
+ * when a cuepoint becomes inactive
203
+ */
204
+ CUEPOINT_END = "cuepointend";
205
+
206
+ /**
207
+ * @public
208
+ * @deprecated
209
+ * when a cuepoint is active
210
+ */
211
+ declare const /**
212
+ @public
213
+ * when a new player is inserted into the HTML
214
+ */ /**
215
+ * @public
216
+ * @deprecated
217
+ * when a cuepoint is active
218
+ */
219
+ CUEPOINT_START = "cuepointstart";
220
+
221
+ /**
222
+ * @public
223
+ * @deprecated
224
+ * cuepoints parsing is asynchronous
225
+ * you cannot rely on them existing until
226
+ * this event is emitted
227
+ */
228
+ declare const /**
229
+ @public
230
+ * when a new player is inserted into the HTML
231
+ */ /**
232
+ * @public
233
+ * @deprecated
234
+ * cuepoints parsing is asynchronous
235
+ * you cannot rely on them existing until
236
+ * this event is emitted
237
+ */
238
+ CUEPOINTS = "cuepoints";
239
+
240
+ /**
241
+ * @public
242
+ */
243
+ declare const /**
244
+ @public
245
+ * when a new player is inserted into the HTML
246
+ */ /**
247
+ * @public
248
+ */
249
+ DATA = "loadeddata";
250
+
251
+ /**
252
+ * @public
253
+ */
254
+ declare const /**
255
+ @public
256
+ * when a new player is inserted into the HTML
257
+ */ /**
258
+ * @public
259
+ */
260
+ DBL_CLICK = "dblclick";
261
+
262
+ declare const DESTROYED = "is-destroyed";
263
+
264
+ /* Excluded from this release type: DeviceId */
265
+
266
+ declare const DISABLED = "is-disabled";
267
+
268
+ /* Excluded from this release type: DISMISS_MESSAGE */
269
+
270
+ /**
271
+ * @public
272
+ */
273
+ declare const /**
274
+ @public
275
+ * when a new player is inserted into the HTML
276
+ */ /**
277
+ * @public
278
+ */
279
+ DURATION_CHANGE = "durationchange";
280
+
281
+ /**
282
+ * @public
283
+ * when the player has started playing dvr content
284
+ */
285
+ declare const /**
286
+ @public
287
+ * when a new player is inserted into the HTML
288
+ */ /**
289
+ * @public
290
+ * when the player has started playing dvr content
291
+ */
292
+ DVR = "dvr";
293
+
294
+ /**
295
+ * @public
296
+ */
297
+ declare type DvrEventDetail = number;
298
+
299
+ declare const ENDED = "is-ended";
300
+
301
+ /**
302
+ * @public
303
+ */
304
+ declare const /**
305
+ @public
306
+ * when a new player is inserted into the HTML
307
+ */ /**
308
+ * @public
309
+ */
310
+ ENDED_2 = "ended";
311
+
312
+ declare type EnsureOnAttached<P extends Function, T extends Player> = ExtractPureAPI<T> extends _AttachedEventCheck ? P : "Loaders must implement on('<pluginname>:attached') event";
313
+
314
+ /**
315
+ * @public
316
+ */
317
+ declare const /**
318
+ @public
319
+ * when a new player is inserted into the HTML
320
+ */ /**
321
+ * @public
322
+ */
323
+ ERROR = "error";
324
+
325
+ declare const ERRORED = "is-error";
326
+
327
+ declare namespace events {
328
+ export {
329
+ MOUNT,
330
+ RETRY,
331
+ ERROR,
332
+ CONTEXT_MENU,
333
+ CLICK,
334
+ DBL_CLICK,
335
+ KEYUP,
336
+ KEYDOWN,
337
+ LOAD,
338
+ MOUSE_ENTER,
339
+ MOUSE_LEAVE,
340
+ MOUSE_UP,
341
+ MOUSE_DOWN,
342
+ MOUSE_MOVE,
343
+ TOUCH_START,
344
+ TOUCH_MOVE,
345
+ TOUCH_END,
346
+ TOUCH_CANCEL,
347
+ RESIZE,
348
+ SCROLL,
349
+ FULLSCREEN_ENTER,
350
+ FULLSCREEN_EXIT,
351
+ FULLSCREEN_CHANGE,
352
+ METADATA,
353
+ DATA,
354
+ PROGRESS,
355
+ TIME_UPDATE,
356
+ LOAD_START,
357
+ VOLUME_CHANGE,
358
+ PAUSE,
359
+ PLAYING_2 as PLAYING,
360
+ PLAY,
361
+ WAITING_2 as WAITING,
362
+ CAN_PLAY,
363
+ ENDED_2 as ENDED,
364
+ SEEKED,
365
+ SEEKING_2 as SEEKING,
366
+ DURATION_CHANGE,
367
+ VIEW_ENTER,
368
+ VIEW_LEAVE,
369
+ SOURCE,
370
+ REAP,
371
+ QUALITIES,
372
+ QUALITY_CHANGE,
373
+ VIDEO_TRACKS,
374
+ SET_QUALITY,
375
+ VIDEO_TRACK_SELECT,
376
+ RECOMMENDATIONS_READY,
377
+ LANDSCAPE,
378
+ PORTRAIT,
379
+ DVR,
380
+ LIVE,
381
+ RECOVER,
382
+ CUEPOINTS,
383
+ CUEPOINT_START,
384
+ CUEPOINT_END,
385
+ STANDARD_ERROR
386
+ }
387
+ }
388
+
389
+ declare namespace events_2 {
390
+ export {
391
+ SHOW_MESSAGE
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
+ declare type JSONPlayer = any;
979
+
980
+ /**
981
+ * @public
982
+ */
983
+ declare const /**
984
+ @public
985
+ * when a new player is inserted into the HTML
986
+ */ /**
987
+ * @public
988
+ */
989
+ KEYDOWN = "keydown";
990
+
991
+ /**
992
+ * @public
993
+ */
994
+ declare const /**
995
+ @public
996
+ * when a new player is inserted into the HTML
997
+ */ /**
998
+ * @public
999
+ */
1000
+ KEYUP = "keyup";
1001
+
1002
+ /**
1003
+ * @public
1004
+ */
1005
+ declare type KeyValue = Record<string, any>;
1006
+
1007
+ /**
1008
+ * @public
1009
+ */
1010
+ declare const /**
1011
+ @public
1012
+ * when a new player is inserted into the HTML
1013
+ */ /**
1014
+ * @public
1015
+ */
1016
+ LANDSCAPE = "landscape";
1017
+
1018
+ /**
1019
+ * @public
1020
+ * when src is a livestream
1021
+ */
1022
+ declare const /**
1023
+ @public
1024
+ * when a new player is inserted into the HTML
1025
+ */ /**
1026
+ * @public
1027
+ * when src is a livestream
1028
+ */
1029
+ LIVE = "live";
1030
+
1031
+ declare const LIVE_2 = "is-live";
1032
+
1033
+ declare const LIVE_SEEKED = "is-live-seeked";
1034
+
1035
+ /**
1036
+ * @public
1037
+ */
1038
+ declare type LiveEventDetail = null;
1039
+
1040
+ /**
1041
+ * @public
1042
+ */
1043
+ declare const /**
1044
+ @public
1045
+ * when a new player is inserted into the HTML
1046
+ */ /**
1047
+ * @public
1048
+ */
1049
+ LOAD = "load";
1050
+
1051
+ /**
1052
+ * @public
1053
+ */
1054
+ declare const /**
1055
+ @public
1056
+ * when a new player is inserted into the HTML
1057
+ */ /**
1058
+ * @public
1059
+ */
1060
+ LOAD_START = "loadstart";
1061
+
1062
+ declare const LOADED = "is-loaded";
1063
+
1064
+ /**
1065
+ * @public A plugin that supports loading new media formats. Use 'class MyPlugin implements Loader\<...\>' when writing your custom Loader
1066
+ * @typeParam PluginPlayer- Player API that will be implemented by the loader. Loader at least must implement on(\<loader-name\>:attached, ...) event handler
1067
+ */
1068
+ declare interface Loader<PluginOwnConfig extends KeyValue, // FIXME extends Config
1069
+ PluginPlayer extends PlayerWith<_AttachedEventCheck>> extends Plugin_2<PluginOwnConfig, PluginPlayer> {
1070
+ onload: EnsureOnAttached<(config: ConfigWith<PluginOwnConfig>, root: PlayerRoot, video: PlayerWith<PluginPlayer>, src: SourceObj) => void, PluginPlayer>;
1071
+ wants<S = SourceObj>(srcString: SourceStr, srcObj: S, config: ConfigWith<PluginOwnConfig>): boolean;
1072
+ wants<S = KeyValue>(srcString: SourceStr, srcObj: SourceWith<S>, config: ConfigWith<PluginOwnConfig>): boolean;
1073
+ }
1074
+
1075
+ declare const LOADING = "is-loading";
1076
+
1077
+ declare type MapToBareConfigs<Plugins extends PluginCtor[]> = {
1078
+ [PluginType in keyof Plugins]: ExtractBareConfig<Plugins[PluginType]>;
1079
+ };
1080
+
1081
+ declare type MapToPlayerExtensions<Plugins extends PluginCtor[]> = {
1082
+ [PluginIndex in keyof Plugins]: ExtractPluginPlayerExtension<Plugins[PluginIndex]>;
1083
+ };
1084
+
1085
+ declare const MENU_OPENED = "has-menu-opened";
1086
+
1087
+ /**
1088
+ * Combines plugin config and returns a type derived from Config
1089
+ */
1090
+ declare type MergeConfigs<Plugins extends PluginCtor[]> = MergePluginConfigs<MapToBareConfigs<Plugins>>;
1091
+
1092
+ declare type MergePlayerExtensions<Plugins extends PluginCtor[]> = ArrayToIntersection<MapToPlayerExtensions<Plugins>>;
1093
+
1094
+ declare type MergePluginConfigs<PluginBareConfigs extends unknown[]> = HasSrcExtensions<PluginBareConfigs> extends true ? ConfigWithSourceExtensions<PluginBareConfigs> : ConfigWith<ArrayToIntersection<PluginBareConfigs>>;
1095
+
1096
+ /**
1097
+ * @public
1098
+ * This plugin allows you to send overlay messages to the player.
1099
+ * See {@link https://developer.wowza.com/docs/wowza-flowplayer/plugins/message-overlays/ | Official Documentation}
1100
+ */
1101
+ declare const Message: PluginCtor<NoInfer<Config>, NoInfer<MessagePlayer>> & NoInfer<MessageAPI>;
1102
+ export default Message;
1103
+
1104
+ /**
1105
+ * @public
1106
+ */
1107
+ declare type MessageAPI = {
1108
+ events: MessageEvents;
1109
+ };
1110
+
1111
+ declare type MessageEventDetail = {
1112
+ /**
1113
+ * Message to be displayed. The message is dismissed after 3 seconds.
1114
+ */
1115
+ message: string;
1116
+ /**
1117
+ * Message will remain visible for full player life cycle.
1118
+ * @defaultValue false
1119
+ */
1120
+ sticky?: boolean;
1121
+ /**
1122
+ * Time, in milliseconds, the message will stay visible before fading out, unless `sticky: true` is set
1123
+ * @defaultValue 3000
1124
+ */
1125
+ timeout?: number;
1126
+ };
1127
+
1128
+ /**
1129
+ * @public
1130
+ */
1131
+ declare type MessageEvents = typeof events_2;
1132
+
1133
+ /**
1134
+ * @public
1135
+ */
1136
+ declare type MessagePlayer = PlayerWith<{
1137
+ /**
1138
+ * @public
1139
+ * Emit this event to display a message
1140
+ * @param data - message text and behaviour
1141
+ **/
1142
+ emit(event: MessageEvents["SHOW_MESSAGE"], data?: MessageEventDetail): Player;
1143
+ /* Excluded from this release type: emit */
1144
+ /* Excluded from this release type: on */
1145
+ /* Excluded from this release type: on */
1146
+ }>;
1147
+
1148
+ /**
1149
+ * @public
1150
+ * general video events flowplayer uses internally
1151
+ * https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events
1152
+ */
1153
+ declare const /**
1154
+ @public
1155
+ * when a new player is inserted into the HTML
1156
+ */ /**
1157
+ * @public
1158
+ * general video events flowplayer uses internally
1159
+ * https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events
1160
+ */
1161
+ METADATA = "loadedmetadata";
1162
+
1163
+ /**
1164
+ @public
1165
+ * when a new player is inserted into the HTML
1166
+ */
1167
+ declare const /**
1168
+ @public
1169
+ * when a new player is inserted into the HTML
1170
+ */ /**
1171
+ @public
1172
+ * when a new player is inserted into the HTML
1173
+ */ MOUNT = "mount";
1174
+
1175
+ /**
1176
+ * @public
1177
+ */
1178
+ declare type MountEventDetail = null;
1179
+
1180
+ /**
1181
+ * @public
1182
+ */
1183
+ declare const /**
1184
+ @public
1185
+ * when a new player is inserted into the HTML
1186
+ */ /**
1187
+ * @public
1188
+ */
1189
+ MOUSE_DOWN = "mousedown";
1190
+
1191
+ /**
1192
+ * @public
1193
+ */
1194
+ declare const /**
1195
+ @public
1196
+ * when a new player is inserted into the HTML
1197
+ */ /**
1198
+ * @public
1199
+ */
1200
+ MOUSE_ENTER = "mouseenter";
1201
+
1202
+ /**
1203
+ * @public
1204
+ */
1205
+ declare const /**
1206
+ @public
1207
+ * when a new player is inserted into the HTML
1208
+ */ /**
1209
+ * @public
1210
+ */
1211
+ MOUSE_LEAVE = "mouseleave";
1212
+
1213
+ /**
1214
+ * @public
1215
+ */
1216
+ declare const /**
1217
+ @public
1218
+ * when a new player is inserted into the HTML
1219
+ */ /**
1220
+ * @public
1221
+ */
1222
+ MOUSE_MOVE = "mousemove";
1223
+
1224
+ /**
1225
+ * @public
1226
+ */
1227
+ declare const /**
1228
+ @public
1229
+ * when a new player is inserted into the HTML
1230
+ */ /**
1231
+ * @public
1232
+ */
1233
+ MOUSE_UP = "mouseup";
1234
+
1235
+ declare const MUTED = "is-muted";
1236
+
1237
+ declare const NO_CONTROLS = "no-controls";
1238
+
1239
+ declare const NO_DVR = "no-timeline";
1240
+
1241
+ /* Excluded from this release type: NON_RECOVERABLE_ERROR */
1242
+
1243
+ /* Excluded from this release type: NonRecoverableErrorEventDetail */
1244
+
1245
+ /* Excluded from this release type: NQState */
1246
+
1247
+ /**
1248
+ * @public
1249
+ */
1250
+ declare type OVPMetadata = {
1251
+ player_id?: string;
1252
+ media_id?: string;
1253
+ ad_keywords?: string;
1254
+ title?: string;
1255
+ description?: string;
1256
+ category_name?: string;
1257
+ duration?: number;
1258
+ tags?: string;
1259
+ };
1260
+
1261
+ /**
1262
+ * @public
1263
+ */
1264
+ declare const /**
1265
+ @public
1266
+ * when a new player is inserted into the HTML
1267
+ */ /**
1268
+ * @public
1269
+ */
1270
+ PAUSE = "pause";
1271
+
1272
+ declare const PAUSED = "is-paused";
1273
+
1274
+ declare type PickGlobalSrcExtension<PluginSrcs extends unknown[]> = {
1275
+ [Index in keyof PluginSrcs]: PluginSrcs[Index] extends {
1276
+ type: string;
1277
+ } ? unknown : PluginSrcs[Index];
1278
+ };
1279
+
1280
+ /**
1281
+ * Maps incoming array to the src extension type
1282
+ * @example
1283
+ * ```
1284
+ * PickSrcExtensions<[
1285
+ * {configProp: boolean, src: UnsafeSource<{srcProp: boolean}>},
1286
+ * {}
1287
+ * ]> // = [{srcProp: boolean}, never]
1288
+ * ```
1289
+ */
1290
+ declare type PickSrcExtensions<PluginBareConfigs extends unknown[]> = {
1291
+ [PluginType in keyof PluginBareConfigs]: ExtractSrcExtension<PluginBareConfigs[PluginType]>;
1292
+ };
1293
+
1294
+ /**
1295
+ * @public
1296
+ */
1297
+ declare const /**
1298
+ @public
1299
+ * when a new player is inserted into the HTML
1300
+ */ /**
1301
+ * @public
1302
+ */
1303
+ PLAY = "play";
1304
+
1305
+ /**
1306
+ * @public
1307
+ */
1308
+ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
1309
+ /* Excluded from this release type: renderPlugin */
1310
+ /**
1311
+ * Disables and enables the player.
1312
+ * @param flag -Forces disabled mode (true) or enabled mode (false). Disabled player cannot be seeked forward.
1313
+ */
1314
+ toggleDisable: (flag?: boolean) => void;
1315
+ /* Excluded from this release type: original_src */
1316
+ /**
1317
+ * The root element of the video player. This is the immediate parent element of the video tag.
1318
+ */
1319
+ root: PlayerRoot;
1320
+ /* Excluded from this release type: playerState */
1321
+ /* Excluded from this release type: reaper */
1322
+ /* Excluded from this release type: hasState */
1323
+ /* Excluded from this release type: transitionState */
1324
+ /**
1325
+ * Toggles between playing and paused mode.
1326
+ * @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.
1327
+ */
1328
+ togglePlay(on?: boolean): Promise<void>;
1329
+ /* Excluded from this release type: toggleFullScreen */
1330
+ /**
1331
+ * @public
1332
+ * Toggles between normal and fullscreen mode. The optional flag attribute forces the normal sized (false) or fullscreen (false) mode.
1333
+ * The custom fullscreenenter and fullscreenexit events are sent respectively.
1334
+ */
1335
+ toggleFullScreen(on?: boolean): void;
1336
+ /* Excluded from this release type: toggleMute */
1337
+ /**
1338
+ * Toggles between muted and original volume level.
1339
+ */
1340
+ toggleMute(): void;
1341
+ /**
1342
+ * Removes a Flowplayer instance from `flowplayer.instances` and emits the `flowplayer.events.REAP` event, enabling cleanup of unsafe resources.
1343
+ */
1344
+ destroy(): void;
1345
+ /* Excluded from this release type: render */
1346
+ /* Excluded from this release type: render */
1347
+ createComponents(...args: string[]): HTMLElement[];
1348
+ /**
1349
+ * Adds or changes configuration object. Usually used in conjunction with `setSrc()`. You can use all top-level config options like `subtitle:` , `logo:`, `ima:` etc.
1350
+ * @example
1351
+ * ```
1352
+ * setOpts({
1353
+ * subtitles:{
1354
+ * tracks:[
1355
+ * {
1356
+ * src: "1.vtt",
1357
+ * label: "English",
1358
+ * default: true
1359
+ * }, {
1360
+ * src: "2.vtt",
1361
+ * label: "Spanish",
1362
+ * default : false }]},
1363
+ * logo: "https://myserver.com/logo.png"
1364
+ * })
1365
+ * ```
1366
+ */
1367
+ setOpts(config: Config): void;
1368
+ /**
1369
+ * Sets the video source to be played. The src attribute can be a string or an object similar to the src property.
1370
+ */
1371
+ setSrc(sources: UnsafeSource): void;
1372
+ /* Excluded from this release type: setSrc */
1373
+ /* Excluded from this release type: setAttrs */
1374
+ /* Excluded from this release type: opt */
1375
+ /* Excluded from this release type: enqueueSeek */
1376
+ /* Excluded from this release type: setState */
1377
+ setState(state: PlayerState, flag: boolean): void;
1378
+ /* Excluded from this release type: toJSON */
1379
+ /**
1380
+ * Adds a language to the project. See {@link https://developer.wowza.com/docs/wowza-flowplayer/player/translations/#using-npm| Official documentation}
1381
+ */
1382
+ i18n(k: TranslationKey): string;
1383
+ i18n(k: string, fallback: string): string;
1384
+ /* Excluded from this release type: deviceId */
1385
+ /* Excluded from this release type: live_state */
1386
+ /**
1387
+ * A reference to the configuration state of the player.
1388
+ */
1389
+ opts: Config;
1390
+ /* Excluded from this release type: plugins */
1391
+ /* Excluded from this release type: dvr_offset */
1392
+ message?: {
1393
+ events: Record<string, string>;
1394
+ };
1395
+ /**
1396
+ * A boolean specifying whether the player is disabled and the user cannot seek forward using the mouse or keyboard.
1397
+ * Player is disabled and enabled with the `toggleDisable()` method.
1398
+ */
1399
+ disabled: boolean;
1400
+ /* Excluded from this release type: started */
1401
+ /* Excluded from this release type: token */
1402
+ /* Excluded from this release type: _customElements */
1403
+ /* Excluded from this release type: _storage */
1404
+ };
1405
+
1406
+ declare type PlayerCustomEventName = keyof PlayerCustomEventsDetailMap;
1407
+
1408
+ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap & {
1409
+ [REAP]: ReapEventDetail;
1410
+ [SOURCE]: SourceEventDetail;
1411
+ [MOUNT]: MountEventDetail;
1412
+ [LIVE]: LiveEventDetail;
1413
+ [DVR]: DvrEventDetail;
1414
+ [RETRY]: RetryEventDetail;
1415
+ [RECOVER]: RecoverEventDetail;
1416
+ [QUALITIES]: QualitiesEventDetail;
1417
+ [QUALITY_CHANGE]: QualityChangeEventDetail;
1418
+ [STANDARD_ERROR]: FlowplayerErrorEventDetail;
1419
+ /* Excluded from this release type: audioonlysource */
1420
+ /* Excluded from this release type: renderplugin */
1421
+ /* Excluded from this release type: "seek:queued" */
1422
+ /* Excluded from this release type: "seek:cancel" */
1423
+ /* Excluded from this release type: "plugin:registered" */
1424
+ /* Excluded from this release type: intersectionchange */
1425
+ /* Excluded from this release type: "flowplayer:feature" */
1426
+ /* Excluded from this release type: beforeplay */
1427
+ /* Excluded from this release type: beforepause */
1428
+ /* Excluded from this release type: state */
1429
+ /* Excluded from this release type: config */
1430
+ /* Excluded from this release type: "error:fatal" */
1431
+ };
1432
+
1433
+ declare type PlayerCustomEventsOverloads = {
1434
+ /**
1435
+ * 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.
1436
+ */
1437
+ on(event: typeof MOUNT, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof MOUNT]>) => void): Player;
1438
+ /**
1439
+ * Sent when an error occurs. Learn more about error handling.
1440
+ */
1441
+ on(// FIXME - this event is in context-menu plugin
1442
+ event: typeof CONTEXT_MENU, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof CONTEXT_MENU]>) => void): Player;
1443
+ /* Excluded from this release type: on */
1444
+ /* Excluded from this release type: on */
1445
+ /* Excluded from this release type: on */
1446
+ /**
1447
+ * Sent when the player becomes visible for the user.
1448
+ */
1449
+ on(event: typeof VIEW_ENTER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof VIEW_ENTER]>) => void): Player;
1450
+ /**
1451
+ * Sent when the player leaves the users viewport and is longer visible.
1452
+ */
1453
+ on(event: typeof VIEW_LEAVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof VIEW_LEAVE]>) => void): Player;
1454
+ /**
1455
+ * Sent right before the player src attribute is set. This allows you to change the video URL before playback.
1456
+ */
1457
+ on(event: typeof SOURCE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof SOURCE]>) => void): Player;
1458
+ /**
1459
+ * Emitted when an Error recovery is attempted
1460
+ */
1461
+ on(event: typeof RECOVER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOVER]>) => void): Player;
1462
+ /**
1463
+ * 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.
1464
+ */
1465
+ on(event: typeof REAP, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof REAP]>) => void): Player;
1466
+ /**
1467
+ * Emitted when a player will retry to reload
1468
+ */
1469
+ on(event: typeof RETRY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RETRY]>) => void): Player;
1470
+ /* Excluded from this release type: on */
1471
+ /**
1472
+ * Emitted when the set of underlying qualities has changed.
1473
+ */
1474
+ on(event: typeof QUALITIES, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITIES]>) => void): Player;
1475
+ /**
1476
+ * Emitted when the media changes quality.
1477
+ */
1478
+ on(event: typeof QUALITY_CHANGE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof QUALITY_CHANGE]>) => void): Player;
1479
+ /**
1480
+ * Emitted when a standard FlowplayerError is encountered
1481
+ */
1482
+ on(event: typeof STANDARD_ERROR, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof STANDARD_ERROR]>) => void): Player;
1483
+ /* Excluded from this release type: on */
1484
+ /**
1485
+ * Listen to this event to create a recommendations grid using the data passed with the event.
1486
+ */
1487
+ on(event: typeof RECOMMENDATIONS_READY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOMMENDATIONS_READY]>) => void): Player;
1488
+ /* Excluded from this release type: on */
1489
+ /* Excluded from this release type: on */
1490
+ /**
1491
+ * when the player has started playing dvr content
1492
+ */
1493
+ on(event: typeof DVR, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof DVR]>) => void): Player;
1494
+ /**
1495
+ * when src is a livestream
1496
+ */
1497
+ on(event: typeof LIVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE]>) => void): Player;
1498
+ /* Excluded from this release type: on */
1499
+ /* Excluded from this release type: on */
1500
+ /* Excluded from this release type: on */
1501
+ /* Excluded from this release type: on */
1502
+ /* Excluded from this release type: on */
1503
+ /* Excluded from this release type: on */
1504
+ /**
1505
+ * TODO: this is a workaround, since not all event overloads are typed. when all plugin work is finished, remove this
1506
+ * https://wowzamedia.jira.com/browse/PLAY-653
1507
+ */
1508
+ on<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1509
+ /* Excluded from this release type: on */
1510
+ /**
1511
+ * Same as `on()`, but the handler function is executed only once.
1512
+ */
1513
+ once<T extends PlayerCustomEventName>(event: T, handler: (e: FPEvent<PlayerCustomEventsDetailMap[T]>) => void): Player;
1514
+ /**
1515
+ * Same as `on()`, but the handler function is executed only once.
1516
+ */
1517
+ once<T extends PlayerNativeEventName>(event: T, handler: (e: PlayerNativeEventsDetailMap[T]) => void): Player;
1518
+ once<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1519
+ /**
1520
+ * Removes the event handler with the specified event type.
1521
+ */
1522
+ off<T extends PlayerCustomEventName>(event: T, handler: (e: FPEvent<PlayerCustomEventsDetailMap[T]>) => void): Player;
1523
+ /**
1524
+ * Removes the event handler with the specified event type.
1525
+ */
1526
+ off<T extends PlayerNativeEventName>(event: T, handler: (e: PlayerNativeEventsDetailMap[T]) => void): Player;
1527
+ /**
1528
+ * Removes the event handler with the specified event type.
1529
+ */
1530
+ off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1531
+ /* Excluded from this release type: poll */
1532
+ emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1533
+ emit(event: never, data?: never): Player;
1534
+ /* Excluded from this release type: emit */
1535
+ /* Excluded from this release type: emit */
1536
+ };
1537
+
1538
+ declare type PlayerEmittableCustomEventsDetailMap = {
1539
+ [CONTEXT_MENU]: ContextMenuEventDetail;
1540
+ [VIEW_ENTER]: ViewEnterEventDetail;
1541
+ [VIEW_LEAVE]: ViewLeaveEventDetail;
1542
+ [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
1543
+ };
1544
+
1545
+ declare type PlayerEmittableEventNames = keyof PlayerEmittableCustomEventsDetailMap;
1546
+
1547
+ /**
1548
+ * @public
1549
+ */
1550
+ declare type PlayerEventOverloads = PlayerNativeEventsOverloads & PlayerCustomEventsOverloads;
1551
+
1552
+ declare type PlayerNativeEventName = keyof PlayerNativeEventsDetailMap;
1553
+
1554
+ declare type PlayerNativeEventsDetailMap = HTMLVideoElementEventMap;
1555
+
1556
+ declare type PlayerNativeEventsOverloads = {
1557
+ on<K extends keyof PlayerNativeEventsDetailMap>(event: K, handler: (ev: PlayerNativeEventsDetailMap[K]) => void): Player;
1558
+ };
1559
+
1560
+ /**
1561
+ * @public
1562
+ * The root element of the video player. This is the immediate parent element of the video tag.
1563
+ */
1564
+ declare type PlayerRoot = HTMLElement & {
1565
+ /* Excluded from this release type: prevWidth */
1566
+ };
1567
+
1568
+ /**
1569
+ * @public
1570
+ */
1571
+ declare type PlayerState = FlowplayerStates[keyof FlowplayerStates];
1572
+
1573
+ /* Excluded from this release type: _PlayerState */
1574
+
1575
+ /* Excluded from this release type: PlayerStates */
1576
+
1577
+ /**
1578
+ * @public
1579
+ */
1580
+ declare type PlayerWith<T> = T & Player;
1581
+
1582
+ declare type PlayerWithOpts<PluginPlayer extends Player = Player, PluginConfig extends Config = Config> = {
1583
+ /* Excluded from this release type: on */
1584
+ } & Omit<PluginPlayer, "opts" | "setOpts"> & {
1585
+ opts: PluginConfig;
1586
+ setOpts: (config: PluginConfig) => void;
1587
+ };
1588
+
1589
+ declare const PLAYING = "is-playing";
1590
+
1591
+ /**
1592
+ * @public
1593
+ */
1594
+ declare const /**
1595
+ @public
1596
+ * when a new player is inserted into the HTML
1597
+ */ /**
1598
+ * @public
1599
+ */
1600
+ PLAYING_2 = "playing";
1601
+
1602
+ /**
1603
+ * @public
1604
+ */
1605
+ declare interface Plugin_2<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
1606
+ /**
1607
+ * a plugin must always implement the init method so a player instance knows how to initialize it
1608
+ */
1609
+ init(config: PluginConfig, container: PlayerRoot, player: PluginPlayer): void;
1610
+ }
1611
+
1612
+ /* Excluded from this release type: PLUGIN_REGISTERED */
1613
+
1614
+ /**
1615
+ * @public
1616
+ */
1617
+ declare interface PluginCtor<PluginConfig extends Config = Config, PluginPlayer extends Player = Player> {
1618
+ new (umd: FlowplayerUMD, player: Player): Plugin_2<PluginConfig, PluginPlayer>;
1619
+ pluginName: string;
1620
+ }
1621
+
1622
+ /* Excluded from this release type: PluginRegisteredEventDetail */
1623
+
1624
+ declare type PluginStates = string;
1625
+
1626
+ /**
1627
+ * @public
1628
+ */
1629
+ declare const /**
1630
+ @public
1631
+ * when a new player is inserted into the HTML
1632
+ */ /**
1633
+ * @public
1634
+ */
1635
+ PORTRAIT = "portrait";
1636
+
1637
+ /**
1638
+ * @public
1639
+ */
1640
+ declare const /**
1641
+ @public
1642
+ * when a new player is inserted into the HTML
1643
+ */ /**
1644
+ * @public
1645
+ */
1646
+ PROGRESS = "progress";
1647
+
1648
+ /**
1649
+ * @public
1650
+ */
1651
+ declare type QselOption = (Level & {
1652
+ level: number;
1653
+ }) | Representation | {
1654
+ name: string | number;
1655
+ encodingId: string;
1656
+ spatialLayerId: number;
1657
+ temporalLayerId: number;
1658
+ maxSpatialLayerId: number;
1659
+ maxTemporalLayerId: number;
1660
+ height: number;
1661
+ width: number;
1662
+ };
1663
+
1664
+ /**
1665
+ * @public
1666
+ * emitted whenever a list of qualities has been made available
1667
+ * when index 0 is the highest quality and index 0+N is the lowest
1668
+ */
1669
+ declare const /**
1670
+ @public
1671
+ * when a new player is inserted into the HTML
1672
+ */ /**
1673
+ * @public
1674
+ * emitted whenever a list of qualities has been made available
1675
+ * when index 0 is the highest quality and index 0+N is the lowest
1676
+ */
1677
+ QUALITIES = "qualities";
1678
+
1679
+ /**
1680
+ * @public
1681
+ */
1682
+ declare type QualitiesEventDetail = QselOption[];
1683
+
1684
+ /**
1685
+ * @public
1686
+ * emitted whenever the media changes quality
1687
+ */
1688
+ declare const /**
1689
+ @public
1690
+ * when a new player is inserted into the HTML
1691
+ */ /**
1692
+ * @public
1693
+ * emitted whenever the media changes quality
1694
+ */
1695
+ QUALITY_CHANGE = "qualitychange";
1696
+
1697
+ /**
1698
+ * @public
1699
+ */
1700
+ declare type QualityChangeEventDetail = {
1701
+ before?: (Level & {
1702
+ level?: number;
1703
+ }) | Representation;
1704
+ after: (Level & {
1705
+ level?: number;
1706
+ }) | Representation;
1707
+ plugin: string;
1708
+ automatic: boolean;
1709
+ /* Excluded from this release type: downscale */
1710
+ };
1711
+
1712
+ declare enum QualityOpts {
1713
+ LOW = 1,
1714
+ MEDIUM = 2,
1715
+ HIGH = 4
1716
+ }
1717
+
1718
+ /**
1719
+ * @public
1720
+ * emitted when it is safe to clean up a fp instance
1721
+ */
1722
+ declare const /**
1723
+ @public
1724
+ * when a new player is inserted into the HTML
1725
+ */ /**
1726
+ * @public
1727
+ * emitted when it is safe to clean up a fp instance
1728
+ */
1729
+ REAP = "reap";
1730
+
1731
+ /**
1732
+ * @public
1733
+ */
1734
+ declare type ReapEventDetail = null;
1735
+
1736
+ /**
1737
+ * @public
1738
+ */
1739
+ declare type RecommendationItem = {
1740
+ poster?: string;
1741
+ src?: UnsafeSource;
1742
+ title?: string;
1743
+ description?: string;
1744
+ metadata: OVPMetadata;
1745
+ chapters?: {
1746
+ src: string;
1747
+ };
1748
+ thumbnails?: {
1749
+ src: string;
1750
+ };
1751
+ subtitles?: string[];
1752
+ };
1753
+
1754
+ /**
1755
+ * @public
1756
+ */
1757
+ declare const /**
1758
+ @public
1759
+ * when a new player is inserted into the HTML
1760
+ */ /**
1761
+ * @deprecated please use Endscreen.events.RECOMMENDATIONS_READY / flowplayer.endscreen.events.RECOMMENDATIONS_READY
1762
+ **/
1763
+ /**
1764
+ * @public
1765
+ */
1766
+ RECOMMENDATIONS_READY = "recommendationsready";
1767
+
1768
+ /**
1769
+ * @public
1770
+ */
1771
+ declare type RecommendationsReadyEventDetail = {
1772
+ playlist: RecommendationItem[];
1773
+ };
1774
+
1775
+ /**
1776
+ * @public
1777
+ * emitted when an Error recovery is attempted
1778
+ */
1779
+ declare const /**
1780
+ @public
1781
+ * when a new player is inserted into the HTML
1782
+ */ /**
1783
+ * @public
1784
+ * emitted when an Error recovery is attempted
1785
+ */
1786
+ RECOVER = "recover";
1787
+
1788
+ /**
1789
+ * @public
1790
+ */
1791
+ declare type RecoverEventDetail = null;
1792
+
1793
+ /* Excluded from this release type: REMOTE_SESSION_ENDED */
1794
+
1795
+ /* Excluded from this release type: REMOTE_SESSION_STARTED */
1796
+
1797
+ /* Excluded from this release type: RENDER_PLUGIN */
1798
+
1799
+ /**
1800
+ * @public
1801
+ */
1802
+ declare type RenderPluginEventDetail = HTMLElement;
1803
+
1804
+ /**
1805
+ * @public
1806
+ */
1807
+ declare const /**
1808
+ @public
1809
+ * when a new player is inserted into the HTML
1810
+ */ /**
1811
+ * @public
1812
+ */
1813
+ RESIZE = "resize";
1814
+
1815
+ /**
1816
+ * @public
1817
+ */
1818
+ declare const /**
1819
+ @public
1820
+ * when a new player is inserted into the HTML
1821
+ */ /**
1822
+ * @public
1823
+ */
1824
+ RETRY = "retry";
1825
+
1826
+ /**
1827
+ * @public
1828
+ */
1829
+ declare type RetryEventDetail = FlowplayerErrorEventDetail;
1830
+
1831
+ declare const RetryMap: {
1832
+ readonly ON: "on";
1833
+ readonly WITHOUT_RECOVERY: "without_recovery";
1834
+ readonly OFF: "off";
1835
+ };
1836
+
1837
+ declare const RTL = "is-rtl";
1838
+
1839
+ declare const SampleRate: {
1840
+ /**
1841
+ * 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.
1842
+ */
1843
+ readonly All: 1;
1844
+ /**
1845
+ * for events we anticipate receive a lot of usage and maybe happen frequently per session
1846
+ */
1847
+ readonly High: 0.1;
1848
+ /**
1849
+ * for events that can happen quickly, but not in massive amounts
1850
+ */
1851
+ readonly Medium: 0.01;
1852
+ /**
1853
+ * for very high volume events where you only want to sample a low amount of them (think volumechange | timeupdate)
1854
+ */
1855
+ readonly Low: 0.001;
1856
+ /**
1857
+ * placeholder for never sampling something, useful in situations where we want to add code to sample, but maybe not turn it on just yet.
1858
+ */
1859
+ readonly None: 0;
1860
+ };
1861
+
1862
+ /**
1863
+ * @public
1864
+ */
1865
+ declare const /**
1866
+ @public
1867
+ * when a new player is inserted into the HTML
1868
+ */ /**
1869
+ * @public
1870
+ */
1871
+ SCROLL = "scroll";
1872
+
1873
+ declare const SEAMLESS = "is-seamless";
1874
+
1875
+ /* Excluded from this release type: SEEK_CANCEL */
1876
+
1877
+ /* Excluded from this release type: SEEK_QUEUED */
1878
+
1879
+ declare const SEEKABLE = "is-seekable";
1880
+
1881
+ /* Excluded from this release type: SeekCancelEventDetail */
1882
+
1883
+ /**
1884
+ * @public
1885
+ */
1886
+ declare const /**
1887
+ @public
1888
+ * when a new player is inserted into the HTML
1889
+ */ /**
1890
+ * @public
1891
+ */
1892
+ SEEKED = "seeked";
1893
+
1894
+ declare const SEEKING = "is-seeking";
1895
+
1896
+ /**
1897
+ * @public
1898
+ */
1899
+ declare const /**
1900
+ @public
1901
+ * when a new player is inserted into the HTML
1902
+ */ /**
1903
+ * @public
1904
+ */
1905
+ SEEKING_2 = "seeking";
1906
+
1907
+ /* Excluded from this release type: SeekQueuedEventDetail */
1908
+
1909
+ /**
1910
+ * @public
1911
+ * @deprecated please use Qsel.events.SET_QUALITY
1912
+ */
1913
+ declare const /**
1914
+ @public
1915
+ * when a new player is inserted into the HTML
1916
+ */ /**
1917
+ * @public
1918
+ * @deprecated please use Qsel.events.SET_QUALITY
1919
+ */
1920
+ SET_QUALITY = "quality:set";
1921
+
1922
+ /**
1923
+ * @public
1924
+ */
1925
+ declare const SHOW_MESSAGE = "message:show";
1926
+
1927
+ declare const SMALL = "is-small";
1928
+
1929
+ /**
1930
+ * @public
1931
+ * emitted when a valid source is found prior to mounting
1932
+ */
1933
+ declare const /**
1934
+ @public
1935
+ * when a new player is inserted into the HTML
1936
+ */ /**
1937
+ * @public
1938
+ * emitted when a valid source is found prior to mounting
1939
+ */
1940
+ SOURCE = "src";
1941
+
1942
+ /**
1943
+ * @public
1944
+ */
1945
+ declare type SourceEventDetail = SourceObj;
1946
+
1947
+ /**
1948
+ * @public
1949
+ */
1950
+ declare type SourceObj<T = unknown> = {
1951
+ src?: SourceStr;
1952
+ /**
1953
+ * the MIME type (example `video/mp4` or `application/x-mpegurl`)
1954
+ */
1955
+ type?: string;
1956
+ } & T;
1957
+
1958
+ /**
1959
+ * @public
1960
+ */
1961
+ declare type SourceStr = string;
1962
+
1963
+ /**
1964
+ * @public
1965
+ */
1966
+ declare type SourceWith<T> = SourceObj & T;
1967
+
1968
+ /**
1969
+ * @public
1970
+ * emitted to handle playback related errors
1971
+ */
1972
+ declare const /**
1973
+ @public
1974
+ * when a new player is inserted into the HTML
1975
+ */ /**
1976
+ * @public
1977
+ * emitted to handle playback related errors
1978
+ */
1979
+ STANDARD_ERROR = "flowplayer:error";
1980
+
1981
+ declare const STARTING = "is-starting";
1982
+
1983
+ /* Excluded from this release type: STATE */
1984
+
1985
+ /* Excluded from this release type: StateEventDetail */
1986
+
1987
+ declare namespace states {
1988
+ export {
1989
+ PLAYING,
1990
+ FULLSCREEN,
1991
+ PAUSED,
1992
+ MUTED,
1993
+ LOADED,
1994
+ LOADING,
1995
+ STARTING,
1996
+ SEEKING,
1997
+ GRABBING,
1998
+ DISABLED,
1999
+ SMALL,
2000
+ TINY,
2001
+ RTL,
2002
+ TV,
2003
+ ENDED,
2004
+ LIVE_2 as LIVE,
2005
+ ERRORED,
2006
+ WAITING,
2007
+ AUTOPLAY,
2008
+ SEAMLESS,
2009
+ TOGGLING,
2010
+ LIVE_SEEKED,
2011
+ NO_DVR,
2012
+ HAS_POSTER,
2013
+ WILL_PLAY,
2014
+ WILL_PAUSE,
2015
+ MENU_OPENED,
2016
+ TOUCHED,
2017
+ HOVERED,
2018
+ TOUCH_DEVICE,
2019
+ WILL_SEEK,
2020
+ SEEKABLE,
2021
+ IN_VIEWPORT,
2022
+ NO_CONTROLS,
2023
+ DESTROYED,
2024
+ IS_SOURCE_PROCESSING
2025
+ }
2026
+ }
2027
+
2028
+ /**
2029
+ * @public
2030
+ */
2031
+ declare const /**
2032
+ @public
2033
+ * when a new player is inserted into the HTML
2034
+ */ /**
2035
+ * @public
2036
+ */
2037
+ TIME_UPDATE = "timeupdate";
2038
+
2039
+ declare const TINY = "is-tiny";
2040
+
2041
+ declare const TOGGLING = "is-toggling";
2042
+
2043
+ /**
2044
+ * @public
2045
+ */
2046
+ declare const /**
2047
+ @public
2048
+ * when a new player is inserted into the HTML
2049
+ */ /**
2050
+ * @public
2051
+ */
2052
+ TOUCH_CANCEL = "touchcancel";
2053
+
2054
+ declare const TOUCH_DEVICE = "is-touch-device";
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_END = "touchend";
2066
+
2067
+ /**
2068
+ * @public
2069
+ */
2070
+ declare const /**
2071
+ @public
2072
+ * when a new player is inserted into the HTML
2073
+ */ /**
2074
+ * @public
2075
+ */
2076
+ TOUCH_MOVE = "touchmove";
2077
+
2078
+ /**
2079
+ * @public
2080
+ */
2081
+ declare const /**
2082
+ @public
2083
+ * when a new player is inserted into the HTML
2084
+ */ /**
2085
+ * @public
2086
+ */
2087
+ TOUCH_START = "touchstart";
2088
+
2089
+ declare const TOUCHED = "is-touched";
2090
+
2091
+ /**
2092
+ * @public
2093
+ * All possible full paths to each translation, i.e. "core.mute"| "core.play" | "ads.ad" etc.
2094
+ * This type is useful for developers using translation querying based on path, like in lodash's get()
2095
+ */
2096
+ declare type TranslationKey = Paths<Translation, {
2097
+ leavesOnly: true;
2098
+ }>;
2099
+
2100
+ declare type TSampleRate = typeof SampleRate;
2101
+
2102
+ declare const TV = "is-tv";
2103
+
2104
+ /**
2105
+ * @public
2106
+ */
2107
+ declare type UnsafeSource<SrcMixin = unknown> = SourceStr | SourceObj<SrcMixin> | Array<SourceStr | SourceObj<SrcMixin>>;
2108
+
2109
+ declare type ValidSampleRate = TSampleRate[keyof TSampleRate];
2110
+
2111
+ /**
2112
+ * @public
2113
+ * emitted when a video track is selected
2114
+ */
2115
+ declare const /**
2116
+ @public
2117
+ * when a new player is inserted into the HTML
2118
+ */ /**
2119
+ * @public
2120
+ * emitted when a video track is selected
2121
+ */
2122
+ VIDEO_TRACK_SELECT = "tracks:video:select";
2123
+
2124
+ /**
2125
+ * @public
2126
+ * emitted whenever multiple video tracks are detected
2127
+ */
2128
+ declare const /**
2129
+ @public
2130
+ * when a new player is inserted into the HTML
2131
+ */ /**
2132
+ * @public
2133
+ * emitted whenever multiple video tracks are detected
2134
+ */
2135
+ VIDEO_TRACKS = "videoTracks";
2136
+
2137
+ /**
2138
+ * @public
2139
+ * when a player enters the viewpoint
2140
+ */
2141
+ declare const /**
2142
+ @public
2143
+ * when a new player is inserted into the HTML
2144
+ */ /**
2145
+ * @public
2146
+ * when a player enters the viewpoint
2147
+ */
2148
+ VIEW_ENTER = "viewenter";
2149
+
2150
+ /**
2151
+ * @public
2152
+ * when a player leaves the viewport
2153
+ */
2154
+ declare const /**
2155
+ @public
2156
+ * when a new player is inserted into the HTML
2157
+ */ /**
2158
+ * @public
2159
+ * when a player leaves the viewport
2160
+ */
2161
+ VIEW_LEAVE = "viewleave";
2162
+
2163
+ /**
2164
+ * @public
2165
+ */
2166
+ declare type ViewEnterEventDetail = null;
2167
+
2168
+ /**
2169
+ * @public
2170
+ */
2171
+ declare type ViewLeaveEventDetail = null;
2172
+
2173
+ /**
2174
+ * @public
2175
+ */
2176
+ declare const /**
2177
+ @public
2178
+ * when a new player is inserted into the HTML
2179
+ */ /**
2180
+ * @public
2181
+ */
2182
+ VOLUME_CHANGE = "volumechange";
2183
+
2184
+ declare const WAITING = "is-waiting";
2185
+
2186
+ /**
2187
+ * @public
2188
+ */
2189
+ declare const /**
2190
+ @public
2191
+ * when a new player is inserted into the HTML
2192
+ */ /**
2193
+ * @public
2194
+ */
2195
+ WAITING_2 = "waiting";
2196
+
2197
+ /* Excluded from this release type: WEBKIT_NEEDKEY */
2198
+
2199
+ declare const WILL_PAUSE = "will-pause";
2200
+
2201
+ declare const WILL_PLAY = "will-play";
2202
+
2203
+ declare const WILL_SEEK = "will-seek";
2204
+
2205
+ export { }