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

    Interface MarkerListApi

    interface MarkerListApi {
        onMarkerAction$: Observable<MarkerListActionEvent>;
        onMarkerClick$: Observable<MarkerListClickEvent>;
        onMarkerCreate$: Observable<MarkerCreateEvent>;
        onMarkerDelete$: Observable<MarkerDeleteEvent>;
        onMarkerInit$: Observable<MarkerInitEvent>;
        onMarkerSelected$: Observable<MarkerListSelectedEvent>;
        onMarkerUpdate$: Observable<MarkerUpdateEvent>;
        onVttLoaded$: Observable<undefined | MarkerVttFile>;
        get name(): string;
        get thumbnailVttFile(): undefined | ThumbnailVttFile;
        set thumbnailVttFile(thumbnailVttFile: undefined | ThumbnailVttFile): void;
        addMarker(marker: Partial<MarkerApi>): MarkerApi;
        destroy(): void;
        getMarkers(): MarkerApi[];
        getSelectedMarker(): undefined | MarkerApi;
        removeMarker(id: string): void;
        toggleMarker(id: string): void;
        updateMarker(id: string, data: Partial<MarkerApi>): void;
    }

    Hierarchy

    • MarkerAwareApi
      • MarkerListApi
    Index

    Properties

    onMarkerAction$ onMarkerClick$ onMarkerCreate$ onMarkerDelete$ onMarkerInit$ onMarkerSelected$ onMarkerUpdate$ onVttLoaded$

    Accessors

    name thumbnailVttFile

    Methods

    addMarker destroy getMarkers getSelectedMarker removeMarker toggleMarker updateMarker

    Properties

    onMarkerAction$: Observable<MarkerListActionEvent>

    Fires after a custom action element is clicked

    onMarkerClick$: Observable<MarkerListClickEvent>

    Fires after a marker list item row is clicked

    onMarkerCreate$: Observable<MarkerCreateEvent>

    Fires on marker create

    onMarkerDelete$: Observable<MarkerDeleteEvent>

    Fires on marker delete

    onMarkerInit$: Observable<MarkerInitEvent>

    Fires on loading the initial list of markers

    onMarkerSelected$: Observable<MarkerListSelectedEvent>

    Fires after a marker list item is toggled on or off

    onMarkerUpdate$: Observable<MarkerUpdateEvent>

    Fires on marker update

    onVttLoaded$: Observable<undefined | MarkerVttFile>

    Fires after VTT file defined in the config is loaded

    Accessors

    Methods

    • Set selected Marker as active

      Parameters

      • id: string

        Marker ID

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods