Interface UIContainerProps

interface UIContainerProps {
    attributeChangedCallback?: (
        attrName: string,
        oldValue: any,
        newValue: any,
    ) => void;
    autoplay?: boolean;
    bottomChrome?: ReactNode;
    casting?: boolean;
    centeredChrome?: ReactNode;
    centeredLoading?: ReactNode;
    children?: undefined;
    configuration?: UIPlayerConfiguration;
    connectedCallback?: () => void;
    deviceType?: DeviceType;
    disconnectedCallback?: () => void;
    dvrThreshold?: number;
    ended?: boolean;
    error?: ReactNode;
    fluid?: boolean;
    fullscreen?: boolean;
    menu?: ReactNode;
    middleChrome?: ReactNode;
    muted?: boolean;
    onReady?: (player: ChromelessPlayer) => void;
    paused?: boolean;
    player?: ChromelessPlayer;
    source?: SourceDescription;
    streamType?: StreamType;
    topChrome?: ReactNode;
    userIdleTimeout?: number;
}

Hierarchy

Properties

attributeChangedCallback? autoplay? bottomChrome? casting? centeredChrome? centeredLoading? children? configuration? connectedCallback? deviceType? disconnectedCallback? dvrThreshold? ended? error? fluid? fullscreen? menu? middleChrome? muted? onReady? paused? player? source? streamType? topChrome? userIdleTimeout?

Properties

OptionalattributeChangedCallback

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

Optionalautoplay

autoplay?: boolean

OptionalbottomChrome

bottomChrome?: ReactNode

A slot for controls at the bottom of the player.

Can be used for controls such as a play button (PlayButton) or a seek bar (TimeRange).

Optionalcasting

casting?: boolean

OptionalcenteredChrome

centeredChrome?: ReactNode

A slot for controls centered on the player, on top of other controls.

OptionalcenteredLoading

centeredLoading?: ReactNode

A slot for a loading indicator centered on the player, on top of other controls but behind the centered chrome.

Optionalchildren

children?: undefined

Use a named slot instead, such as:

Optionalconfiguration

configuration?: UIPlayerConfiguration

OptionalconnectedCallback

connectedCallback?: () => void

OptionaldeviceType

deviceType?: DeviceType

OptionaldisconnectedCallback

disconnectedCallback?: () => void

OptionaldvrThreshold

dvrThreshold?: number

Optionalended

ended?: boolean

Optionalerror

error?: ReactNode

A slot for an error display, to show when the player encounters a fatal error (see ErrorDisplay).

Optionalfluid

fluid?: boolean

Optionalfullscreen

fullscreen?: boolean

Optionalmenu

menu?: ReactNode

A slot for extra menus (see Menu).

OptionalmiddleChrome

middleChrome?: ReactNode

A slot for controls in the middle of the player (between the top and bottom chrome).

Optionalmuted

muted?: boolean

OptionalonReady

onReady?: (player: ChromelessPlayer) => void

Called when the backing player is created.

Optionalpaused

paused?: boolean

Optionalplayer

player?: ChromelessPlayer

Optionalsource

source?: SourceDescription

OptionalstreamType

streamType?: StreamType

OptionaltopChrome

topChrome?: ReactNode

A slot for controls at the top of the player.

Can be used to display the stream's title, or for a cast button (ChromecastButton).

OptionaluserIdleTimeout

userIdleTimeout?: number

Settings

Member Visibility

On This Page

Properties