Class TimelineImpl

Implements

TimelineApi
Destroyable

Index

Constructors

Accessors

config descriptionPaneVisible id onEvent$ ready state style timecodedFloatingGroup

Methods

addTimelineLane addTimelineLaneAtIndex addTimelineLanes addToFooterFlexGroup addToSurfaceLayerTimecodedFloatingContent addToTimecodedFloatingContent addToTimecodedStaticContent constrainTimelinePosition destroy getHorizontalScrollPercent getScrollHandleHorizontals getScrubberLane getTimecodedContainerDimension getTimecodedFloatingDimension getTimecodedFloatingHorizontals getTimecodedFloatingPosition getTimecodedFloatingRect getTimecodedFloatingRelativePointerPosition getTimelineLane getTimelineLanes getVisiblePositionRange getVisibleTimeRange getZoomPercent maximizeTimelineLanes minimizeTimelineLanes removeAllTimelineLanes removeTimelineLane removeTimelineLanes scrollHorizontallyToPercent scrollTimeline scrollToEased scrollToPlayheadEased setDescriptionPaneVisible setDescriptionPaneVisibleEased setThumbnailTrack settleLayout timelineContainerPositionToTime timelinePositionToTime timelinePositionToTimecode timeToTimelinePosition toggleDescriptionPaneVisible toggleDescriptionPaneVisibleEased toggleTimecodeEdit zoomInEased zoomOutEased zoomTo zoomToEased zoomToMaxEased

Constructors

constructor

new TimelineImpl(
    player: PlayerApi,
    ompProvider: OmpProvider,
    configAndStyle?: ConfigAndStyle<TimelineConfig, TimelineStyle>,
): TimelineImpl
Parameters
- player: PlayerApi
- ompProvider: OmpProvider
- OptionalconfigAndStyle: ConfigAndStyle<TimelineConfig, TimelineStyle>
Returns TimelineImpl
- Defined in src/timeline/timeline.ts:205

Accessors

config

get config(): TimelineConfig
Returns TimelineConfig
- Defined in src/timeline/timeline.ts:1709

descriptionPaneVisible

get descriptionPaneVisible(): boolean
Returns boolean
true if visible, false if not visible
Implementation of TimelineApi.descriptionPaneVisible
- Defined in src/timeline/timeline.ts:1713

id

get id(): string
Unique identifier for this timeline instance.

Returns string
Implementation of TimelineApi.id
- Defined in src/timeline/timeline.ts:1845

onEvent$

get onEvent$(): Observable<TimelineEvent>
Stream of all events emitted by this timeline instance, including lifecycle events (TimelineEventType.TIMELINE_READY), viewport changes (TimelineEventType.TIMELINE_SCROLL, TimelineEventType.TIMELINE_ZOOM, TimelineEventType.TIMELINE_RESIZE), and interaction events (TimelineEventType.TIMELINE_TIMECODE_CLICK, TimelineEventType.TIMELINE_SCRUBBER_MOVE, TimelineEventType.TIMELINE_PLAYHEAD_MOVE).

Returns Observable<TimelineEvent>
Implementation of TimelineApi.onEvent$
- Defined in src/timeline/timeline.ts:1841

ready

get ready(): boolean
Returns boolean
- Defined in src/timeline/timeline.ts:1853

state

get state(): TimelineState
Current runtime state of the timeline.

Returns TimelineState
See
TimelineState
Implementation of TimelineApi.state
- Defined in src/timeline/timeline.ts:1861

style

get style(): TimelineStyle
Current style configuration of the timeline. Reflects the active visual settings such as dimensions, colours, and playhead appearance.

Returns TimelineStyle
See
TimelineStyle
Implementation of TimelineApi.style
- Defined in src/timeline/timeline.ts:1857

timecodedFloatingGroup

get timecodedFloatingGroup(): Group
Returns Group
- Defined in src/timeline/timeline.ts:1849

Methods

addTimelineLane

addTimelineLane(timelineLane: TimelineLaneApi): TimelineLaneApi
Adds TimelineLaneApi instance to timeline
Parameters
- timelineLane: TimelineLaneApi
Returns TimelineLaneApi
Implementation of TimelineApi.addTimelineLane
- Defined in src/timeline/timeline.ts:1378

addTimelineLaneAtIndex

