PixiJS API Documentation

Class: VideoResource

PIXI .resources.VideoResource

Resource type for HTMLVideoElement.

new PIXI.resources.VideoResource (source, options)

VideoResource.js:17

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
`crossorigin`	boolean	true	optional Load image using cross origin

Extends

PIXI.resources.BaseImageResource

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.

onResize Runner inherited

Mini-runner for handling resize events

onUpdate Runner inherited

Mini-runner for handling update events

source HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | SVGElement readonly inherited

The source element

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 VideoResource.js:287

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 Resource.js:71

Bind to a parent BaseTexture

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Parent texture

destroy () inherited Resource.js:203

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

dispose () protected inherited overrides Resource.js:193

Clean up anything, this happens when destroying is ready.

load ()Promise protected inherited overrides Resource.js:135

This can be overriden to start preloading a resource or do any other prepare step.

Returns:

Type	Description
Promise	Handle the validate event

resize () inherited Resource.js:98

Trigger a resize event

style (renderer, baseTexture, glTexture)boolean inherited Resource.js:183

Set the style, optional to override

Name	Type	Description
`renderer`	PIXI.Renderer	yeah, renderer!
`baseTexture`	PIXI.BaseTexture	the texture
`glTexture`	PIXI.glCore.Texture	texture instance for this webgl context

Returns:

Type	Description
boolean	`true` is success

unbind (baseTexture) inherited Resource.js:89

Unbind to a parent BaseTexture

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Parent texture

update () inherited Resource.js:121

Has been updated trigger event

upload (renderer, baseTexture, glTexture, source) inherited BaseImageResource.js:55

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.glCore.GLTexture	Reference
`source`	HTMLImageElement \| HTMLCanvasElement \| HTMLVideoElement \| SVGElement	(optional)