@flowplayer/player 3.15.1-rc → 3.16.0-rc

package/util/loader.d.ts

@@ -352,6 +352,7 @@ declare type ErrorEventDetail = {
 declare namespace events {
     export {
         MOUNT,
+        RETRY,
         ERROR,
         CONTEXT_MENU,
         CLICK,
@@ -403,7 +404,8 @@ declare namespace events {
         LANDSCAPE,
         PORTRAIT,
         DVR,
-        LIVE_2 as LIVE
+        LIVE,
+        RECOVER
     }
 }
 
@@ -607,8 +609,6 @@ declare const /**
  */
 LANDSCAPE = "landscape";
 
-declare const LIVE = "is-live";
-
 /**
  * @public
  * when src is a livestream
@@ -620,7 +620,9 @@ declare const /**
  * @public
  * when src is a livestream
  */
-LIVE_2 = "live";
+LIVE = "live";
+
+declare const LIVE_2 = "is-live";
 
 declare const LIVE_SEEKED = "is-live-seeked";
 
@@ -927,33 +929,27 @@ declare type Player = HTMLVideoElement & PlayerEventOverloads & {
 
 declare type PlayerCustomEventName = keyof PlayerCustomEventsDetailMap;
 
-declare type PlayerCustomEventsDetailMap = {
-    [MOUNT]: MountEventDetail;
-    [ERROR]: ErrorEventDetail;
-    [CONTEXT_MENU]: ContextMenuEventDetail;
-    /* Excluded from this release type: beforeplay */
-    /* Excluded from this release type: beforepause */
-    /* Excluded from this release type: state */
+declare type PlayerCustomEventsDetailMap = PlayerEmittableCustomEventsDetailMap & {
+    [REAP]: ReapEventDetail;
+    [SOURCE]: SourceEventDetail;
     [CUEPOINT_START]: CuePointStartEventDetail;
     [CUEPOINT_END]: CuePointEndEventDetail;
-    [VIEW_ENTER]: ViewEnterEventDetail;
-    [VIEW_LEAVE]: ViewLeaveEventDetail;
-    [SOURCE]: SourceEventDetail;
-    /* Excluded from this release type: recover */
-    [REAP]: ReapEventDetail;
-    /* Excluded from this release type: config */
-    [QUALITIES]: QualitiesEventDetail;
-    /* Excluded from this release type: "error:fatal" */
-    [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
+    [MOUNT]: MountEventDetail;
+    [LIVE]: LiveEventDetail;
+    [DVR]: DvrEventDetail;
+    [RETRY]: RetryEventDetail;
+    [RECOVER]: RecoverEventDetail;
     /* Excluded from this release type: audioonlysource */
     /* Excluded from this release type: renderplugin */
-    [DVR]: DvrEventDetail;
-    [LIVE_2]: LiveEventDetail;
     /* Excluded from this release type: "seek:queued" */
     /* Excluded from this release type: "seek:cancel" */
     /* Excluded from this release type: "plugin:registered" */
     /* Excluded from this release type: intersectionchange */
-    /* Excluded from this release type: retry */
+    /* Excluded from this release type: beforeplay */
+    /* Excluded from this release type: beforepause */
+    /* Excluded from this release type: state */
+    /* Excluded from this release type: config */
+    /* Excluded from this release type: "error:fatal" */
 };
 
 declare type PlayerCustomEventsOverloads = {
@@ -992,11 +988,18 @@ declare type PlayerCustomEventsOverloads = {
      * Sent right before the player src attribute is set. This allows you to change the video URL before playback.
      */
     on(event: typeof SOURCE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof SOURCE]>) => void): Player;
-    /* Excluded from this release type: on */
+    /**
+     * Emitted when an Error recovery is attempted
+     */
+    on(event: typeof RECOVER, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RECOVER]>) => void): Player;
     /**
      * 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.
      */
     on(event: typeof REAP, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof REAP]>) => void): Player;
+    /**
+     * Emitted when a player will retry to reload
+     */
+    on(event: typeof RETRY, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof RETRY]>) => void): Player;
     /* Excluded from this release type: on */
     /**
      * Emitted when the set of underlying qualities has changed.
@@ -1016,8 +1019,7 @@ declare type PlayerCustomEventsOverloads = {
     /**
      * when src is a livestream
      */
-    on(event: typeof LIVE_2, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE_2]>) => void): Player;
-    /* Excluded from this release type: on */
+    on(event: typeof LIVE, handler: (e: FPEvent<PlayerCustomEventsDetailMap[typeof LIVE]>) => void): Player;
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
     /* Excluded from this release type: on */
@@ -1046,11 +1048,26 @@ declare type PlayerCustomEventsOverloads = {
      */
     off<T>(event: string, handler: (e: FPEvent<T>) => void): Player;
     /* Excluded from this release type: poll */
-    emit<T extends PlayerCustomEventName>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
     /* Excluded from this release type: emit */
-    emit<T, X extends string = string>(event: X & (X extends PlayerCustomEventName ? "Incorrect event detail type" : X), data?: T): Player;
+    /* Excluded from this release type: emit */
+    emit<T extends PlayerEmittableEventNames>(event: T, data?: PlayerCustomEventsDetailMap[T]): Player;
+    /* Excluded from this release type: emit */
+};
+
+declare type PlayerEmittableCustomEventsDetailMap = {
+    [ERROR]: ErrorEventDetail;
+    [CONTEXT_MENU]: ContextMenuEventDetail;
+    [VIEW_ENTER]: ViewEnterEventDetail;
+    [VIEW_LEAVE]: ViewLeaveEventDetail;
+    [QUALITIES]: QualitiesEventDetail;
+    [RECOMMENDATIONS_READY]: RecommendationsReadyEventDetail;
 };
 
+declare type PlayerEmittableEventNames = keyof PlayerEmittableCustomEventsDetailMap;
+
+/**
+ * @public
+ */
 declare type PlayerEventOverloads = PlayerNativeEventsOverloads & PlayerCustomEventsOverloads;
 
 declare type PlayerNativeEventName = keyof PlayerNativeEventsDetailMap;
@@ -1244,9 +1261,23 @@ declare type RecommendationsReadyEventDetail = {
     playlist: RecommendationItem[];
 };
 
-/* Excluded from this release type: RECOVER */
+/**
+ * @public
+ * emitted when an Error recovery is attempted
+ */
+declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted when an Error recovery is attempted
+ */
+RECOVER = "recover";
 
-/* Excluded from this release type: RecoverEventDetail */
+/**
+ * @public
+ */
+declare type RecoverEventDetail = null;
 
 /* Excluded from this release type: REMOTE_SESSION_ENDED */
 
@@ -1270,9 +1301,21 @@ declare const /**
  */
 RESIZE = "resize";
 
-/* Excluded from this release type: RETRY */
+/**
+ * @public
+ */
+declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+RETRY = "retry";
 
-/* Excluded from this release type: RetryEventDetail */
+/**
+ * @public
+ */
+declare type RetryEventDetail = null;
 
 /**
  * @public
@@ -1412,7 +1455,7 @@ declare namespace states {
         RTL,
         TV,
         ENDED,
-        LIVE,
+        LIVE_2 as LIVE,
         ERRORED,
         WAITING,
         AUTOPLAY,