@theoplayer/react-ui
    Preparing search index...

    Interface UIContainerProps

    interface UIContainerProps {
        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;
        userIdle?: boolean;
        userIdleTimeout?: number;
    }

    Hierarchy

    Index

    Other

    autoplay?: 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?: boolean
    centeredChrome?: ReactNode

    A slot for controls in the center of the player, layered on top of other controls.

    centeredLoading?: ReactNode

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

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

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

    fluid?: boolean
    fullscreen?: 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?: boolean
    onReady?: (player: ChromelessPlayer) => void

    Called when the backing player is created.

    paused?: boolean
    streamType?: 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).

    userIdle?: boolean
    userIdleTimeout?: number

    lifecycle

    connectedCallback?: () => void

    Type Declaration

      • (): void
      • Invoked when the component is added to the document's DOM.

        In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

        connectedCallback() {
        super.connectedCallback();
        addEventListener('keydown', this._handleKeydown);
        }

        Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

        Returns void

    disconnectedCallback?: () => void

    Type Declaration

      • (): void
      • Invoked when the component is removed from the document's DOM.

        This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

        disconnectedCallback() {
        super.disconnectedCallback();
        window.removeEventListener('keydown', this._handleKeydown);
        }

        An element may be re-connected after being disconnected.

        Returns void