Phaser API Documentation

  Version: 
setPaused([value])

Description:

Sets the paused state of the currently loaded video.

If the video is playing, calling this method with true will pause playback. If the video is paused, calling this method with false will resume playback.

If no video is loaded, this method does nothing.

If the video has not yet been played, Video.play will be called with no parameters.

If the video has ended, this method will do nothing.

Parameters:

name type arguments Default description
value boolean <optional> true

The paused value. true if the video should be paused, false to resume it.

Returns:
Description:

This Video Game Object for method chaining.

Since: 3.20.0