Class: VideoResource

PIXI.resources.VideoResource

Resource type for HTMLVideoElement.

new PIXI.resources.VideoResource (source, options)

Name Type Description
source HTMLVideoElement | object | string | Array.<(string|object)>

Video element to use.

options object optional

Options to use

Name Type Default Description
autoLoad boolean true optional

Start loading the video immediately

autoPlay boolean true optional

Start playing video immediately

updateFPS number 0 optional

How many times a second to update the texture from the video. Leave at 0 to update at every render.

crossorigin boolean true optional

Load image using cross origin

Extends

Members

PIXI.resources.VideoResource.TYPES Array.<string> staticreadonly

List of common video file extensions supported by VideoResource.

_height number protected inherited

Internal height of the resource

_width number protected inherited

Internal width of the resource

autoPlay boolean

When set to true will automatically play videos used by this texture once they are loaded. If false, it will not modify the playing state.

Default Value:
  • true

autoUpdate boolean

Should the base texture automatically update itself, set to true by default

destroyed boolean readonly inherited

If resource has been destroyed

Default Value:
  • false

height number readonly inherited

The height of the resource.

internal boolean protected inherited

true if resource is created by BaseTexture useful for doing cleanup with BaseTexture destroy and not cleaning up resources that were created externally.

source HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | SVGElement readonly inherited

The source element

updateFPS number

How many times a second to update the texture from the video. Leave at 0 to update at every render. A lower fps can help performance, as updating the texture at 60fps on a 30ps video may not be efficient.

valid boolean readonly inherited

Has been validated

width number readonly inherited

The width of the resource.

Methods

PIXI.resources.VideoResource.test (source, extension)boolean static

Used to auto-detect the type of resource.

Name Type Description
source *

The source object

extension string

The extension of source, if set

Returns:
Type Description
boolean true if video source

bind (baseTexture) inherited

Bind to a parent BaseTexture

Name Type Description
baseTexture PIXI.BaseTexture

Parent texture

Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

dispose () protected inherited overrides

Clean up anything, this happens when destroying is ready.

load ()Promise.<void> protected overrides

Start preloading the video resource.

Returns:
Type Description
Promise.<void> Handle the validate event

resize (width, height) inherited

Trigger a resize event

Name Type Description
width number

X dimension

height number

Y dimension

style (renderer, baseTexture, glTexture)boolean inherited

Set the style, optional to override

Name Type Description
renderer PIXI.Renderer

yeah, renderer!

baseTexture PIXI.BaseTexture

the texture

glTexture PIXI.GLTexture

texture instance for this webgl context

Returns:
Type Description
boolean true is success

unbind (baseTexture) inherited

Unbind to a parent BaseTexture

Name Type Description
baseTexture PIXI.BaseTexture

Parent texture

update (deltaTime) overrides

Trigger updating of the texture

Name Type Default Description
deltaTime number 0 optional

time delta since last tick

upload (renderer, baseTexture, glTexture, source)boolean inherited

Upload the texture to the GPU.

Name Type Description
renderer PIXI.Renderer

Upload to the renderer

baseTexture PIXI.BaseTexture

Reference to parent texture

glTexture PIXI.GLTexture
source HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | SVGElement optional

(optional)

Returns:
Type Description
boolean true is success