Interface PlayerConfig

interface PlayerConfig {
    src: string;
    autoplay?: boolean;
    muted?: boolean;
    volume?: number;
    playbackRate?: number;
    poster?: string;
    width?: string | number;
    height?: string | number;
    controls?: boolean;
    loop?: boolean;
    preload?: "none" | "metadata" | "auto";
    crossOrigin?: "" | "anonymous" | "use-credentials";
    playsInline?: boolean;
    uiMode?: UIMode;
    uiConfig?: ControlBarConfig;
    logger?: Logger;
    debug?: boolean;
    builtinPlugins?: {
        playbackRate?: boolean | {
            defaultRate?: number;
            options?: {
                value: number;
                label: string;
            }[];
        };
    };
    theme?: PlayerTheme;
    controlBar?: ControlBarConfig;
    customUI?: boolean;
}

Hierarchy (view full)

Properties

src autoplay? muted? volume? playbackRate? poster? width? height? controls? loop? preload? crossOrigin? playsInline? uiMode? uiConfig? logger? debug? builtinPlugins? theme? controlBar? customUI?

Properties

src

src: string

Optional autoplay

autoplay?: boolean

Optional muted

muted?: boolean

Optional volume

volume?: number

Optional playbackRate

playbackRate?: number

Optional poster

poster?: string

Optional width

width?: string | number

Optional height

height?: string | number

Optional controls

controls?: boolean

Optional loop

loop?: boolean

Optional preload

preload?: "none" | "metadata" | "auto"

Optional crossOrigin

crossOrigin?: "" | "anonymous" | "use-credentials"

Optional playsInline

playsInline?: boolean

Optional uiMode

uiMode?: UIMode

Optional uiConfig

uiConfig?: ControlBarConfig

Optional logger

logger?: Logger

Optional debug

debug?: boolean

Optional builtinPlugins

builtinPlugins?: {
    playbackRate?: boolean | {
        defaultRate?: number;
        options?: {
            value: number;
            label: string;
        }[];
    };
}

Type declaration

  • Optional playbackRate?: boolean | {
        defaultRate?: number;
        options?: {
            value: number;
            label: string;
        }[];
    }

Optional theme

theme?: PlayerTheme

Optional controlBar

controlBar?: ControlBarConfig

Optional customUI

customUI?: boolean

Settings

Member Visibility

Theme

On This Page

srcautoplaymutedvolumeplaybackRateposterwidthheightcontrolslooppreloadcrossOriginplaysInlineuiModeuiConfigloggerdebugbuiltinPluginsthemecontrolBarcustomUI