If true this video will never send its image data to the GPU when its dirty flag is true. This only applies in WebGL.

A reference to the currently running game.

The height of the video in pixels.

Is there a streaming video source? I.e. from a webcam.

The key of the Video in the Cache, if stored there. Will be null if this Video is using the webcam instead.

Gets or sets if the Video is set to loop. Please note that at present some browsers (i.e. Chrome) do not support seamless video looping. If the video isn't yet set this will always return false.

Gets or sets the muted state of the Video.

This signal is dispatched if the user allows access to their webcam.

This signal is dispatched if the Video source is changed. It sends 3 parameters: a reference to the Video object and the new width and height of the new video source.

This signal is dispatched when the Video completes playback, i.e. enters an 'ended' state. Videos set to loop will never dispatch this signal.

This signal is dispatched if an error occurs either getting permission to use the webcam (for a Video Stream) or when trying to play back a video file.

This signal is dispatched when the Video starts to play. It sends 3 parameters: a reference to the Video object, if the video is set to loop or not and the playback rate.

This signal is dispatched if when asking for permission to use the webcam no response is given within a the Video.timeout limit. This may be because the user has picked Not now in the permissions window, or there is a delay in establishing the LocalMediaStream.

Gets or sets the paused state of the Video. If the video is still touch locked (such as on iOS devices) this call has no effect.

Gets or sets the playback rate of the Video. This is the speed at which the video is playing.

True if the video is currently playing (and not paused or ended), otherwise false.

The current retry attempt.

The number of ms between each retry at monitoring the status of a downloading video.

When starting playback of a video Phaser will monitor its readyState using a setTimeout call. The setTimeout happens once every Video.retryInterval ms. It will carry on monitoring the video state in this manner until the retryLimit is reached and then abort.

A snapshot grabbed from the video. This is initially black. Populate it by calling Video.grab(). When called the BitmapData is updated with a grab taken from the current video playing or active video stream. If Phaser has been compiled without BitmapData support this property will always be null.

The PIXI.Texture.

The Frame this video uses for rendering.

The amount of ms allowed to elapsed before the Video.onTimeout signal is dispatched while waiting for webcam access.

true if this video is currently locked awaiting a touch event. This happens on some mobile devices, such as iOS.

The const type of this object.

The HTML Video Element that is added to the document.

The Video Stream data. Only set if this Video is streaming from the webcam via startMediaStream.

Gets or sets the volume of the Video, a value between 0 and 1. The value given is clamped to the range 0 to 1.

The width of the video in pixels.

Updates the given Display Objects so they use this Video as their texture. This will replace any texture they will currently have set.

Creates a new Phaser.Image object, assigns this Video to be its texture, adds it to the world then returns it.

On some mobile browsers you cannot play a video until the user has explicitly touched the video to allow it. Phaser handles this via the setTouchLock method. However if you have 3 different videos, maybe an "Intro", "Start" and "Game Over" split into three different Video objects, then you will need the user to touch-unlock every single one of them.

You can avoid this by using just one Video object and simply changing the video source. Once a Video element is unlocked it remains unlocked, even if the source changes. So you can use this to your benefit to avoid forcing the user to 'touch' the video yet again.

As you'd expect there are limitations. So far we've found that the videos need to be in the same encoding format and bitrate. This method will automatically handle a change in video dimensions, but if you try swapping to a different bitrate we've found it cannot render the new video on iOS (desktop browsers cope better).

When the video source is changed the video file is requested over the network. Listen for the onChangeSource signal to know when the new video has downloaded enough content to be able to be played. Previous settings such as the volume and loop state are adopted automatically by the new video.

Called when the video completes playback (reaches and ended state). Dispatches the Video.onComplete signal.

Connects to an external media stream for the webcam, rather than using a local one.

Creates a new Video element from the given Blob. The Blob must contain the video data in the correct encoded format. This method is typically called by the Phaser.Loader and Phaser.Cache for you, but is exposed publicly for convenience.

Creates a new Video element from the given URL.

Destroys the Video object. This calls Video.stop and then Video.removeVideoElement. If any Sprites are using this Video as their texture it is up to you to manage those.

Grabs the current frame from the Video or Video Stream and renders it to the Video.snapshot BitmapData.

You can optionally set if the BitmapData should be cleared or not, the alpha and the blend mode of the draw.

If you need more advanced control over the grabbing them call Video.snapshot.copy directly with the same parameters as BitmapData.copy.

Starts this video playing if it's not already doing so.

Removes the Video element from the DOM by calling parentNode.removeChild on itself. Also removes the autoplay and src attributes and nulls the reference.

If the game is running in WebGL this will push the texture up to the GPU if it's dirty. This is called automatically if the Video is being used by a Sprite, otherwise you need to remember to call it in your render function. If you wish to suppress this functionality set Video.disableTextureUpload to true.

Sets the Input Manager touch callback to be Video.unlock. Required for mobile video unlocking. Mostly just used internally.

Instead of playing a video file this method allows you to stream video data from an attached webcam.

As soon as this method is called the user will be prompted by their browser to "Allow" access to the webcam. If they allow it the webcam feed is directed to this Video. Call Video.play to start the stream.

If they block the webcam the onError signal will be dispatched containing the NavigatorUserMediaError or MediaStreamError event.

You can optionally set a width and height for the stream. If set the input will be cropped to these dimensions. If not given then as soon as the stream has enough data the video dimensions will be changed to match the webcam device. You can listen for this with the onChangeSource signal.

Stops the video playing.

This removes all locally set signals.

If you only wish to pause playback of the video, to resume at a later time, use Video.paused = true instead. If the video hasn't finished downloading calling Video.stop will not abort the download. To do that you need to call Video.destroy instead.

If you are using a video stream from a webcam then calling Stop will disconnect the MediaStream session and disable the webcam.

Enables the video on mobile devices, usually after the first touch. If the SoundManager hasn't been unlocked then this will automatically unlock that as well. Only one video can be pending unlock at any one time.

Called automatically if the video source changes and updates the internal texture dimensions. Then dispatches the onChangeSource signal.