@flowplayer/player 3.14.1 → 3.15.0-rc.10

package/core/events.d.ts

@@ -1,157 +1,664 @@
-export declare const AUDIO_ONLY_SOURCE = "audioonlysource";
+/* Excluded from this release type: AUDIO_ONLY_SOURCE */
 
-export declare const BEFORE_PAUSE = "beforepause";
+/* Excluded from this release type: BEFORE_PAUSE */
 
-export declare const BEFORE_PLAY = "beforeplay";
+/* Excluded from this release type: BEFORE_PLAY */
 
-export declare const CAN_PLAY = "canplay";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+CAN_PLAY = "canplay";
 
-export declare const CLICK = "click";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+CLICK = "click";
+
+/* Excluded from this release type: CONFIG */
 
-export declare const CONFIG = "config";
+/* Excluded from this release type: CONTENT_REAL_LOAD_START */
 
-export declare const CONTEXT_MENU = "contextmenu";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+CONTEXT_MENU = "contextmenu";
 
-export declare const CUEPOINT_END = "cuepointend";
+/**
+ * @public
+ *  when a cuepoint becomes inactive
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ *  when a cuepoint becomes inactive
+ */
+CUEPOINT_END = "cuepointend";
 
-export declare const CUEPOINT_START = "cuepointstart";
+/**
+ * @public
+ * when a cuepoint is active
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * when a cuepoint is active
+ */
+CUEPOINT_START = "cuepointstart";
 
-export declare const CUEPOINTS = "cuepoints";
+/**
+ * @public
+ * cuepoints parsing is asynchronous
+ * you cannot rely on them existing until
+ * this event is emitted
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * cuepoints parsing is asynchronous
+ * you cannot rely on them existing until
+ * this event is emitted
+ */
+CUEPOINTS = "cuepoints";
 
-export declare const DATA = "loadeddata";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+DATA = "loadeddata";
 
-export declare const DBL_CLICK = "dblclick";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+DBL_CLICK = "dblclick";
 
-export declare const DURATION_CHANGE = "durationchange";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+DURATION_CHANGE = "durationchange";
 
 /**
+ * @public
  * when the player has started playing dvr content
  */
 export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
  * when the player has started playing dvr content
  */
 DVR = "dvr";
 
-export declare const ENDED = "ended";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+ENDED = "ended";
 
-export declare const ERROR = "error";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+ERROR = "error";
 
-export declare const FULLSCREEN_CHANGE = "fullscreenchange";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+FULLSCREEN_CHANGE = "fullscreenchange";
 
-export declare const FULLSCREEN_ENTER = "fullscreenenter";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+FULLSCREEN_ENTER = "fullscreenenter";
 
-export declare const FULLSCREEN_EXIT = "fullscreenexit";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+FULLSCREEN_EXIT = "fullscreenexit";
 
-export declare const INTERSECTIONCHANGE = "intersectionchange";
+/* Excluded from this release type: INTERSECTIONCHANGE */
 
-export declare const KEYDOWN = "keydown";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+KEYDOWN = "keydown";
 
-export declare const KEYUP = "keyup";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+KEYUP = "keyup";
 
-export declare const LANDSCAPE = "landscape";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+LANDSCAPE = "landscape";
 
 /**
+ * @public
  * when src is a livestream
  */
 export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
  * when src is a livestream
  */
 LIVE = "live";
 
-export declare const LOAD = "load";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+LOAD = "load";
 
-export declare const LOAD_START = "loadstart";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+LOAD_START = "loadstart";
 
-export declare const METADATA = "loadedmetadata";
+/**
+ * @public
+ * general video events flowplayer uses internally
+ *  https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * general video events flowplayer uses internally
+ *  https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events
+ */
+METADATA = "loadedmetadata";
 
-export declare const MOUNT = "mount";
+/**
+ @public
+ * when a new player is inserted into the HTML
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ @public
+ * when a new player is inserted into the HTML
+ */ MOUNT = "mount";
 
-export declare const MOUSE_DOWN = "mousedown";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+MOUSE_DOWN = "mousedown";
 
-export declare const MOUSE_ENTER = "mouseenter";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+MOUSE_ENTER = "mouseenter";
 
-export declare const MOUSE_LEAVE = "mouseleave";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+MOUSE_LEAVE = "mouseleave";
 
-export declare const MOUSE_MOVE = "mousemove";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+MOUSE_MOVE = "mousemove";
 
-export declare const MOUSE_UP = "mouseup";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+MOUSE_UP = "mouseup";
 
-export declare const NON_RECOVERABLE_ERROR = "error:fatal";
+/* Excluded from this release type: NON_RECOVERABLE_ERROR */
 
-export declare const PAUSE = "pause";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+PAUSE = "pause";
 
-export declare const PLAY = "play";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+PLAY = "play";
 
-export declare const PLAYING = "playing";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+PLAYING = "playing";
 
-export declare const PLUGIN_REGISTERED = "plugin:registered";
+/* Excluded from this release type: PLUGIN_REGISTERED */
 
-export declare const PORTRAIT = "portrait";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+PORTRAIT = "portrait";
 
