Interface ControlBarMarkerBarHandlerApi

A marker bar added to a control bar with ControlBarMarkerBarApi.addMarkerBar

interface ControlBarMarkerBarHandlerApi {
    id: string;
    onEvent$: Observable<ControlBarMarkerBarEvent>;
    state: ControlBarMarkerBarState;
    addTrack(track: string | MarkerTrack): void;
    getTrackIds(): string[];
    removeTrack(trackId: string): void;
    setVisibility(visible: boolean): void;
}

Implemented by

ControlBarMarkerBarHandler

Index

Properties

id onEvent$ state

Methods

addTrack getTrackIds removeTrack setVisibility

Properties

id

id: string

onEvent$

onEvent$: Observable<ControlBarMarkerBarEvent>

state

state: ControlBarMarkerBarState

Current state of the marker bar

Methods

addTrack

addTrack(track: string | MarkerTrack): void
Shows another marker track on the marker bar
Parameters
- track: string | MarkerTrack
  Marker track, or its id, already added to the player
Returns void
- Defined in src/control-bar/control-bar-marker-bar.ts:130

getTrackIds

getTrackIds(): string[]
Returns the ids of the marker tracks shown on the marker bar

Returns string[]
- Defined in src/control-bar/control-bar-marker-bar.ts:141

removeTrack

removeTrack(trackId: string): void
Stops showing a marker track on the marker bar
Parameters
- trackId: string
  Marker track id
Returns void
- Defined in src/control-bar/control-bar-marker-bar.ts:136

setVisibility

setVisibility(visible: boolean): void
Shows or hides the marker bar
Parameters
- visible: boolean
  Marker bar visibility
Returns void
- Defined in src/control-bar/control-bar-marker-bar.ts:124