Interface ChromingMarkerBarHandlerApi

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

Implemented by

ChromingMarkerBarHandler

Index

Properties

id onEvent$ state

Methods

addTrack getTrackIds removeTrack restoreState setVisibility

Properties

id

id: string

onEvent$

onEvent$: Observable<ChromingMarkerBarEvent>

state

state: ChromingMarkerBarState

Current state of the marker bar.

Methods

addTrack

addTrack(track: string | MarkerTrack): Observable<void>
Add another marker track.
Parameters
- track: string | MarkerTrack
  Marker track or marker track id
Returns Observable<void>
- Defined in src/chroming/chroming-marker-bar.ts:161

getTrackIds

getTrackIds(): string[]
Returns a list of track ids associated with the marker bar

Returns string[]
- Defined in src/chroming/chroming-marker-bar.ts:172

removeTrack

removeTrack(trackId: string): Observable<void>
Remove marker track.
Parameters
- trackId: string
  Marker track id
Returns Observable<void>
- Defined in src/chroming/chroming-marker-bar.ts:167

restoreState

restoreState(state: ChromingMarkerBarState): Observable<void>
Internal method. Restores the state of the marker track from the session.
Parameters
- state: ChromingMarkerBarState
  Marker track state
Returns Observable<void>
- Defined in src/chroming/chroming-marker-bar.ts:178

setVisibility

setVisibility(visible: boolean): Observable<void>
Hide or show the marker bar.
Parameters
- visible: boolean
  Marker bar visibility
Returns Observable<void>
- Defined in src/chroming/chroming-marker-bar.ts:155