-export declare const PROGRESS = "progress";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+PROGRESS = "progress";
 
-export declare const QUALITIES = "qualities";
+/**
+ * @public
+ * emitted whenever a list of qualities has been made available
+ *  when index 0 is the highest quality and index 0+N is the lowest
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted whenever a list of qualities has been made available
+ *  when index 0 is the highest quality and index 0+N is the lowest
+ */
+QUALITIES = "qualities";
 
-export declare const REAP = "reap";
+/**
+ * @public
+ * emitted when it is safe to clean up a fp instance
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted when it is safe to clean up a fp instance
+ */
+REAP = "reap";
 
 /**
- * @deprecated please use Endscreen.events.RECOMMENDATIONS_READY / flowplayer.endscreen.events.RECOMMENDATIONS_READY
- **/
+ * @public
+ */
 export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
  * @deprecated please use Endscreen.events.RECOMMENDATIONS_READY / flowplayer.endscreen.events.RECOMMENDATIONS_READY
  **/
+/**
+ * @public
+ */
 RECOMMENDATIONS_READY = "recommendationsready";
 
-export declare const RECOVER = "recover";
+/* Excluded from this release type: RECOVER */
 
-export declare const REMOTE_SESSION_ENDED = "remotesession:ended";
+/* Excluded from this release type: REMOTE_SESSION_ENDED */
 
-export declare const REMOTE_SESSION_STARTED = "remotesession:started";
+/* Excluded from this release type: REMOTE_SESSION_STARTED */
 
-export declare const RENDER_PLUGIN = "renderplugin";
+/* Excluded from this release type: RENDER_PLUGIN */
 
-export declare const RESIZE = "resize";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+RESIZE = "resize";
 
-export declare const RETRY = "retry";
+/* Excluded from this release type: RETRY */
 
-export declare const SCROLL = "scroll";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+SCROLL = "scroll";
 
-export declare const SEEK_CANCEL = "seek:cancel";
+/* Excluded from this release type: SEEK_CANCEL */
 
-export declare const SEEK_QUEUED = "seek:queued";
+/* Excluded from this release type: SEEK_QUEUED */
 
-export declare const SEEKED = "seeked";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+SEEKED = "seeked";
 
-export declare const SEEKING = "seeking";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+SEEKING = "seeking";
 
-export declare const SET_QUALITY = "quality:set";
+/**
+ * @public
+ *  allows plugins to listen for forced quality changes
+ * it should emit the index of the quality to set
+ * -1 is a special idx saying to use ABR if the plugin
+ * exposes an ABR implementation
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ *  allows plugins to listen for forced quality changes
+ * it should emit the index of the quality to set
+ * -1 is a special idx saying to use ABR if the plugin
+ * exposes an ABR implementation
+ */
+SET_QUALITY = "quality:set";
 
-export declare const SOURCE = "src";
+/**
+ * @public
+ * emitted when a valid source is found prior to mounting
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted when a valid source is found prior to mounting
+ */
+SOURCE = "src";
 
-export declare const STATE = "state";
+/* Excluded from this release type: STATE */
 
-export declare const TIME_UPDATE = "timeupdate";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+TIME_UPDATE = "timeupdate";
 
-export declare const TOUCH_CANCEL = "touchcancel";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+TOUCH_CANCEL = "touchcancel";
 
-export declare const TOUCH_END = "touchend";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+TOUCH_END = "touchend";
 
-export declare const TOUCH_MOVE = "touchmove";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+TOUCH_MOVE = "touchmove";
 
-export declare const TOUCH_START = "touchstart";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+TOUCH_START = "touchstart";
 
-export declare const VIDEO_TRACK_SELECT = "tracks:video:select";
+/**
+ * @public
+ * emitted when a video track is selected
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted when a video track is selected
+ */
+VIDEO_TRACK_SELECT = "tracks:video:select";
 
-export declare const VIDEO_TRACKS = "videoTracks";
+/**
+ * @public
+ * emitted whenever multiple video tracks are detected
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * emitted whenever multiple video tracks are detected
+ */
+VIDEO_TRACKS = "videoTracks";
 
-export declare const VIEW_ENTER = "viewenter";
+/**
+ * @public
+ * when a player enters the viewpoint
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * when a player enters the viewpoint
+ */
+VIEW_ENTER = "viewenter";
 
-export declare const VIEW_LEAVE = "viewleave";
+/**
+ * @public
+ * when a player leaves the viewport
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ * when a player leaves the viewport
+ */
+VIEW_LEAVE = "viewleave";
 
-export declare const VOLUME_CHANGE = "volumechange";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+VOLUME_CHANGE = "volumechange";
 
-export declare const WAITING = "waiting";
+/**
+ * @public
+ */
+export declare const /**
+@public
+* when a new player is inserted into the HTML
+*/ /**
+ * @public
+ */
+WAITING = "waiting";
 
-export declare const WEBKIT_NEEDKEY = "webkitneedkey";
+/* Excluded from this release type: WEBKIT_NEEDKEY */
 
 export { }