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