Interface ControlBarMarkerBarApi

Marker bars API of a standalone control bar, available as ControlBarApi.markerBar

interface ControlBarMarkerBarApi {
    addMarkerBar(
        markerBars: string | HTMLElement,
        tracks?: string | MarkerTrack | (string | MarkerTrack)[],
        config?: Partial<ControlBarMarkerBarConfig>,
    ): ControlBarMarkerBarHandlerApi;
    deleteMarkerBar(id: string): void;
    getMarkerBar(id: string): ControlBarMarkerBarHandlerApi | undefined;
    getMarkerBars(): ControlBarMarkerBarHandlerApi[];
}

Implemented by

ControlBarMarkerBar

Index

Methods

addMarkerBar deleteMarkerBar getMarkerBar getMarkerBars

Methods

addMarkerBar

addMarkerBar(
    markerBars: string | HTMLElement,
    tracks?: string | MarkerTrack | (string | MarkerTrack)[],
    config?: Partial<ControlBarMarkerBarConfig>,
): ControlBarMarkerBarHandlerApi
Adds a marker bar to an <omakase-marker-bars> of the control bar, showing the given marker tracks
Parameters
- markerBars: string | HTMLElement
  The <omakase-marker-bars> element, or a query selector for it within the control bar
- Optionaltracks: string | MarkerTrack | (string | MarkerTrack)[]
  Marker tracks, or their ids, already added to the player
- Optionalconfig: Partial<ControlBarMarkerBarConfig>
  Marker bar configuration
Returns ControlBarMarkerBarHandlerApi
Handler of the added marker bar
- Defined in src/control-bar/control-bar-marker-bar.ts:83

deleteMarkerBar

deleteMarkerBar(id: string): void
Deletes a marker bar added with addMarkerBar
Parameters
- id: string
  Marker bar id
Returns void
- Defined in src/control-bar/control-bar-marker-bar.ts:104

getMarkerBar

getMarkerBar(id: string): ControlBarMarkerBarHandlerApi | undefined
Returns the handler of a marker bar added with addMarkerBar
Parameters
- id: string
  Marker bar id
Returns ControlBarMarkerBarHandlerApi | undefined
- Defined in src/control-bar/control-bar-marker-bar.ts:98

getMarkerBars

getMarkerBars(): ControlBarMarkerBarHandlerApi[]
Returns the handlers of the marker bars added with addMarkerBar

Returns ControlBarMarkerBarHandlerApi[]
- Defined in src/control-bar/control-bar-marker-bar.ts:92