@flowplayer/player 3.23.0 → 3.24.0-rc.1

package/core/events.js

@@ -1,306 +1,308 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 /**
  * all events used by Flowplayer
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PORTRAIT = exports.LANDSCAPE = exports.RECOMMENDATIONS_READY = exports.VIDEO_TRACK_SELECT = exports.SET_QUALITY = exports.VIDEO_TRACKS = exports.QUALITY_CHANGE = exports.QUALITIES = exports.REAP = exports.SOURCE = exports.VIEW_LEAVE = exports.VIEW_ENTER = exports.DURATION_CHANGE = exports.SEEKING = exports.SEEKED = exports.ENDED = exports.CAN_PLAY = exports.WAITING = exports.PLAY = exports.PLAYING = exports.PAUSE = exports.VOLUME_CHANGE = exports.LOAD_START = exports.TIME_UPDATE = exports.PROGRESS = exports.DATA = exports.METADATA = exports.FULLSCREEN_CHANGE = exports.FULLSCREEN_EXIT = exports.FULLSCREEN_ENTER = exports.SCROLL = exports.RESIZE = exports.TOUCH_CANCEL = exports.TOUCH_END = exports.TOUCH_MOVE = exports.TOUCH_START = exports.MOUSE_MOVE = exports.MOUSE_DOWN = exports.MOUSE_UP = exports.MOUSE_LEAVE = exports.MOUSE_ENTER = exports.LOAD = exports.KEYDOWN = exports.KEYUP = exports.DBL_CLICK = exports.CLICK = exports.CONTEXT_MENU = exports.ERROR = exports.RETRY = exports.MOUNT = void 0;
-exports.CUEPOINT_END = exports.CUEPOINT_START = exports.CUEPOINTS = exports.CONTENT_REAL_LOAD_START = exports.BEFORE_PAUSE = exports.BEFORE_PLAY = exports.STATE = exports.CONFIG = exports.NON_RECOVERABLE_ERROR = exports.AUDIO_ONLY_SOURCE = exports.RENDER_PLUGIN = exports.WEBKIT_NEEDKEY = exports.INTERSECTIONCHANGE = exports.REMOTE_SESSION_ENDED = exports.REMOTE_SESSION_STARTED = exports.PLUGIN_REGISTERED = exports.SEEK_CANCEL = exports.SEEK_QUEUED = exports.RECOVER = exports.LIVE = exports.DVR = void 0;
-exports.MOUNT = "mount", 
+const /**
+@public
+* when a new player is inserted into the HTML
+*/ MOUNT = "mount", 
 // native events that flowplayer use
 /**
  * @public
  */
-exports.RETRY = "retry", 
+RETRY = "retry", 
 // native events that flowplayer use
 /**
  * @public
  */
-exports.ERROR = "error", 
+ERROR = "error", 
 /**
  * @public
  */
-exports.CONTEXT_MENU = "contextmenu", 
+CONTEXT_MENU = "contextmenu", 
 /**
  * @public
  */
-exports.CLICK = "click", 
+CLICK = "click", 
 /**
  * @public
  */
-exports.DBL_CLICK = "dblclick", 
+DBL_CLICK = "dblclick", 
 /**
  * @public
  */
-exports.KEYUP = "keyup", 
+KEYUP = "keyup", 
 /**
  * @public
  */
-exports.KEYDOWN = "keydown", 
+KEYDOWN = "keydown", 
 /**
  * @public
  */
-exports.LOAD = "load", 
+LOAD = "load", 
 /**
  * @public
  */
-exports.MOUSE_ENTER = "mouseenter", 
+MOUSE_ENTER = "mouseenter", 
 /**
  * @public
  */
-exports.MOUSE_LEAVE = "mouseleave", 
+MOUSE_LEAVE = "mouseleave", 
 /**
  * @public
  */
-exports.MOUSE_UP = "mouseup", 
+MOUSE_UP = "mouseup", 
 /**
  * @public
  */
-exports.MOUSE_DOWN = "mousedown", 
+MOUSE_DOWN = "mousedown", 
 /**
  * @public
  */
-exports.MOUSE_MOVE = "mousemove", 
+MOUSE_MOVE = "mousemove", 
 /**
  * @public
  */
-exports.TOUCH_START = "touchstart", 
+TOUCH_START = "touchstart", 
 /**
  * @public
  */
