Interface MarkerLaneApi

interface MarkerLaneApi {
    onMarkerCreate$: Observable<MarkerCreateEvent>;
    onMarkerDelete$: Observable<MarkerDeleteEvent>;
    onMarkerFocus$: Observable<MarkerFocusEvent>;
    onMarkerInit$: Observable<MarkerInitEvent>;
    onMarkerSelected$: Observable<MarkerSelectedEvent>;
    onMarkerUpdate$: Observable<MarkerUpdateEvent>;
    onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>;
    onScrubberCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>;
    onVideoCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>;
    onVttFileLoaded$: Observable<MarkerVttFile>;
    get name(): string;
    get vttFile(): undefined | T;
    set vttFile(vttFile: undefined | T): void;
    get vttUrl(): undefined | string;
    set vttUrl(vttUrl: undefined | string): void;
    addMarker(marker: Marker): Marker;
    createMomentMarker(
        config: ConfigWithOptionalStyle<MomentMarkerConfig>,
    ): MomentMarker;
    createPeriodMarker(
        config: ConfigWithOptionalStyle<PeriodMarkerConfig>,
    ): PeriodMarker;
    focusMarker(id: string): void;
    getMarker(id: string): undefined | Marker;
    getMarkerInFocus(): undefined | Marker;
    getMarkers(): MarkerApi[];
    getSelectedMarker(): undefined | MarkerApi;
    loadVtt(
        vttUrl: string,
        options?: VttLoadOptions,
    ): Observable<undefined | MarkerVttFile>;
    removeAllMarkers(): void;
    removeMarker(id: string): void;
    toggleMarker(id: string): void;
    updateMarker(id: string, data: Partial<MarkerApi>): void;
}

Hierarchy

Implemented by

Properties

onMarkerCreate$ onMarkerDelete$ onMarkerFocus$ onMarkerInit$ onMarkerSelected$ onMarkerUpdate$ onPlayheadCueEvent$ onScrubberCueEvent$ onVideoCueEvent$ onVttFileLoaded$

Accessors

name vttFile vttUrl

Methods

addMarker createMomentMarker createPeriodMarker focusMarker getMarker getMarkerInFocus getMarkers getSelectedMarker loadVtt removeAllMarkers removeMarker toggleMarker updateMarker

Properties

ReadonlyonMarkerCreate$

onMarkerCreate$: Observable<MarkerCreateEvent>

Fires on marker create

ReadonlyonMarkerDelete$

onMarkerDelete$: Observable<MarkerDeleteEvent>

Fires on marker delete

ReadonlyonMarkerFocus$

onMarkerFocus$: Observable<MarkerFocusEvent>

Fires on marker focus

ReadonlyonMarkerInit$

onMarkerInit$: Observable<MarkerInitEvent>

Fires on loading the initial list of markers

ReadonlyonMarkerSelected$

onMarkerSelected$: Observable<MarkerSelectedEvent>

Fires on marker selected

ReadonlyonMarkerUpdate$

onMarkerUpdate$: Observable<MarkerUpdateEvent>

Fires on marker update

ReadonlyonPlayheadCueEvent$

onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>

Fires on VTT cue entry/exit on playhead drag

ReadonlyonScrubberCueEvent$

onScrubberCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>

Fires on VTT cue entry/exit on scrubber move

ReadonlyonVideoCueEvent$

onVideoCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>

Fires on VTT cue entry/exit on video time change

ReadonlyonVttFileLoaded$

onVttFileLoaded$: Observable<MarkerVttFile>

Fires when VTT file is loaded

Accessors

name

vttFile

vttUrl

Methods

addMarker

createMomentMarker

createPeriodMarker

focusMarker

getMarker

getMarkerInFocus

getMarkers

getSelectedMarker

loadVtt

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

    Loads data from VTT file

    Parameters

    • vttUrl: string
    • Optionaloptions: VttLoadOptions

    Returns Observable<undefined | MarkerVttFile>

removeAllMarkers

removeMarker

toggleMarker

  • toggleMarker(id: string): void

    Set selected Marker as active

    Parameters

    • id: string

      Marker ID

    Returns void

updateMarker

Settings

Member Visibility

On This Page

Properties
Accessors
Methods