addTimelineLaneAtIndex(
timelineLane: TimelineLaneApi,
index: number,
): TimelineLaneApi
Adds TimelineLaneApi instance to timeline
Parameters
- timelineLane: TimelineLaneApi
- index: number
Returns TimelineLaneApi
Implementation of TimelineApi.addTimelineLaneAtIndex
- Defined in src/timeline/timeline.ts:1386

addTimelineLanes

addTimelineLanes(
timelineLanes: TimelineLaneApi<TimelineLaneStyle>[],
): TimelineLaneApi<TimelineLaneStyle>[]
Adds multiple instantiated TimelineLaneApi instances to timeline
Parameters
- timelineLanes: TimelineLaneApi<TimelineLaneStyle>[]
Returns TimelineLaneApi<TimelineLaneStyle>[]
Implementation of TimelineApi.addTimelineLanes
- Defined in src/timeline/timeline.ts:1473

addToFooterFlexGroup

addToFooterFlexGroup(flexNode: FlexNode<any>): void
Parameters
- flexNode: FlexNode<any>
Returns void
- Defined in src/timeline/timeline.ts:1514

addToSurfaceLayerTimecodedFloatingContent

addToSurfaceLayerTimecodedFloatingContent(
node: Group | Shape<ShapeConfig>,
zIndex?: number,
): void
Parameters
- node: Group | Shape<ShapeConfig>
- zIndex: number = 0
Returns void
- Defined in src/timeline/timeline.ts:1506

addToTimecodedFloatingContent

addToTimecodedFloatingContent(
node: Group | Shape<ShapeConfig>,
zIndex?: number,
): void
Parameters
- node: Group | Shape<ShapeConfig>
- zIndex: number = 0
Returns void
- Defined in src/timeline/timeline.ts:1494

addToTimecodedStaticContent

addToTimecodedStaticContent(
node: Group | Shape<ShapeConfig>,
zIndex?: number,
): void
Parameters
- node: Group | Shape<ShapeConfig>
- zIndex: number = 0
Returns void
- Defined in src/timeline/timeline.ts:1502

constrainTimelinePosition

constrainTimelinePosition(x: number): number
Parameters
- x: number
Returns number
- Defined in src/timeline/timeline.ts:1518

destroy

destroy(): void
Destroys Timeline and it's dependencies

Returns void
Implementation of TimelineApi.destroy
- Defined in src/timeline/timeline.ts:1865

getHorizontalScrollPercent

getHorizontalScrollPercent(): number
Returns number
- Defined in src/timeline/timeline.ts:964

getScrollHandleHorizontals

getScrollHandleHorizontals(scrollbarWidth: number): Horizontals
Parameters
- scrollbarWidth: number
Returns Horizontals
- Defined in src/timeline/timeline.ts:981

getScrubberLane

getScrubberLane(): ScrubberLane
Returns ScrubberLane
ScrubberLane instance
Implementation of TimelineApi.getScrubberLane
- Defined in src/timeline/timeline.ts:1488

getTimecodedContainerDimension

getTimecodedContainerDimension(): Dimension
Returns Dimension
- Defined in src/timeline/timeline.ts:1560

getTimecodedFloatingDimension

getTimecodedFloatingDimension(): Dimension
Returns Dimension
- Defined in src/timeline/timeline.ts:1564

getTimecodedFloatingHorizontals

getTimecodedFloatingHorizontals(): Horizontals
Returns Horizontals
- Defined in src/timeline/timeline.ts:1592

getTimecodedFloatingPosition

getTimecodedFloatingPosition(): Position
Returns Position
- Defined in src/timeline/timeline.ts:1568

getTimecodedFloatingRect

getTimecodedFloatingRect(): RectMeasurement
Returns RectMeasurement
- Defined in src/timeline/timeline.ts:1585

getTimecodedFloatingRelativePointerPosition

getTimecodedFloatingRelativePointerPosition(): Position | undefined
Returns Position | undefined
- Defined in src/timeline/timeline.ts:1572

getTimelineLane

getTimelineLane<T extends TimelineLaneApi<TimelineLaneStyle>>(
id: string,
): T | undefined
Type Parameters
- T extends TimelineLaneApi<TimelineLaneStyle>
Parameters
- id: string
  TimelineLaneApi.id
Returns T | undefined
single TimelineLaneApi instance
Implementation of TimelineApi.getTimelineLane
- Defined in src/timeline/timeline.ts:1483

getTimelineLanes

