Interface TimelineMarkersApi

API for managing markers displayed on the playback timeline.

interface TimelineMarkersApi {
    add(timelineMarker: TimelineMarker): void;
    list(): TimelineMarker[];
    remove(timelineMarker: TimelineMarker): boolean;
}

Index

Methods

add list remove

Methods

add

add(timelineMarker: TimelineMarker): void
Adds a marker to the timeline.

Note:
- Does not check for duplicates/overlaps at the time.
- Dynamically added timeline markers will be cleared when a new source is loaded into the Player.
Parameters
- timelineMarker: TimelineMarker
Returns void
- Defined in src/ts/UIManager.ts:105

list

list(): TimelineMarker[]
Returns the list of all added timeline markers in insertion order.

Returns TimelineMarker[]
- Defined in src/ts/UIManager.ts:117

remove

remove(timelineMarker: TimelineMarker): boolean
Removes a marker from the timeline by reference and returns true if the marker has been part of the timeline and successfully removed, or false if the marker could not be found and thus not removed.
Parameters
- timelineMarker: TimelineMarker
Returns boolean
- Defined in src/ts/UIManager.ts:112