Added all of the Video Events and completed the jsdocs

Author: photonstorm

src/gameobjects/events/VIDEO_COMPLETE_EVENT.js

@@ -0,0 +1,26 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Complete Event.
+ * 
+ * This event is dispatched when a Video finishes playback by reaching the end of its duration. It
+ * is also dispatched if a video marker sequence is being played and reaches the end.
+ * 
+ * Note that not all videos can fire this event. Live streams, for example, have no fixed duration,
+ * so never technically 'complete'.
+ * 
+ * If a video is stopped from playback, via the `Video.stop` method, it will emit the
+ * `VIDEO_STOP` event instead of this one.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('complete', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_COMPLETE
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which completed playback.
+ */
+module.exports = 'complete';

src/gameobjects/events/VIDEO_CREATED_EVENT.js

@@ -0,0 +1,23 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Created Event.
+ * 
+ * This event is dispatched when the texture for a Video has been created. This happens
+ * when enough of the video source has been loaded that the browser is able to render a
+ * frame from it.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('created', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_CREATED
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which raised the event.
+ * @param {integer} width - The width of the video.
+ * @param {integer} height - The height of the video.
+ */
+module.exports = 'created';

src/gameobjects/events/VIDEO_ERROR_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Error Event.
+ * 
+ * This event is dispatched when a Video tries to play a source that does not exist, or is the wrong file type.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('error', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_ERROR
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which threw the error.
+ * @param {Event} event - The native DOM event the browser raised during playback.
+ */
+module.exports = 'error';

src/gameobjects/events/VIDEO_LOOP_EVENT.js

@@ -0,0 +1,26 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Loop Event.
+ * 
+ * This event is dispatched when a Video that is currently playing has looped. This only
+ * happens if the `loop` parameter was specified, or the `setLoop` method was called,
+ * and if the video has a fixed duration. Video streams, for example, cannot loop, as
+ * they have no duration.
+ * 
+ * Looping is based on the result of the Video `timeupdate` event. This event is not
+ * frame-accurate, due to the way browsers work, so please do not rely on this loop
+ * event to be time or frame precise.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('loop', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_LOOP
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which has looped.
+ */
+module.exports = 'loop';

src/gameobjects/events/VIDEO_PLAY_EVENT.js

@@ -0,0 +1,22 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Play Event.
+ * 
+ * This event is dispatched when a Video begins playback. For videos that do not require
+ * interaction unlocking, this is usually as soon as the `Video.play` method is called.
+ * However, for videos that require unlocking, it is fired once playback begins after
+ * they've been unlocked.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('play', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_PLAY
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which started playback.
+ */
+module.exports = 'play';

src/gameobjects/events/VIDEO_SEEKED_EVENT.js

@@ -0,0 +1,19 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Seeked Event.
+ * 
+ * This event is dispatched when a Video completes seeking to a new point in its timeline.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('seeked', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_SEEKED
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which completed seeking.
+ */
+module.exports = 'seeked';

src/gameobjects/events/VIDEO_SEEKING_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Seeking Event.
+ * 
+ * This event is dispatched when a Video _begins_ seeking to a new point in its timeline.
+ * When the seek is complete, it will dispatch the `VIDEO_SEEKED` event to conclude.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('seeking', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_SEEKING
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which started seeking.
+ */
+module.exports = 'seeking';

src/gameobjects/events/VIDEO_STOP_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Stopped Event.
+ * 
+ * This event is dispatched when a Video is stopped from playback via a call to the `Video.stop` method,
+ * either directly via game code, or indirectly as the result of changing a video source or destroying it.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('stop', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_STOP
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which stopped playback.
+ */
+module.exports = 'stop';

src/gameobjects/events/VIDEO_TIMEOUT_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Timeout Event.
+ * 
+ * This event is dispatched when a Video has exhausted its allocated time while trying to connect to a video
+ * source to start playback.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('timeout', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_TIMEOUT
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which timed out.
+ */
+module.exports = 'timeout';

src/gameobjects/events/VIDEO_UNLOCKED_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The Video Game Object Unlocked Event.
+ * 
+ * This event is dispatched when a Video that was prevented from playback due to the browsers
+ * Media Engagement Interaction policy, is unlocked by a user gesture.
+ * 
+ * Listen for it from a Video Game Object instance using `Video.on('unlocked', listener)`.
+ *
+ * @event Phaser.GameObjects.Events#VIDEO_UNLOCKED
+ * @since 3.20.0
+ * 
+ * @param {Phaser.GameObjects.Video} video - The Video Game Object which raised the event.
+ */
+module.exports = 'unlocked';