Phaser API Documentation

  Version: 
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Event: VIDEO_PLAY
Phaser.GameObjects.Events.VIDEO_PLAY
VIDEO_PLAY

Description:

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).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which started playback.

Since: 3.20.0