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