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

    Interface PlayerTextApi

    interface PlayerTextApi {
        onEvent$: Observable<PlayerTextEvent>;
        shown: boolean;
        state: PlayerTextState;
        getHandler(trackId: string): TextTrackHandlerApi | undefined;
        getTracks(): TextTrack<TextTrackState, never>[];
        getTracks(playerTextTrackType: MAIN): TextTrack<TextTrackState, never>[];
        getTracks(playerTextTrackType: SIDECAR): TextTrack<TextTrackState, never>[];
        hide(): Observable<void>;
        show(): Observable<void>;
        switchTrack(trackId: string, show?: boolean): Observable<void>;
        toggleShowHide(): Observable<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    onEvent$ shown state

    Methods

    getHandler getTracks hide show switchTrack toggleShowHide

    Properties

    onEvent$: Observable<PlayerTextEvent>

    Observable that emits text events as they occur.

    shown: boolean

    Whether active text tracks are currently visible.

    state: PlayerTextState

    Current text state snapshot.

    Methods

    • Switches the active text track.

      Parameters

      • trackId: string

        ID of the track to switch to.

      • Optionalshow: boolean

        Whether to show the track after switching. Defaults to true.

      Returns Observable<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods