Interface UIContainerProps

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

Hierarchy

Properties

autoplay: undefined | boolean
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).

casting: undefined | boolean
centeredChrome?: ReactNode

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

centeredLoading?: ReactNode

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

children?: undefined
configuration: undefined | PlayerConfiguration
deviceType: undefined | DeviceType
dvrThreshold: undefined | number
ended: undefined | boolean
error?: ReactNode

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

fluid: undefined | boolean
fullscreen: undefined | boolean
menu?: ReactNode

A slot for extra menus (see Menu).

middleChrome?: ReactNode

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

muted: undefined | boolean
onReady?: ((player) => void)

Called when the backing player is created.

Type declaration

    • (player): void
    • Called when the backing player is created.

      Parameters

      Returns void

Param: player

paused: undefined | boolean
player: undefined | ChromelessPlayer
source: undefined | SourceDescription
streamType: undefined | StreamType
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).

userIdleTimeout: undefined | number

Methods

  • Parameters

    • attrName: string
    • oldValue: any
    • newValue: any

    Returns void

  • Returns void

  • Returns void

Generated using TypeDoc