@byomakase/omakase-player
    Preparing search index...

    Interface SidecarTrackController<D>

    interface SidecarTrackController<
        D extends SidecarDomController = SidecarDomController,
    > {
        active: boolean;
        domController: D;
        duration: number | undefined;
        onBufferingRequired$: Observable<boolean>;
        onEvent$: Observable<TrackControllerEvent>;
        onShown$: Observable<boolean>;
        residency: SidecarVideoResidency;
        shown: boolean;
        timeWindow: SidecarTimeWindow | undefined;
        warmingUp: boolean;
        destroy(): void;
        loadSource(): Observable<void>;
        setActive(active: boolean): void;
        setTrackState(trackState: MediaContainerTrackState): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    active domController duration onBufferingRequired$ onEvent$ onShown$ residency shown timeWindow warmingUp

    Methods

    destroy loadSource setActive setTrackState

    Properties

    active: boolean

    Whether sidecar is active. Only active sidecar is shown, inactive sidecar only warms up.

    domController: D
    duration: number | undefined

    Sidecar duration in seconds, available once loaded.

    onBufferingRequired$: Observable<boolean>
    onEvent$: Observable<TrackControllerEvent>
    onShown$: Observable<boolean>

    Emits whether sidecar should be shown, see shown.

    residency: SidecarVideoResidency

    Whether sidecar element has its source attached, see SidecarVideoResidency.

    shown: boolean

    Whether sidecar should be shown, sidecar is active and main media time is inside its time window.

    timeWindow: SidecarTimeWindow | undefined

    Resolved time window, available once loaded.

    warmingUp: boolean

    Whether sidecar is warming up hidden, ahead of its time window, or inside it while inactive.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods