Interface SubtitlesLaneApi

interface SubtitlesLaneApi {
    onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>;
    onScrubberCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>;
    onVideoCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>;
    onVttFileLoaded$: Observable<SubtitlesVttFile>;
    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 | SubtitlesVttFile>;
}

Hierarchy (View Summary)

Implemented by

Properties

onPlayheadCueEvent$ onScrubberCueEvent$ onVideoCueEvent$ onVttFileLoaded$

Accessors

vttFile vttUrl

Methods

loadVtt

Properties

ReadonlyonPlayheadCueEvent$

onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>

Fires on VTT cue entry/exit on playhead drag

ReadonlyonScrubberCueEvent$

onScrubberCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>

Fires on VTT cue entry/exit on scrubber move

ReadonlyonVideoCueEvent$

onVideoCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>

Fires on VTT cue entry/exit on video time change

ReadonlyonVttFileLoaded$

onVttFileLoaded$: Observable<SubtitlesVttFile>

Fires when VTT file is loaded

Accessors

vttFile

vttUrl

Methods

loadVtt

Settings

Member Visibility

On This Page

Properties
Accessors
Methods