getTimelineLanes(): TimelineLaneApi<TimelineLaneStyle>[]
Returns TimelineLaneApi<TimelineLaneStyle>[]
all TimelineLaneApi instances
Implementation of TimelineApi.getTimelineLanes
- Defined in src/timeline/timeline.ts:1479

getVisiblePositionRange

getVisiblePositionRange(): { end: number; start: number }
Returns { end: number; start: number }
- Defined in src/timeline/timeline.ts:1599

getVisibleTimeRange

getVisibleTimeRange(): { end: number; start: number }
Returns { end: number; start: number }
- Defined in src/timeline/timeline.ts:1618

getZoomPercent

getZoomPercent(): number
Returns number
current zoom perent
Implementation of TimelineApi.getZoomPercent
- Defined in src/timeline/timeline.ts:1095

maximizeTimelineLanes

maximizeTimelineLanes(timelineLanes: TimelineLaneApi<TimelineLaneStyle>[]): void
Maximize timeline lanes
Parameters
- timelineLanes: TimelineLaneApi<TimelineLaneStyle>[]
Returns void
Implementation of TimelineApi.maximizeTimelineLanes
- Defined in src/timeline/timeline.ts:1686

minimizeTimelineLanes

minimizeTimelineLanes(timelineLanes: TimelineLaneApi<TimelineLaneStyle>[]): void
Minimize timeline lanes
Parameters
- timelineLanes: TimelineLaneApi<TimelineLaneStyle>[]
Returns void
Implementation of TimelineApi.minimizeTimelineLanes
- Defined in src/timeline/timeline.ts:1668

removeAllTimelineLanes

removeAllTimelineLanes(): void
Removes all timeline lanes

Returns void
Implementation of TimelineApi.removeAllTimelineLanes
- Defined in src/timeline/timeline.ts:1436

removeTimelineLane

removeTimelineLane(id: string): void
Removes TimelineLaneApi instance by id
Parameters
- id: string
  TimelineLaneApi.id
Returns void
Implementation of TimelineApi.removeTimelineLane
- Defined in src/timeline/timeline.ts:1414

removeTimelineLanes

removeTimelineLanes(ids: string[]): void
Removes TimelineLaneApi instances by ids
Parameters
- ids: string[]
  TimelineLaneApi.ids
Returns void
Implementation of TimelineApi.removeTimelineLanes
- Defined in src/timeline/timeline.ts:1421

scrollHorizontallyToPercent

scrollHorizontallyToPercent(percent: number): void
Parameters
- percent: number
Returns void
- Defined in src/timeline/timeline.ts:976

scrollTimeline

scrollTimeline(x: number): void
Parameters
- x: number
Returns void
- Defined in src/timeline/timeline.ts:1067

scrollToEased

scrollToEased(percent: number): Observable<number>
Scrolls timeline
Parameters
- percent: number
  in range from 0 - timeline start or first timestamp, to 100 - timeline end or last timestamop
Returns Observable<number>
Implementation of TimelineApi.scrollToEased
- Defined in src/timeline/timeline.ts:1001

scrollToPlayheadEased

scrollToPlayheadEased(): Observable<number>
Scrolls timeline to playhead position

Returns Observable<number>
Implementation of TimelineApi.scrollToPlayheadEased
- Defined in src/timeline/timeline.ts:1007

setDescriptionPaneVisible

setDescriptionPaneVisible(visible: boolean): void
Shows or hides Timeline description pane
Parameters
- visible: boolean
Returns void
Implementation of TimelineApi.setDescriptionPaneVisible
- Defined in src/timeline/timeline.ts:1625

setDescriptionPaneVisibleEased

setDescriptionPaneVisibleEased(visible: boolean): Observable<void>
Shows or hides Timeline description pane
Parameters
- visible: boolean
Returns Observable<void>
Implementation of TimelineApi.setDescriptionPaneVisibleEased
- Defined in src/timeline/timeline.ts:1635

setThumbnailTrack

setThumbnailTrack(track: ThumbnailTrack): void
Parameters
- track: ThumbnailTrack
Returns void
Implementation of TimelineApi.setThumbnailTrack
- Defined in src/timeline/timeline.ts:1771

settleLayout

settleLayout(): void
Recalculates and settles layout, called on window resize event

Returns void
Implementation of TimelineApi.settleLayout
- Defined in src/timeline/timeline.ts:870

timelineContainerPositionToTime

timelineContainerPositionToTime(xOnTimeline: number): number
Parameters
- xOnTimeline: number
Returns number
- Defined in src/timeline/timeline.ts:1527