-exports.TOUCH_MOVE = "touchmove", 
+TOUCH_MOVE = "touchmove", 
 /**
  * @public
  */
-exports.TOUCH_END = "touchend", 
+TOUCH_END = "touchend", 
 /**
  * @public
  */
-exports.TOUCH_CANCEL = "touchcancel", 
+TOUCH_CANCEL = "touchcancel", 
 /**
  * @public
  */
-exports.RESIZE = "resize", 
+RESIZE = "resize", 
 /**
  * @public
  */
-exports.SCROLL = "scroll", 
+SCROLL = "scroll", 
 /**
  * @public
  */
-exports.FULLSCREEN_ENTER = "fullscreenenter", 
+FULLSCREEN_ENTER = "fullscreenenter", 
 /**
  * @public
  */
-exports.FULLSCREEN_EXIT = "fullscreenexit", 
+FULLSCREEN_EXIT = "fullscreenexit", 
 /**
  * @public
  */
-exports.FULLSCREEN_CHANGE = "fullscreenchange", 
+FULLSCREEN_CHANGE = "fullscreenchange", 
 /**
  * @public
  * general video events flowplayer uses internally
  *  https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Media_events
  */
-exports.METADATA = "loadedmetadata", 
+METADATA = "loadedmetadata", 
 /**
  * @public
  */
-exports.DATA = "loadeddata", 
+DATA = "loadeddata", 
 /**
  * @public
  */
-exports.PROGRESS = "progress", 
+PROGRESS = "progress", 
 /**
  * @public
  */
-exports.TIME_UPDATE = "timeupdate", 
+TIME_UPDATE = "timeupdate", 
 /**
  * @public
  */
-exports.LOAD_START = "loadstart", 
+LOAD_START = "loadstart", 
 /**
  * @public
  */
-exports.VOLUME_CHANGE = "volumechange", 
+VOLUME_CHANGE = "volumechange", 
 /**
  * @public
  */
-exports.PAUSE = "pause", 
+PAUSE = "pause", 
 /**
  * @public
  */
-exports.PLAYING = "playing", 
+PLAYING = "playing", 
 /**
  * @public
  */
-exports.PLAY = "play", 
+PLAY = "play", 
 /**
  * @public
  */
-exports.WAITING = "waiting", 
+WAITING = "waiting", 
 /**
  * @public
  */
-exports.CAN_PLAY = "canplay", 
+CAN_PLAY = "canplay", 
 /**
  * @public
  */
-exports.ENDED = "ended", 
+ENDED = "ended", 
 /**
  * @public
  */
-exports.SEEKED = "seeked", 
+SEEKED = "seeked", 
 /**
  * @public
  */
-exports.SEEKING = "seeking", 
+SEEKING = "seeking", 
 /**
  * @public
  */
-exports.DURATION_CHANGE = "durationchange", 
+DURATION_CHANGE = "durationchange", 
 /**
  * @public
  * when a player enters the viewpoint
  */
-exports.VIEW_ENTER = "viewenter", 
+VIEW_ENTER = "viewenter", 
 /**
  * @public
  * when a player leaves the viewport
  */
-exports.VIEW_LEAVE = "viewleave", 
+VIEW_LEAVE = "viewleave", 
 /**
  * @public
  * emitted when a valid source is found prior to mounting
  */
-exports.SOURCE = "src", 
+SOURCE = "src", 
 /**
  * @public
  * emitted when it is safe to clean up a fp instance
  */
-exports.REAP = "reap", 
+REAP = "reap", 
 /**
  * @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
  */
-exports.QUALITIES = "qualities", 
+QUALITIES = "qualities", 
 /**
  * @public
  * emitted whenever the media changes quality
  */
-exports.QUALITY_CHANGE = "qualitychange", 
+QUALITY_CHANGE = "qualitychange", 
 /**
  * @public
  * emitted whenever multiple video tracks are detected
  */
-exports.VIDEO_TRACKS = "videoTracks", 
+VIDEO_TRACKS = "videoTracks", // TODO move to VTSEL plugin
 /**
  * @public
  * @deprecated please use Qsel.events.SET_QUALITY
  */
-exports.SET_QUALITY = "quality:set", 
+SET_QUALITY = "quality:set", 
 /**
  * @public
  * emitted when a video track is selected
  */
