@flowplayer/player 3.35.0-rc → 3.35.0

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