@flowplayer/player 3.15.0 → 3.16.0-rc

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 (58) hide show
  1. package/core/events.d.ts +22 -2
  2. package/core/events.js +50 -50
  3. package/core.js +1 -1
  4. package/default.js +1 -1
  5. package/embed.js +2 -2
  6. package/flowplayer.css +1 -1
  7. package/index.d.ts +78 -35
  8. package/package.json +1 -1
  9. package/plugins/ads.d.ts +76 -33
  10. package/plugins/ads.js +1 -1
  11. package/plugins/airplay.d.ts +77 -52
  12. package/plugins/analytics.d.ts +76 -33
  13. package/plugins/analytics.js +1 -1
  14. package/plugins/asel.d.ts +221 -36
  15. package/plugins/asel.js +1 -1
  16. package/plugins/audio.d.ts +76 -33
  17. package/plugins/chapters.d.ts +76 -33
  18. package/plugins/chromecast.d.ts +76 -33
  19. package/plugins/chromecast.js +1 -1
  20. package/plugins/comscore.d.ts +76 -33
  21. package/plugins/consent.d.ts +76 -33
  22. package/plugins/context-menu.d.ts +76 -33
  23. package/plugins/cuepoints.d.ts +76 -33
  24. package/plugins/dash.d.ts +77 -45
  25. package/plugins/dash.js +1 -1
  26. package/plugins/drm.d.ts +76 -33
  27. package/plugins/endscreen.d.ts +76 -33
  28. package/plugins/fas.d.ts +76 -33
  29. package/plugins/float-on-scroll.d.ts +76 -33
  30. package/plugins/ga4.d.ts +76 -33
  31. package/plugins/gemius.d.ts +76 -33
  32. package/plugins/google-analytics.d.ts +76 -33
  33. package/plugins/health.d.ts +76 -33
  34. package/plugins/health.js +1 -1
  35. package/plugins/hls.d.ts +76 -33
  36. package/plugins/hls.js +1 -1
  37. package/plugins/id3.d.ts +76 -33
  38. package/plugins/iframe.d.ts +76 -33
  39. package/plugins/keyboard.d.ts +76 -33
  40. package/plugins/media-session.d.ts +76 -33
  41. package/plugins/message.d.ts +76 -33
  42. package/plugins/ovp.d.ts +76 -33
  43. package/plugins/playlist.d.ts +107 -33
  44. package/plugins/playlist.js +1 -1
  45. package/plugins/preview.d.ts +76 -33
  46. package/plugins/qsel.d.ts +76 -33
  47. package/plugins/qul.d.ts +76 -33
  48. package/plugins/rts.d.ts +76 -33
  49. package/plugins/share.d.ts +76 -33
  50. package/plugins/speed.d.ts +76 -33
  51. package/plugins/ssai.d.ts +76 -33
  52. package/plugins/ssai.js +1 -1
  53. package/plugins/subtitles.d.ts +76 -33
  54. package/plugins/thumbnails.d.ts +76 -33
  55. package/plugins/tizen.d.ts +76 -33
  56. package/plugins/vtsel.d.ts +76 -33
  57. package/plugins/webos.d.ts +76 -33
  58. package/util/loader.d.ts +76 -33