-exports.VIDEO_TRACK_SELECT = "tracks:video:select", 
+VIDEO_TRACK_SELECT = "tracks:video:select", // TODO move to VTSEL plugin
 /**
  * @deprecated please use Endscreen.events.RECOMMENDATIONS_READY / flowplayer.endscreen.events.RECOMMENDATIONS_READY
  **/
 /**
  * @public
  */
-exports.RECOMMENDATIONS_READY = "recommendationsready", 
+RECOMMENDATIONS_READY = "recommendationsready", 
 /**
  * @public
  */
-exports.LANDSCAPE = "landscape", 
+LANDSCAPE = "landscape", // TODO not an event
 /**
  * @public
  */
-exports.PORTRAIT = "portrait", 
+PORTRAIT = "portrait", // TODO: not an event
 /**
  * @public
  * when the player has started playing dvr content
  */
-exports.DVR = "dvr", 
+DVR = "dvr", 
 /**
  * @public
  * when src is a livestream
  */
-exports.LIVE = "live", 
+LIVE = "live", 
 /**
  * @public
  * emitted when an Error recovery is attempted
  */
-exports.RECOVER = "recover", 
+RECOVER = "recover", 
 /**
  * @internal
  */
-exports.SEEK_QUEUED = "seek:queued", 
+SEEK_QUEUED = "seek:queued", 
 /**
  * @internal
  */
-exports.SEEK_CANCEL = "seek:cancel", 
+SEEK_CANCEL = "seek:cancel", 
 /**
  * @internal
  */
-exports.PLUGIN_REGISTERED = "plugin:registered", 
+PLUGIN_REGISTERED = "plugin:registered", 
 /**
  * @internal
  */
-exports.REMOTE_SESSION_STARTED = "remotesession:started", 
+REMOTE_SESSION_STARTED = "remotesession:started", // TODO move to Chromecast plugin
 /**
  * @internal
  */
-exports.REMOTE_SESSION_ENDED = "remotesession:ended", 
+REMOTE_SESSION_ENDED = "remotesession:ended", // TODO move to Chromecast plugin
 /**
  * @internal
  */
-exports.INTERSECTIONCHANGE = "intersectionchange", 
+INTERSECTIONCHANGE = "intersectionchange", 
 /**
  * @internal
  */
-exports.WEBKIT_NEEDKEY = "webkitneedkey", 
+WEBKIT_NEEDKEY = "webkitneedkey", 
 /**
  * @internal
  */
-exports.RENDER_PLUGIN = "renderplugin", 
+RENDER_PLUGIN = "renderplugin", 
 /**
  * @internal
  */
-exports.AUDIO_ONLY_SOURCE = "audioonlysource", 
+AUDIO_ONLY_SOURCE = "audioonlysource", 
 /**
  * @internal
  *  error that is fatal in a sense where nothing can be done and
  * player should be destroyed
  */
-exports.NON_RECOVERABLE_ERROR = "error:fatal", 
+NON_RECOVERABLE_ERROR = "error:fatal", 
 /**
  * @internal
  * emitted whenever config is changed
  */
-exports.CONFIG = "config", 
+CONFIG = "config", 
 /**
  * @internal
  * Player (UI) state changed
  */
-exports.STATE = "state", 
+STATE = "state", 
 /**
  * @internal
  * Custom video events
  */
-exports.BEFORE_PLAY = "beforeplay", 
+BEFORE_PLAY = "beforeplay", 
 /**
  * @internal
  */
-exports.BEFORE_PAUSE = "beforepause", 
+BEFORE_PAUSE = "beforepause", 
 /**
  * @internal
  * Emitted to normalize that content has started loading across various browsers & plugin combinations for analytics timing
  */
-exports.CONTENT_REAL_LOAD_START = "content:loadstart", 
+CONTENT_REAL_LOAD_START = "content:loadstart", 
 /**
  * @public
  * @deprecated
@@ -308,16 +310,88 @@ exports.CONTENT_REAL_LOAD_START = "content:loadstart",
  * you cannot rely on them existing until
  * this event is emitted
  */
-exports.CUEPOINTS = "cuepoints", 
+CUEPOINTS = "cuepoints", 
 /**
  * @public
  * @deprecated
  * when a cuepoint is active
  */
-exports.CUEPOINT_START = "cuepointstart", 
+CUEPOINT_START = "cuepointstart", 
 /**
  * @public
  * @deprecated
  *  when a cuepoint becomes inactive
  */
