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