@@ -357,6 +357,7 @@ declare type ErrorEventDetail = {
357
357
  declare namespace events {
358
358
  export {
359
359
  MOUNT,
360
+ RETRY,
360
361
  ERROR,
361
362
  CONTEXT_MENU,
362
363
  CLICK,
@@ -408,7 +409,8 @@ declare namespace events {
408
409
  LANDSCAPE,
409
410
  PORTRAIT,
410
411
  DVR,
411
- LIVE_2 as LIVE
412
+ LIVE,
413
+ RECOVER
412
414
  }
413
415
  }
414
416
 
@@ -614,8 +616,6 @@ declare type LinkOpts = {
614
616
  onclick?(e: Event, video: Player): void;
615
617
  };
616
618
 
617
- declare const LIVE = "is-live";
618
-
619
619
  /**
620
620
  * @public
621
621
  * when src is a livestream
@@ -627,7 +627,9 @@ declare const /**
627
627
  * @public
628
628
  * when src is a livestream
629
629
  */
630
- LIVE_2 = "live";
630
+ LIVE = "live";
631
+
632
+ declare const LIVE_2 = "is-live";
631
633
 
632
634
  declare const LIVE_SEEKED = "is-live-seeked";
633
635
 
@@ -927,33 +929,27 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
927
929
 
928
930
  declare type PlayerCustomEventName = keyof PlayerCustomEventsDetailMap;
929
931
 
930
- declare type PlayerCustomEventsDetailMap = {
931
- [MOUNT]: MountEventDetail;
932
- [ERROR]: ErrorEventDetail;
933
- [CONTEXT_MENU]: ContextMenuEventDetail;
934
- /* Excluded from this release type: beforeplay */
935
- /* Excluded from this release type: beforepause */
936
- /* Excluded from this release type: state */
932
+ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap & {
933
+ [REAP]: ReapEventDetail;
934
+ [SOURCE]: SourceEventDetail;
937
935
  [CUEPOINT_START]: CuePointStartEventDetail;
938
936
  [CUEPOINT_END]: CuePointEndEventDetail;
939
- [VIEW_ENTER]: ViewEnterEventDetail;
940
- [VIEW_LEAVE]: ViewLeaveEventDetail;
941
- [SOURCE]: SourceEventDetail;
942
- /* Excluded from this release type: recover */
943
- [REAP]: ReapEventDetail;
944
- /* Excluded from this release type: config */
945
- [QUALITIES]: QualitiesEventDetail;
946
- /* Excluded from this release type: "error:fatal" */
947
- [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
937
+ [MOUNT]: MountEventDetail;
938
+ [LIVE]: LiveEventDetail;
939
+ [DVR]: DvrEventDetail;
940
+ [RETRY]: RetryEventDetail;
941
+ [RECOVER]: RecoverEventDetail;
948
942
  /* Excluded from this release type: audioonlysource */
949
943
  /* Excluded from this release type: renderplugin */
950
- [DVR]: DvrEventDetail;
951
- [LIVE_2]: LiveEventDetail;
952
944
  /* Excluded from this release type: "seek:queued" */
953
945
  /* Excluded from this release type: "seek:cancel" */
954
946
  /* Excluded from this release type: "plugin:registered" */
955
947
  /* Excluded from this release type: intersectionchange */
956
- /* Excluded from this release type: retry */
948
+ /* Excluded from this release type: beforeplay */
949
+ /* Excluded from this release type: beforepause */
950
+ /* Excluded from this release type: state */
951
+ /* Excluded from this release type: config */
952
+ /* Excluded from this release type: "error:fatal" */
957
953
  };
958
954
 
959
955
  declare type PlayerCustomEventsOverloads = {
@@ -992,11 +988,18 @@ declare type PlayerCustomEventsOverloads = {
992
988
  * Sent right before the player src attribute is set. This allows you to change the video URL before playback.
993
989
  */
994
990
  on(event: typeof SOURCE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof SOURCE]>) => void): Player;
995
- /* Excluded from this release type: on */
991
+ /**
992
+ * Emitted when an Error recovery is attempted
993
+ */
994
+ on(event: typeof RECOVER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOVER]>) => void): Player;
996
995
  /**
997
996
  * 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.
998
997
  */
999
998
  on(event: typeof REAP, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof REAP]>) => void): Player;
999
+ /**
1000
+ * Emitted when a player will retry to reload
1001
+ */
1002
+ on(event: typeof RETRY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RETRY]>) => void): Player;
1000
1003
  /* Excluded from this release type: on */
1001
1004
  /**
1002
1005
  * Emitted when the set of underlying qualities has changed.
@@ -1016,8 +1019,7 @@ declare type PlayerCustomEventsOverloads = {
1016
1019
  /**
1017
1020
  * when src is a livestream
1018
1021
  */
1019
- on(event: typeof LIVE_2, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE_2]>) => void): Player;
1020
- /* Excluded from this release type: on */
1022
+ on(event: typeof LIVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE]>) => void): Player;
1021
1023
  /* Excluded from this release type: on */
1022
1024
  /* Excluded from this release type: on */
1023
1025
  /* Excluded from this release type: on */