-exports.CUEPOINT_END = "cuepointend";
+CUEPOINT_END = "cuepointend";
+
+exports.AUDIO_ONLY_SOURCE = AUDIO_ONLY_SOURCE;
+exports.BEFORE_PAUSE = BEFORE_PAUSE;
+exports.BEFORE_PLAY = BEFORE_PLAY;
+exports.CAN_PLAY = CAN_PLAY;
+exports.CLICK = CLICK;
+exports.CONFIG = CONFIG;
+exports.CONTENT_REAL_LOAD_START = CONTENT_REAL_LOAD_START;
+exports.CONTEXT_MENU = CONTEXT_MENU;
+exports.CUEPOINTS = CUEPOINTS;
+exports.CUEPOINT_END = CUEPOINT_END;
+exports.CUEPOINT_START = CUEPOINT_START;
+exports.DATA = DATA;
+exports.DBL_CLICK = DBL_CLICK;
+exports.DURATION_CHANGE = DURATION_CHANGE;
+exports.DVR = DVR;
+exports.ENDED = ENDED;
+exports.ERROR = ERROR;
+exports.FULLSCREEN_CHANGE = FULLSCREEN_CHANGE;
+exports.FULLSCREEN_ENTER = FULLSCREEN_ENTER;
+exports.FULLSCREEN_EXIT = FULLSCREEN_EXIT;
+exports.INTERSECTIONCHANGE = INTERSECTIONCHANGE;
+exports.KEYDOWN = KEYDOWN;
+exports.KEYUP = KEYUP;
+exports.LANDSCAPE = LANDSCAPE;
+exports.LIVE = LIVE;
+exports.LOAD = LOAD;
+exports.LOAD_START = LOAD_START;
+exports.METADATA = METADATA;
+exports.MOUNT = MOUNT;
+exports.MOUSE_DOWN = MOUSE_DOWN;
+exports.MOUSE_ENTER = MOUSE_ENTER;
+exports.MOUSE_LEAVE = MOUSE_LEAVE;
+exports.MOUSE_MOVE = MOUSE_MOVE;
+exports.MOUSE_UP = MOUSE_UP;
+exports.NON_RECOVERABLE_ERROR = NON_RECOVERABLE_ERROR;
+exports.PAUSE = PAUSE;
+exports.PLAY = PLAY;
+exports.PLAYING = PLAYING;
+exports.PLUGIN_REGISTERED = PLUGIN_REGISTERED;
+exports.PORTRAIT = PORTRAIT;
+exports.PROGRESS = PROGRESS;
+exports.QUALITIES = QUALITIES;
+exports.QUALITY_CHANGE = QUALITY_CHANGE;
+exports.REAP = REAP;
+exports.RECOMMENDATIONS_READY = RECOMMENDATIONS_READY;
+exports.RECOVER = RECOVER;
+exports.REMOTE_SESSION_ENDED = REMOTE_SESSION_ENDED;
+exports.REMOTE_SESSION_STARTED = REMOTE_SESSION_STARTED;
+exports.RENDER_PLUGIN = RENDER_PLUGIN;
+exports.RESIZE = RESIZE;
+exports.RETRY = RETRY;
+exports.SCROLL = SCROLL;
+exports.SEEKED = SEEKED;
+exports.SEEKING = SEEKING;
+exports.SEEK_CANCEL = SEEK_CANCEL;
+exports.SEEK_QUEUED = SEEK_QUEUED;
+exports.SET_QUALITY = SET_QUALITY;
+exports.SOURCE = SOURCE;
+exports.STATE = STATE;
+exports.TIME_UPDATE = TIME_UPDATE;
+exports.TOUCH_CANCEL = TOUCH_CANCEL;
+exports.TOUCH_END = TOUCH_END;
+exports.TOUCH_MOVE = TOUCH_MOVE;
+exports.TOUCH_START = TOUCH_START;
+exports.VIDEO_TRACKS = VIDEO_TRACKS;
+exports.VIDEO_TRACK_SELECT = VIDEO_TRACK_SELECT;
+exports.VIEW_ENTER = VIEW_ENTER;
+exports.VIEW_LEAVE = VIEW_LEAVE;
+exports.VOLUME_CHANGE = VOLUME_CHANGE;
+exports.WAITING = WAITING;
+exports.WEBKIT_NEEDKEY = WEBKIT_NEEDKEY;