Interface SubtitlesLaneApi

interface SubtitlesLaneApi {
    onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>;
    onScrubberCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>;
    onVideoCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>;
    onVttFileLoaded$: Observable<SubtitlesVttFile>;
    vttFile: undefined | T;
    vttUrl: undefined | string;
    loadVtt(vttUrl: string, options?: VttLoadOptions): Observable<undefined | SubtitlesVttFile>;
}

Hierarchy (view full)

Api
VttAwareApi<SubtitlesVttCue, SubtitlesVttFile>
- SubtitlesLaneApi

Implemented by

SubtitlesLane

Index

Properties

onPlayheadCueEvent$ onScrubberCueEvent$ onVideoCueEvent$ onVttFileLoaded$

Accessors

Methods

Properties

`Readonly`onPlayheadCueEvent$

onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>

Fires on VTT cue entry/exit on playhead drag

`Readonly`onScrubberCueEvent$

onScrubberCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>

Fires on VTT cue entry/exit on scrubber move

`Readonly`onVideoCueEvent$

onVideoCueEvent$: Observable<OmakaseVttCueEvent<SubtitlesVttCue>>

Fires on VTT cue entry/exit on video time change

`Readonly`onVttFileLoaded$

onVttFileLoaded$: Observable<SubtitlesVttFile>

Fires when VTT file is loaded

Accessors

vttFile

get vttFile(): undefined | T
VTT file content

Returns undefined | T
Inherited from VttAwareApi.vttFile
- Defined in project/src/api/vtt-aware-api.ts:33
set vttFile(vttFile): void
Parameters
- vttFile: undefined | T
Returns void
Inherited from VttAwareApi.vttFile
- Defined in project/src/api/vtt-aware-api.ts:35

vttUrl

get vttUrl(): undefined | string
URL pointing to the VTT file

Returns undefined | string
Inherited from VttAwareApi.vttUrl
- Defined in project/src/api/vtt-aware-api.ts:26
set vttUrl(vttUrl): void
Parameters
- vttUrl: undefined | string
Returns void
Inherited from VttAwareApi.vttUrl
- Defined in project/src/api/vtt-aware-api.ts:28

Methods

loadVtt

loadVtt(vttUrl, options?): Observable<undefined | SubtitlesVttFile>
Loads data from VTT file
Parameters
- vttUrl: string
- Optionaloptions: VttLoadOptions
Returns Observable<undefined | SubtitlesVttFile>
Inherited from VttAwareApi.loadVtt
- Defined in project/src/api/vtt-aware-api.ts:66