Interface DefaultUIProps

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

Hierarchy

Properties

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

Methods

attributeChangedCallback? connectedCallback? disconnectedCallback?

Properties

autoplay

autoplay: undefined | boolean

Optional bottomControlBar

bottomControlBar?: ReactNode

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

Optional children

children?: undefined

Use a named slot instead, such as:

configuration

configuration: undefined | PlayerConfiguration

dvrThreshold

dvrThreshold: undefined | number

fluid

fluid: undefined | boolean

Optional menu

menu?: ReactNode

A slot for extra menus (see Menu).

muted

muted: undefined | boolean

Optional onReady

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

player

player: undefined | ChromelessPlayer

source

source: undefined | SourceDescription

streamType

streamType: undefined | StreamType

Optional title

title?: ReactNode

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

Optional topControlBar

topControlBar?: ReactNode

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

userIdleTimeout

userIdleTimeout: undefined | number

Methods

Optional attributeChangedCallback

  • attributeChangedCallback(attrName, oldValue, newValue): void

  • Parameters

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

    Returns void

Optional connectedCallback

  • connectedCallback(): void

  • Returns void

Optional disconnectedCallback

  • disconnectedCallback(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc