Class ControlBarMarkerBarHandler

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

Implements

ControlBarMarkerBarHandlerApi
Destroyable

Index

Constructors

Accessors

id onEvent$ state

Methods

addTrack destroy getTrackIds removeTrack setVisibility

Constructors

constructor

new ControlBarMarkerBarHandler(
    _markerBar: OmakaseMarkerTrack,
    _resolveTrack: (
        track: string | MarkerTrack,
    ) => MarkerTrackState | undefined,
): ControlBarMarkerBarHandler
Parameters
- _markerBar: OmakaseMarkerTrack
  The marker bar element
- _resolveTrack: (track: string | MarkerTrack) => MarkerTrackState | undefined
  Resolves a marker track, or its id, to its state; undefined when it isn't added to the player
Returns ControlBarMarkerBarHandler
- Defined in src/control-bar/control-bar-marker-bar.ts:159

Accessors

id

get id(): string
Returns string
Implementation of ControlBarMarkerBarHandlerApi.id
- Defined in src/control-bar/control-bar-marker-bar.ts:177

onEvent$

get onEvent$(): Observable<ControlBarMarkerBarEvent>
Returns Observable<ControlBarMarkerBarEvent>
Implementation of ControlBarMarkerBarHandlerApi.onEvent$
- Defined in src/control-bar/control-bar-marker-bar.ts:181

state

get state(): ControlBarMarkerBarState
Current state of the marker bar

Returns ControlBarMarkerBarState
Implementation of ControlBarMarkerBarHandlerApi.state
- Defined in src/control-bar/control-bar-marker-bar.ts:185

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
Implementation of ControlBarMarkerBarHandlerApi.addTrack
- Defined in src/control-bar/control-bar-marker-bar.ts:202

destroy

destroy(): void
Returns void
Implementation of Destroyable.destroy
- Defined in src/control-bar/control-bar-marker-bar.ts:235

getTrackIds

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

Returns string[]
Implementation of ControlBarMarkerBarHandlerApi.getTrackIds
- Defined in src/control-bar/control-bar-marker-bar.ts:224

removeTrack

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

setVisibility

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