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