@@ -1046,11 +1048,26 @@ declare type PlayerCustomEventsOverloads = {
1046
1048
  */
1047
1049
  off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1048
1050
  /* Excluded from this release type: poll */
1049
- emit<T extends PlayerCustomEventName>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1050
1051
  /* Excluded from this release type: emit */
1051
- emit<T, X extends string = string>(event: X & (X extends PlayerCustomEventName ? "Incorrect event detail type" : X), data?: T): Player;
1052
+ /* Excluded from this release type: emit */
1053
+ emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1054
+ /* Excluded from this release type: emit */
1055
+ };
1056
+
1057
+ declare type PlayerEmittableCustomEventsDetailMap = {
1058
+ [ERROR]: ErrorEventDetail;
1059
+ [CONTEXT_MENU]: ContextMenuEventDetail;
1060
+ [VIEW_ENTER]: ViewEnterEventDetail;
1061
+ [VIEW_LEAVE]: ViewLeaveEventDetail;
1062
+ [QUALITIES]: QualitiesEventDetail;
1063
+ [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
1052
1064
  };
1053
1065
 
1066
+ declare type PlayerEmittableEventNames = keyof PlayerEmittableCustomEventsDetailMap;
1067
+
1068
+ /**
1069
+ * @public
1070
+ */
1054
1071
  declare type PlayerEventOverloads = PlayerNativeEventsOverloads & PlayerCustomEventsOverloads;
1055
1072
 
1056
1073
  declare type PlayerNativeEventName = keyof PlayerNativeEventsDetailMap;
@@ -1244,9 +1261,23 @@ declare type RecommendationsReadyEventDetail = {
1244
1261
  playlist: RecommendationItem[];
1245
1262
  };
1246
1263
 
1247
- /* Excluded from this release type: RECOVER */
1264
+ /**
1265
+ * @public
1266
+ * emitted when an Error recovery is attempted
1267
+ */
1268
+ declare const /**
1269
+ @public
1270
+ * when a new player is inserted into the HTML
1271
+ */ /**
1272
+ * @public
1273
+ * emitted when an Error recovery is attempted
1274
+ */
1275
+ RECOVER = "recover";
1248
1276
 
1249
- /* Excluded from this release type: RecoverEventDetail */
1277
+ /**
1278
+ * @public
1279
+ */
1280
+ declare type RecoverEventDetail = null;
1250
1281
 
1251
1282
  /* Excluded from this release type: REMOTE_SESSION_ENDED */
1252
1283
 
@@ -1270,9 +1301,21 @@ declare const /**
1270
1301
  */
1271
1302
  RESIZE = "resize";
1272
1303
 
1273
- /* Excluded from this release type: RETRY */
1304
+ /**
1305
+ * @public
1306
+ */
1307
+ declare const /**
1308
+ @public
1309
+ * when a new player is inserted into the HTML
1310
+ */ /**
1311
+ * @public
1312
+ */
1313
+ RETRY = "retry";
1274
1314
 
1275
- /* Excluded from this release type: RetryEventDetail */
1315
+ /**
1316
+ * @public
1317
+ */
1318
+ declare type RetryEventDetail = null;
1276
1319
 
1277
1320
  declare const RTL = "is-rtl";
1278
1321
 
@@ -1407,7 +1450,7 @@ declare namespace states {
1407
1450
  RTL,
1408
1451
  TV,
1409
1452
  ENDED,
1410
- LIVE,
1453
+ LIVE_2 as LIVE,
1411
1454
  ERRORED,
1412
1455
  WAITING,
1413
1456
  AUTOPLAY,
@@ -373,6 +373,7 @@ declare type ErrorEventDetail = {
373
373
  declare namespace events {
374
374
  export {
375
375
  MOUNT,
376
+ RETRY,
376
377
  ERROR,
377
378
  CONTEXT_MENU,
378
379
  CLICK,
@@ -424,7 +425,8 @@ declare namespace events {
424
425
  LANDSCAPE,
425
426
  PORTRAIT,
426
427
  DVR,
427
- LIVE_2 as LIVE
428
+ LIVE,
429
+ RECOVER
428
430
  }
429
431
  }
430
432
 
@@ -623,8 +625,6 @@ declare const /**
623
625
  */
624
626
  LANDSCAPE = "landscape";
625
627
 
626
- declare const LIVE = "is-live";
627
-
628
628
  /**
629
629
  * @public
630
630
  * when src is a livestream
@@ -636,7 +636,9 @@ declare const /**
636
636
  * @public
637
637
  * when src is a livestream
638
638
  */
639
- LIVE_2 = "live";
639
+ LIVE = "live";
640
+
641
+ declare const LIVE_2 = "is-live";
640
642
 
641
643
  declare const LIVE_SEEKED = "is-live-seeked";
642
644
 
@@ -936,33 +938,27 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
936
938
 
937
939
  declare type PlayerCustomEventName = keyof PlayerCustomEventsDetailMap;
938
940
 
939
- declare type PlayerCustomEventsDetailMap = {
940
- [MOUNT]: MountEventDetail;
941
- [ERROR]: ErrorEventDetail;
942
- [CONTEXT_MENU]: ContextMenuEventDetail;
943
- /* Excluded from this release type: beforeplay */
944
- /* Excluded from this release type: beforepause */
945
- /* Excluded from this release type: state */
941
+ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap & {
942
+ [REAP]: ReapEventDetail;
943
+ [SOURCE]: SourceEventDetail;
946
944
  [CUEPOINT_START]: CuePointStartEventDetail;
947
945
  [CUEPOINT_END]: CuePointEndEventDetail;
948
- [VIEW_ENTER]: ViewEnterEventDetail;
949
- [VIEW_LEAVE]: ViewLeaveEventDetail;
950
- [SOURCE]: SourceEventDetail;
951
- /* Excluded from this release type: recover */
952
- [REAP]: ReapEventDetail;
953
- /* Excluded from this release type: config */
954
- [QUALITIES]: QualitiesEventDetail;
955
- /* Excluded from this release type: "error:fatal" */
956
- [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
946
+ [MOUNT]: MountEventDetail;
947
+ [LIVE]: LiveEventDetail;
948
+ [DVR]: DvrEventDetail;
949
+ [RETRY]: RetryEventDetail;
950
+ [RECOVER]: RecoverEventDetail;
957
951
  /* Excluded from this release type: audioonlysource */
958
952
  /* Excluded from this release type: renderplugin */
959
- [DVR]: DvrEventDetail;
960
- [LIVE_2]: LiveEventDetail;
961
953
  /* Excluded from this release type: "seek:queued" */
962
954
  /* Excluded from this release type: "seek:cancel" */
963
955
  /* Excluded from this release type: "plugin:registered" */
964
956
  /* Excluded from this release type: intersectionchange */
965
- /* Excluded from this release type: retry */
957
+ /* Excluded from this release type: beforeplay */
958
+ /* Excluded from this release type: beforepause */
959
+ /* Excluded from this release type: state */
960
+ /* Excluded from this release type: config */
961
+ /* Excluded from this release type: "error:fatal" */
966
962
  };
967
963
 
968
964
  declare type PlayerCustomEventsOverloads = {
@@ -1001,11 +997,18 @@ declare type PlayerCustomEventsOverloads = {
1001
997
  * Sent right before the player src attribute is set. This allows you to change the video URL before playback.
1002
998
  */
1003
999
  on(event: typeof SOURCE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof SOURCE]>) => void): Player;
1004
- /* Excluded from this release type: on */
1000
+ /**
1001
+ * Emitted when an Error recovery is attempted
1002
+ */
1003
+ on(event: typeof RECOVER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOVER]>) => void): Player;
1005
1004
  /**
1006
1005
  * 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.
1007
1006
  */
1008
1007
  on(event: typeof REAP, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof REAP]>) => void): Player;
1008
+ /**
1009
+ * Emitted when a player will retry to reload
1010
+ */
1011
+ on(event: typeof RETRY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RETRY]>) => void): Player;
1009
1012
  /* Excluded from this release type: on */
