Class VideoResource

Resource type for HTMLVideoElement.

Memberof

PIXI

Hierarchy (view full)

Constructors

constructor

Properties

destroyed internal source src MIME_TYPES TYPES

Accessors

autoUpdate height updateFPS valid width

Methods

bind destroy dispose load resize style unbind update upload crossOrigin test

Constructors

constructor

Properties

Readonly destroyed

destroyed: boolean

If resource has been destroyed.

Default

false

internal

internal: boolean

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

source

source: HTMLVideoElement

Override the source to be the video element.

src

src: string

The url of the resource

Static Readonly MIME_TYPES

MIME_TYPES: Dict<string>

Map of video MIME types that can't be directly derived from file extensions.

Static Readonly TYPES

TYPES: string[]

List of common video file extensions supported by VideoResource.

Accessors

autoUpdate

  • get autoUpdate(): boolean

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

    Returns boolean

  • set autoUpdate(value): void

  • Parameters

    • value: boolean

    Returns void

height

  • get height(): number

  • The height of the resource.

    Returns number

updateFPS

  • get updateFPS(): number

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

    Returns number

  • set updateFPS(value): void

  • Parameters

    • value: number

    Returns void

valid

  • get valid(): boolean

  • Has been validated

    Returns boolean

width

  • get width(): number

  • The width of the resource.

    Returns number

Methods

bind

destroy

  • destroy(): void

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

    Returns void

dispose

  • dispose(): void

  • Destroys this texture.

    Returns void

load

  • load(): Promise<VideoResource>

  • Start preloading the video resource.

    Returns Promise<VideoResource>

    Handle the validate event

resize

  • resize(width, height): void

  • Trigger a resize event

    Parameters

    • width: number

      X dimension

    • height: number

      Y dimension

    Returns void

style

  • style(_renderer, _baseTexture, _glTexture): boolean

  • Set the style, optional to override

    Parameters

    Returns boolean

    • true is success

unbind

update

  • update(_deltaTime?): void

  • Trigger updating of the texture.

    Parameters

    • Optional _deltaTime: number

      time delta since last tick

    Returns void

upload

Static crossOrigin

  • crossOrigin(element, url, crossorigin?): void

  • Set cross origin based detecting the url and the crossorigin

    Parameters

    • element: HTMLImageElement | HTMLVideoElement

      Element to apply crossOrigin

    • url: string

      URL to check

    • Optional crossorigin: string | boolean

      Cross origin value to use

    Returns void

Static test

  • test(source, extension?): source is HTMLVideoElement

  • Used to auto-detect the type of resource.

    Parameters

    • source: unknown

      The source object

    • Optional extension: string

      The extension of source, if set

    Returns source is HTMLVideoElement

    true if video source

Settings

Member Visibility

Theme

On This Page

constructordestroyedinternalsourcesrcMIME_TYPESTYPESautoUpdateheightupdateFPSvalidwidthbinddestroydisposeloadresizestyleunbindupdateuploadcrossOrigintest

Generated using TypeDoc