Interface LoadVideoConfig

Configuration for the loadVideo loader parser.

PIXI

PIXI.loadVideo

interface LoadVideoConfig {
    defaultAutoPlay: boolean;
    defaultLoop: boolean;
    defaultMuted: boolean;
    defaultPlaysinline: boolean;
    defaultUpdateFPS: number;
}

Properties

defaultAutoPlay: boolean

When set to true, the video will start playing automatically after being loaded, otherwise it will not start playing automatically.

true
defaultLoop: boolean

When set to true, the loaded video will loop by default.

false
defaultMuted: boolean

When set to true, the loaded video will be muted.

false
defaultPlaysinline: boolean

When set to true, opening the video on mobile devices is prevented.

true
defaultUpdateFPS: number

How many times a second to update the texture of the loaded video by default. If 0, requestVideoFrameCallback is used to update the texture. If requestVideoFrameCallback is not available, the texture is updated every render.

0