1010
1013
  /**
1011
1014
  * Emitted when the set of underlying qualities has changed.
@@ -1025,8 +1028,7 @@ declare type PlayerCustomEventsOverloads = {
1025
1028
  /**
1026
1029
  * when src is a livestream
1027
1030
  */
1028
- on(event: typeof LIVE_2, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE_2]>) => void): Player;
1029
- /* Excluded from this release type: on */
1031
+ on(event: typeof LIVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE]>) => void): Player;
1030
1032
  /* Excluded from this release type: on */
1031
1033
  /* Excluded from this release type: on */
1032
1034
  /* Excluded from this release type: on */
@@ -1055,11 +1057,26 @@ declare type PlayerCustomEventsOverloads = {
1055
1057
  */
1056
1058
  off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1057
1059
  /* Excluded from this release type: poll */
1058
- emit<T extends PlayerCustomEventName>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1059
1060
  /* Excluded from this release type: emit */
1060
- emit<T, X extends string = string>(event: X & (X extends PlayerCustomEventName ? "Incorrect event detail type" : X), data?: T): Player;
1061
+ /* Excluded from this release type: emit */
1062
+ emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1063
+ /* Excluded from this release type: emit */
1064
+ };
1065
+
1066
+ declare type PlayerEmittableCustomEventsDetailMap = {
1067
+ [ERROR]: ErrorEventDetail;
1068
+ [CONTEXT_MENU]: ContextMenuEventDetail;
1069
+ [VIEW_ENTER]: ViewEnterEventDetail;
1070
+ [VIEW_LEAVE]: ViewLeaveEventDetail;
1071
+ [QUALITIES]: QualitiesEventDetail;
1072
+ [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
1061
1073
  };
1062
1074
 
1075
+ declare type PlayerEmittableEventNames = keyof PlayerEmittableCustomEventsDetailMap;
1076
+
1077
+ /**
1078
+ * @public
1079
+ */
1063
1080
  declare type PlayerEventOverloads = PlayerNativeEventsOverloads & PlayerCustomEventsOverloads;
1064
1081
 
1065
1082
  declare type PlayerNativeEventName = keyof PlayerNativeEventsDetailMap;
@@ -1253,9 +1270,23 @@ declare type RecommendationsReadyEventDetail = {
1253
1270
  playlist: RecommendationItem[];
1254
1271
  };
1255
1272
 
1256
- /* Excluded from this release type: RECOVER */
1273
+ /**
1274
+ * @public
1275
+ * emitted when an Error recovery is attempted
1276
+ */
1277
+ declare const /**
1278
+ @public
1279
+ * when a new player is inserted into the HTML
1280
+ */ /**
1281
+ * @public
1282
+ * emitted when an Error recovery is attempted
1283
+ */
1284
+ RECOVER = "recover";
1257
1285
 
1258
- /* Excluded from this release type: RecoverEventDetail */
1286
+ /**
1287
+ * @public
1288
+ */
1289
+ declare type RecoverEventDetail = null;
1259
1290
 
1260
1291
  /* Excluded from this release type: REMOTE_SESSION_ENDED */
1261
1292
 
@@ -1279,9 +1310,21 @@ declare const /**
1279
1310
  */
1280
1311
  RESIZE = "resize";
1281
1312
 
1282
- /* Excluded from this release type: RETRY */
1313
+ /**
1314
+ * @public
1315
+ */
1316
+ declare const /**
1317
+ @public
1318
+ * when a new player is inserted into the HTML
1319
+ */ /**
1320
+ * @public
1321
+ */
1322
+ RETRY = "retry";
1283
1323
 
1284
- /* Excluded from this release type: RetryEventDetail */
1324
+ /**
1325
+ * @public
1326
+ */
1327
+ declare type RetryEventDetail = null;
1285
1328
 
1286
1329
  declare const RTL = "is-rtl";
1287
1330
 
@@ -1416,7 +1459,7 @@ declare namespace states {
1416
1459
  RTL,
1417
1460
  TV,
1418
1461
  ENDED,
1419
- LIVE,
1462
+ LIVE_2 as LIVE,
1420
1463
  ERRORED,
1421
1464
  WAITING,
1422
1465
  AUTOPLAY,
package/plugins/dash.d.ts CHANGED
@@ -231,7 +231,7 @@ declare type CuePointStartEventDetail = null;
231
231
  * This plugin implements an MPEG-DASH loader plugin which is capable of playing .mpd source files.
232
232
  * See {@link https://developer.wowza.com/docs/wowza-flowplayer/plugins/mpeg-dash | Official documentation}
233
233
  */
234
- declare const Dash: PluginCtor<DashConfig, DashPlayer> & DashAPI;
234
+ declare const Dash: PluginCtor<Config, DashPlayer> & DashAPI;
235
235
  export default Dash;
236
236
 
237
237
  /**
@@ -252,17 +252,6 @@ export declare type DashAttachedEvent = FPEvent<{
252
252
 
253
253
  /* Excluded from this release type: DashClass */
254
254
 
255
- /**
256
- * @public
257
- * This type is used to extend the Player configuration with the Dash plugin configuration.
258
- */
259
- export declare type DashConfig = ConfigWith<{
260
- /**
261
- * The dash plugin does not have any configuration options.
262
- */
263
- dash?: never;
264
- }>;
265
-
266
255
  /* Excluded from this release type: _DashConfig */
267
256
 
268
257
  /**
@@ -422,6 +411,7 @@ declare type ErrorEventDetail = {
422
411
  declare namespace events {
423
412
  export {
424
413
  MOUNT,
414
+ RETRY,
425
415
  ERROR,
426
416
  CONTEXT_MENU,
427
417
  CLICK,
@@ -473,7 +463,8 @@ declare namespace events {
473
463
  LANDSCAPE,
474
464
  PORTRAIT,
475
465
  DVR,
476
- LIVE_2 as LIVE
466
+ LIVE,
467
+ RECOVER
477
468
  }
478
469
  }
479
470
 
@@ -672,8 +663,6 @@ declare const /**
672
663
  */
673
664
  LANDSCAPE = "landscape";
674
665
 
675
- declare const LIVE = "is-live";
676
-
677
666
  /**
678
667
  * @public
679
668
  * when src is a livestream
@@ -685,7 +674,9 @@ declare const /**
685
674
  * @public
686
675
  * when src is a livestream
687
676
  */
688
- LIVE_2 = "live";
677
+ LIVE = "live";
678
+
679
+ declare const LIVE_2 = "is-live";
689
680
 
690
681
  declare const LIVE_SEEKED = "is-live-seeked";
691
682
 
@@ -985,33 +976,27 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
985
976
 
986
977
  declare type PlayerCustomEventName = keyof PlayerCustomEventsDetailMap;
987
978
 
988
- declare type PlayerCustomEventsDetailMap = {
989
- [MOUNT]: MountEventDetail;
990
- [ERROR]: ErrorEventDetail;
991
- [CONTEXT_MENU]: ContextMenuEventDetail;
992
- /* Excluded from this release type: beforeplay */
993
- /* Excluded from this release type: beforepause */
994
- /* Excluded from this release type: state */
979
+ declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap & {
980
+ [REAP]: ReapEventDetail;
981
+ [SOURCE]: SourceEventDetail;
995
982
  [CUEPOINT_START]: CuePointStartEventDetail;
996
983
  [CUEPOINT_END]: CuePointEndEventDetail;
997
- [VIEW_ENTER]: ViewEnterEventDetail;
998
- [VIEW_LEAVE]: ViewLeaveEventDetail;
999
- [SOURCE]: SourceEventDetail;
1000
- /* Excluded from this release type: recover */
1001
- [REAP]: ReapEventDetail;
1002
- /* Excluded from this release type: config */
1003
- [QUALITIES]: QualitiesEventDetail;
1004
- /* Excluded from this release type: "error:fatal" */
1005
- [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
984
+ [MOUNT]: MountEventDetail;
985
+ [LIVE]: LiveEventDetail;
986
+ [DVR]: DvrEventDetail;
987
+ [RETRY]: RetryEventDetail;
988
+ [RECOVER]: RecoverEventDetail;
1006
989
  /* Excluded from this release type: audioonlysource */
1007
990
  /* Excluded from this release type: renderplugin */
1008
- [DVR]: DvrEventDetail;
1009
- [LIVE_2]: LiveEventDetail;
1010
991
  /* Excluded from this release type: "seek:queued" */
1011
992
  /* Excluded from this release type: "seek:cancel" */
1012
993
  /* Excluded from this release type: "plugin:registered" */
1013
994
  /* Excluded from this release type: intersectionchange */
1014
- /* Excluded from this release type: retry */
995
+ /* Excluded from this release type: beforeplay */
996
+ /* Excluded from this release type: beforepause */
997
+ /* Excluded from this release type: state */
998
+ /* Excluded from this release type: config */
999
+ /* Excluded from this release type: "error:fatal" */
1015
1000
  };
1016
1001
 
1017
1002
  declare type PlayerCustomEventsOverloads = {
@@ -1050,11 +1035,18 @@ declare type PlayerCustomEventsOverloads = {
1050
1035
  * Sent right before the player src attribute is set. This allows you to change the video URL before playback.
1051
1036
  */
1052
1037
  on(event: typeof SOURCE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof SOURCE]>) => void): Player;
1053
- /* Excluded from this release type: on */
1038
+ /**
1039
+ * Emitted when an Error recovery is attempted
1040
+ */
1041
+ on(event: typeof RECOVER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOVER]>) => void): Player;
1054
1042
  /**
1055
1043
  * 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.
1056
1044
  */
1057
1045
  on(event: typeof REAP, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof REAP]>) => void): Player;
1046
+ /**
1047
+ * Emitted when a player will retry to reload
1048
+ */
1049
+ on(event: typeof RETRY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RETRY]>) => void): Player;
1058
1050
  /* Excluded from this release type: on */
