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