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

    Interface AudioTrackLaneApi

    interface AudioTrackLaneApi {
        onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>;
        onScrubberCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>;
        onVideoCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>;
        onVttFileLoaded$: Observable<AudioVttFile>;
        get vttFile(): T | undefined;
        set vttFile(vttFile: T | undefined): void;
        get vttUrl(): string | undefined;
        set vttUrl(vttUrl: string | undefined): void;
        loadVtt(
            vttUrl: string,
            options?: VttLoadOptions,
        ): Observable<AudioVttFile | undefined>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    onPlayheadCueEvent$ onScrubberCueEvent$ onVideoCueEvent$ onVttFileLoaded$

    Accessors

    vttFile vttUrl

    Methods

    loadVtt

    Properties

    onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>

    Fires on VTT cue entry/exit on playhead drag

    onScrubberCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>

    Fires on VTT cue entry/exit on scrubber move

    onVideoCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>

    Fires on VTT cue entry/exit on video time change

    onVttFileLoaded$: Observable<AudioVttFile>

    Fires when VTT file is loaded

    Accessors

    Methods

    • Loads data from VTT file

      Parameters

      • vttUrl: string
      • Optionaloptions: VttLoadOptions

      Returns Observable<AudioVttFile | undefined>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods