Interface AudioTrackLaneApi

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

Hierarchy (View Summary)

Implemented by

Properties

onPlayheadCueEvent$ onScrubberCueEvent$ onVideoCueEvent$ onVttFileLoaded$

Accessors

vttFile vttUrl

Methods

loadVtt

Properties

ReadonlyonPlayheadCueEvent$

onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>

Fires on VTT cue entry/exit on playhead drag

ReadonlyonScrubberCueEvent$

onScrubberCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>

Fires on VTT cue entry/exit on scrubber move

ReadonlyonVideoCueEvent$

onVideoCueEvent$: Observable<OmakaseVttCueEvent<AudioVttCue>>

Fires on VTT cue entry/exit on video time change

ReadonlyonVttFileLoaded$

onVttFileLoaded$: Observable<AudioVttFile>

Fires when VTT file is loaded

Accessors

vttFile

vttUrl

Methods

loadVtt

  • loadVtt(
        vttUrl: string,
        options?: VttLoadOptions,
    ): Observable<undefined | AudioVttFile>

  • Loads data from VTT file

    Parameters

    • vttUrl: string
    • Optionaloptions: VttLoadOptions

    Returns Observable<undefined | AudioVttFile>

Settings

Member Visibility

On This Page

Properties
Accessors
Methods