@byomakase/omakase-player
    Preparing search index...

    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

    Index

    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

    onMarkerCreate$: Observable<MarkerCreateEvent>

    Fires on marker create

    onMarkerDelete$: Observable<MarkerDeleteEvent>

    Fires on marker delete

    onMarkerFocus$: Observable<MarkerFocusEvent>

    Fires on marker focus

    onMarkerInit$: Observable<MarkerInitEvent>

    Fires on loading the initial list of markers

    onMarkerSelected$: Observable<MarkerSelectedEvent>

    Fires on marker selected

    onMarkerUpdate$: Observable<MarkerUpdateEvent>

    Fires on marker update

    onPlayheadCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>

    Fires on VTT cue entry/exit on playhead drag

    onScrubberCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>

    Fires on VTT cue entry/exit on scrubber move

    onVideoCueEvent$: Observable<OmakaseVttCueEvent<MarkerVttCue>>

    Fires on VTT cue entry/exit on video time change

    onVttFileLoaded$: Observable<MarkerVttFile>

    Fires when VTT file is loaded

    Accessors

    Methods

    • Loads data from VTT file

      Parameters

      • vttUrl: string
      • Optionaloptions: VttLoadOptions

      Returns Observable<undefined | MarkerVttFile>

    • Set selected Marker as active

      Parameters

      • id: string

        Marker ID

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods