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