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