timelinePositionToTime

timelinePositionToTime(xOnTimeline: number): number
Parameters
- xOnTimeline: number
Returns number
- Defined in src/timeline/timeline.ts:1523

timelinePositionToTimecode

timelinePositionToTimecode(x: number): string
Parameters
- x: number
Returns string
- Defined in src/timeline/timeline.ts:1531

timeToTimelinePosition

timeToTimelinePosition(time: string | number): number
Parameters
- time: string | number
Returns number
- Defined in src/timeline/timeline.ts:1536

toggleDescriptionPaneVisible

toggleDescriptionPaneVisible(): void
Toggles Timeline description pane

Returns void
Implementation of TimelineApi.toggleDescriptionPaneVisible
- Defined in src/timeline/timeline.ts:1631

toggleDescriptionPaneVisibleEased

toggleDescriptionPaneVisibleEased(): Observable<void>
Toggles Timeline description pane

Returns Observable<void>
Implementation of TimelineApi.toggleDescriptionPaneVisibleEased
- Defined in src/timeline/timeline.ts:1653

toggleTimecodeEdit

toggleTimecodeEdit(): void
Toggles the CTI between its interactive and read-only state

Returns void
Implementation of TimelineApi.toggleTimecodeEdit
- Defined in src/timeline/timeline.ts:1717

zoomInEased

zoomInEased(): Observable<number>
Zoom in. Zoom scale in single method call is defined with TimelineConfig.zoomScale

Returns Observable<number>
Implementation of TimelineApi.zoomInEased
- Defined in src/timeline/timeline.ts:1135

zoomOutEased

zoomOutEased(): Observable<number>
Zoom out. Zoom scale in single method call is defined with TimelineConfig.zoomScale

Returns Observable<number>
Implementation of TimelineApi.zoomOutEased
- Defined in src/timeline/timeline.ts:1139

zoomTo

zoomTo(percent: number, zoomFocusPercent?: number | undefined): number
Timeline zoom
Parameters
- percent: number
  number between 100 and TimelineConfig.zoomMax
- zoomFocusPercent: number | undefined = ...
Returns number
Implementation of TimelineApi.zoomTo
- Defined in src/timeline/timeline.ts:1106

zoomToEased

zoomToEased(
percent: number,
zoomFocusPercent?: number | undefined,
): Observable<number>
Timeline zoom
Parameters
- percent: number
  number between 100 and TimelineConfig.zoomMax
- zoomFocusPercent: number | undefined = ...
Returns Observable<number>
Implementation of TimelineApi.zoomToEased
- Defined in src/timeline/timeline.ts:1119

zoomToMaxEased

zoomToMaxEased(): Observable<number>
Zoom to max resolution

Returns Observable<number>
Implementation of TimelineApi.zoomToMaxEased
- Defined in src/timeline/timeline.ts:1143

Class TimelineImpl

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TimelineImpl

Accessors

config

Returns TimelineConfig

descriptionPaneVisible

Returns boolean

id

Returns string

onEvent$

Returns Observable<TimelineEvent>

ready

Returns boolean

state

Returns TimelineState

See

style

Returns TimelineStyle

See

timecodedFloatingGroup

Returns Group

Methods

addTimelineLane

Parameters

Returns TimelineLaneApi

addTimelineLaneAtIndex

Parameters

Returns TimelineLaneApi

addTimelineLanes

Parameters

Returns TimelineLaneApi<TimelineLaneStyle>[]

addToFooterFlexGroup

Parameters

Returns void

addToSurfaceLayerTimecodedFloatingContent

Parameters

Returns void

addToTimecodedFloatingContent

Parameters

Returns void

addToTimecodedStaticContent

Parameters

Returns void

constrainTimelinePosition

Parameters

Returns number

destroy

Returns void

getHorizontalScrollPercent

Returns number

getScrollHandleHorizontals

Parameters

Returns Horizontals

getScrubberLane

Returns ScrubberLane

getTimecodedContainerDimension

Returns Dimension

getTimecodedFloatingDimension

Returns Dimension

getTimecodedFloatingHorizontals

Returns Horizontals

getTimecodedFloatingPosition

Returns Position

getTimecodedFloatingRect

Returns RectMeasurement

getTimecodedFloatingRelativePointerPosition

Returns Position | undefined

getTimelineLane

Type Parameters

Parameters

Returns T | undefined

getTimelineLanes