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