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

    Interface PlayerVideoInternalApi

    interface PlayerVideoInternalApi {
        onEvent$: Observable<PlayerVideoEvent>;
        state: PlayerVideoState;
        getTracks(): MediaContainerTrackState[];
        switchTrack(trackId: string, activate?: boolean): Observable<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    onEvent$: Observable<PlayerVideoEvent>

    Observable that emits video events as they occur.

    Current video state snapshot.

    Methods

    • Activates or deactivates sidecar video. Only one sidecar video can be active, activating sidecar video deactivates the previously active one.

      Active sidecar video is shown and played with its sound while main media time is inside its time window, slate or main media is shown otherwise. Every sidecar video warms up - plays hidden and muted - shortly before its time window, to pre-buffer and sync before its cut is shown. Inactive sidecar video keeps warming up inside its time window, so it can be activated without seeking.

      Parameters

      • trackId: string

        ID of the sidecar video track.

      • Optionalactivate: boolean

        Whether to activate or deactivate the track. Defaults to true.

      Returns Observable<void>