Interface OgChartLaneApi

interface OgChartLaneApi {
    onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<OgChartVttCue>>;
    onScrubberCueEvent$: Observable<OmakaseVttCueEvent<OgChartVttCue>>;
    onVideoCueEvent$: Observable<OmakaseVttCueEvent<OgChartVttCue>>;
    onVttFileLoaded$: Observable<OgChartVttFile>;
    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 | OgChartVttFile>;
}

Hierarchy (View Summary)

Api
VttAwareApi<OgChartVttCue, OgChartVttFile>
- OgChartLaneApi

Implemented by

OgChartLane

Index

Properties

onPlayheadCueEvent$ onScrubberCueEvent$ onVideoCueEvent$ onVttFileLoaded$

Accessors

Methods

Properties

`Readonly`onPlayheadCueEvent$

onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<OgChartVttCue>>

Fires on VTT cue entry/exit on playhead drag

`Readonly`onScrubberCueEvent$

onScrubberCueEvent$: Observable<OmakaseVttCueEvent<OgChartVttCue>>

Fires on VTT cue entry/exit on scrubber move

`Readonly`onVideoCueEvent$

onVideoCueEvent$: Observable<OmakaseVttCueEvent<OgChartVttCue>>

Fires on VTT cue entry/exit on video time change

`Readonly`onVttFileLoaded$

onVttFileLoaded$: Observable<OgChartVttFile>

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