Interface DefaultUIProps

interface DefaultUIProps {
    attributeChangedCallback?: (
        attrName: string,
        oldValue: any,
        newValue: any,
    ) => void;
    autoplay?: boolean;
    bottomControlBar?: ReactNode;
    children?: undefined;
    configuration?: UIPlayerConfiguration;
    connectedCallback?: () => void;
    disconnectedCallback?: () => void;
    dvrThreshold?: number;
    error?: ReactNode;
    fluid?: boolean;
    menu?: ReactNode;
    muted?: boolean;
    onReady?: (player: ChromelessPlayer) => void;
    player?: ChromelessPlayer;
    source?: SourceDescription;
    streamType?: StreamType;
    title?: ReactNode;
    topControlBar?: ReactNode;
    userIdleTimeout?: number;
}

Hierarchy

Properties

attributeChangedCallback? autoplay? bottomControlBar? children? configuration? connectedCallback? disconnectedCallback? dvrThreshold? error? fluid? menu? muted? onReady? player? source? streamType? title? topControlBar? userIdleTimeout?

Properties

OptionalattributeChangedCallback

attributeChangedCallback?: (
    attrName: string,
    oldValue: any,
    newValue: any,
) => void

Optionalautoplay

autoplay?: boolean

OptionalbottomControlBar

bottomControlBar?: ReactNode

A slot for extra UI controls in the bottom control bar.

Optionalchildren

children?: undefined

Use a named slot instead, such as:

Optionalconfiguration

configuration?: UIPlayerConfiguration

OptionalconnectedCallback

connectedCallback?: () => void

OptionaldisconnectedCallback

disconnectedCallback?: () => void

OptionaldvrThreshold

dvrThreshold?: number

Optionalerror

error?: ReactNode

A slot for an error display, to show when the player encounters a fatal error. By default, this shows an ErrorDisplay.

Optionalfluid

fluid?: boolean

Optionalmenu

menu?: ReactNode

A slot for extra menus (see Menu).

Optionalmuted

muted?: boolean

OptionalonReady

onReady?: (player: ChromelessPlayer) => void

Called when the backing player is created.

Optionalplayer

player?: ChromelessPlayer

Optionalsource

source?: SourceDescription

OptionalstreamType

streamType?: StreamType

Optionaltitle

title?: ReactNode

A slot for the stream's title in the top control bar.

OptionaltopControlBar

topControlBar?: ReactNode

A slot for extra UI controls in the top control bar.

OptionaluserIdleTimeout

userIdleTimeout?: number

Settings

Member Visibility

On This Page

Properties