1059
1051
  /**
1060
1052
  * Emitted when the set of underlying qualities has changed.
@@ -1074,8 +1066,7 @@ declare type PlayerCustomEventsOverloads = {
1074
1066
  /**
1075
1067
  * when src is a livestream
1076
1068
  */
1077
- on(event: typeof LIVE_2, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE_2]>) => void): Player;
1078
- /* Excluded from this release type: on */
1069
+ on(event: typeof LIVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE]>) => void): Player;
1079
1070
  /* Excluded from this release type: on */
1080
1071
  /* Excluded from this release type: on */
1081
1072
  /* Excluded from this release type: on */
@@ -1104,11 +1095,26 @@ declare type PlayerCustomEventsOverloads = {
1104
1095
  */
1105
1096
  off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
1106
1097
  /* Excluded from this release type: poll */
1107
- emit<T extends PlayerCustomEventName>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1108
1098
  /* Excluded from this release type: emit */
1109
- emit<T, X extends string = string>(event: X & (X extends PlayerCustomEventName ? "Incorrect event detail type" : X), data?: T): Player;
1099
+ /* Excluded from this release type: emit */
1100
+ emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
1101
+ /* Excluded from this release type: emit */
1102
+ };
1103
+
1104
+ declare type PlayerEmittableCustomEventsDetailMap = {
1105
+ [ERROR]: ErrorEventDetail;
1106
+ [CONTEXT_MENU]: ContextMenuEventDetail;
1107
+ [VIEW_ENTER]: ViewEnterEventDetail;
1108
+ [VIEW_LEAVE]: ViewLeaveEventDetail;
1109
+ [QUALITIES]: QualitiesEventDetail;
1110
+ [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
1110
1111
  };
1111
1112
 
1113
+ declare type PlayerEmittableEventNames = keyof PlayerEmittableCustomEventsDetailMap;
1114
+
1115
+ /**
1116
+ * @public
1117
+ */
1112
1118
  declare type PlayerEventOverloads = PlayerNativeEventsOverloads & PlayerCustomEventsOverloads;
1113
1119
 
1114
1120
  declare type PlayerNativeEventName = keyof PlayerNativeEventsDetailMap;
@@ -1302,9 +1308,23 @@ declare type RecommendationsReadyEventDetail = {
1302
1308
  playlist: RecommendationItem[];
1303
1309
  };
1304
1310
 
1305
- /* Excluded from this release type: RECOVER */
1311
+ /**
1312
+ * @public
1313
+ * emitted when an Error recovery is attempted
1314
+ */
1315
+ declare const /**
1316
+ @public
1317
+ * when a new player is inserted into the HTML
1318
+ */ /**
1319
+ * @public
1320
+ * emitted when an Error recovery is attempted
1321
+ */
1322
+ RECOVER = "recover";
1306
1323
 
1307
- /* Excluded from this release type: RecoverEventDetail */
1324
+ /**
1325
+ * @public
1326
+ */
1327
+ declare type RecoverEventDetail = null;
1308
1328
 
1309
1329
  /* Excluded from this release type: REMOTE_SESSION_ENDED */
1310
1330
 
@@ -1328,9 +1348,21 @@ declare const /**
1328
1348
  */
1329
1349
  RESIZE = "resize";
1330
1350
 
1331
- /* Excluded from this release type: RETRY */
1351
+ /**
1352
+ * @public
1353
+ */
1354
+ declare const /**
1355
+ @public
1356
+ * when a new player is inserted into the HTML
1357
+ */ /**
1358
+ * @public
1359
+ */
1360
+ RETRY = "retry";
1332
1361
 
1333
- /* Excluded from this release type: RetryEventDetail */
1362
+ /**
1363
+ * @public
1364
+ */
1365
+ declare type RetryEventDetail = null;
1334
1366
 
1335
1367
  declare const RTL = "is-rtl";
1336
1368
 
@@ -1465,7 +1497,7 @@ declare namespace states {
1465
1497
  RTL,
1466
1498
  TV,
1467
1499
  ENDED,
1468
- LIVE,
1500
+ LIVE_2 as LIVE,
1469
1501
  ERRORED,
1470
1502
  WAITING,
1471
1503
  AUTOPLAY,