-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
VIDEO_STALLED_EVENT.js
33 lines (32 loc) · 1.05 KB
/
VIDEO_STALLED_EVENT.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2024 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Video Game Object Stalled Event.
*
* This event is dispatched by a Video Game Object when the video playback stalls.
*
* This can happen if the video is buffering.
*
* If will fire for any of the following native DOM events:
*
* `stalled`
* `suspend`
* `waiting`
*
* Listen for it from a Video Game Object instance using `Video.on('stalled', listener)`.
*
* Note that being stalled isn't always a negative thing. A video can be stalled if it
* has downloaded enough data in to its buffer to not need to download any more until
* the current batch of frames have rendered.
*
* @event Phaser.GameObjects.Events#VIDEO_STALLED
* @type {string}
* @since 3.60.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 = 'stalled';