Class: TimelineEditor

TimelineEditor

This class provides an interface to execute all timeline operations using a direct, class-based approach with track-based management. It also handles undo/redo operations internally.

Constructors

constructor

Methods

Constructors

constructor

• new TimelineEditor(context): TimelineEditor

Parameters

Name	Type
`context`	`TimelineOperationContext`

Returns

TimelineEditor

Defined in

core/editor/timeline.editor.ts:86

Methods

registerElementType

▸ registerElementType(type, deserializer): void

Parameters

Name	Type
`type`	`string`
`deserializer`	(`json`: `ElementJSON`) => `null` \| `TrackElement`

Returns

void

Defined in

core/editor/timeline.editor.ts:92

unregisterElementType

▸ unregisterElementType(type): void

Parameters

Name	Type
`type`	`string`

Returns

void

Defined in

core/editor/timeline.editor.ts:99

on

▸ on(event, handler): void

Subscribe to timeline mutation events.

Parameters

Name	Type
`event`	`TimelineEditorEvent`
`handler`	(`payload`: `unknown`) => `void`

Returns

void

Defined in

core/editor/timeline.editor.ts:106

off

▸ off(event, handler): void

Unsubscribe from timeline mutation events.

Parameters

Name	Type
`event`	`TimelineEditorEvent`
`handler`	(`payload`: `unknown`) => `void`

Returns

void

Defined in

core/editor/timeline.editor.ts:118

getContext

▸ getContext(): TimelineOperationContext

Returns

TimelineOperationContext

Defined in

core/editor/timeline.editor.ts:126

pauseVideo

▸ pauseVideo(): void

Returns

void

Defined in

core/editor/timeline.editor.ts:130

getTimelineData

▸ getTimelineData(): null | TimelineTrackData

Returns

null | TimelineTrackData

Defined in

core/editor/timeline.editor.ts:139

getLatestVersion

▸ getLatestVersion(): number

Returns

number

Defined in

core/editor/timeline.editor.ts:144

addTrack

▸ addTrack(name, type?): Track

Parameters

Name	Type	Default value
`name`	`string`	`undefined`
`type`	`string`	`TRACK_TYPES.ELEMENT`

Returns

Track

Defined in

core/editor/timeline.editor.ts:198

getTrackById

▸ getTrackById(id): null | Track

Parameters

Name	Type
`id`	`string`

Returns

null | Track

Defined in

core/editor/timeline.editor.ts:208

getTrackByName

▸ getTrackByName(name): null | Track

Parameters

Name	Type
`name`	`string`

Returns

null | Track

Defined in

core/editor/timeline.editor.ts:214

getCaptionsTrack

▸ getCaptionsTrack(): null | Track

Returns

null | Track

Defined in

core/editor/timeline.editor.ts:220

getTracksByType

▸ getTracksByType(type): Track[]

Parameters

Name	Type
`type`	`string`

Returns

Track[]

Defined in

core/editor/timeline.editor.ts:226

getTracksByPredicate

▸ getTracksByPredicate(predicate): Track[]

Parameters

Name	Type
`predicate`	(`track`: `Track`, `index`: `number`) => `boolean`

Returns

Track[]

Defined in

core/editor/timeline.editor.ts:232

updateTrackProps

▸ updateTrackProps(trackId, propsPatch): null | Track

Parameters

Name	Type
`trackId`	`string`
`propsPatch`	`Record`<`string`, `unknown`>

Returns

null | Track

Defined in

core/editor/timeline.editor.ts:238

replaceTrackProps

▸ replaceTrackProps(trackId, nextProps): null | Track

Parameters

Name	Type
`trackId`	`string`
`nextProps`	`Record`<`string`, `unknown`>

Returns

null | Track

Defined in

core/editor/timeline.editor.ts:255

upsertTrack

▸ upsertTrack(input): Track

Parameters

Name	Type
`input`	`TrackUpsertInput`

Returns

Track

Defined in

core/editor/timeline.editor.ts:265

validateTrackOverlaps

▸ validateTrackOverlaps(trackId): Object

Parameters

Name	Type
`trackId`	`string`

Returns

Object

Name	Type
`valid`	`boolean`
`issues`	`TrackOverlapIssue`[]

Defined in

core/editor/timeline.editor.ts:297

removeTrackById

▸ removeTrackById(id): void

Parameters

Name	Type
`id`	`string`

Returns

void

Defined in

core/editor/timeline.editor.ts:329

removeTrack

▸ removeTrack(track): void

Parameters

Name	Type
`track`	`Track`

Returns

void

Defined in

core/editor/timeline.editor.ts:336

refresh

▸ refresh(): void

Refresh the timeline data

Returns

void

Defined in

core/editor/timeline.editor.ts:346

addElementToTrack

▸ addElementToTrack(track, element): Promise<boolean>

Add an element to a specific track using the visitor pattern.

Parameters

Name	Type	Description
`track`	`Track`	The track to add the element to.
`element`	`TrackElement`	The element to add.

Returns

Promise<boolean>

A promise that resolves to true if the element was added successfully, otherwise false.

Defined in

core/editor/timeline.editor.ts:359

removeElement

▸ removeElement(element): boolean

Remove an element from a specific track using the visitor pattern.

Parameters

Name	Type	Description
`element`	`TrackElement`	The element to remove.

Returns

boolean

true if the element was removed successfully, otherwise false.

Defined in

core/editor/timeline.editor.ts:396

updateElement

▸ updateElement(element): TrackElement

Update an element in a specific track using the visitor pattern.

Parameters

Name	Type	Description
`element`	`TrackElement`	The updated element.

Returns

TrackElement

The updated TrackElement.

Defined in

core/editor/timeline.editor.ts:427

splitElement

▸ splitElement(element, splitTime): Promise<SplitResult>

Split an element at a specific time point using the visitor pattern

Parameters

Name	Type	Description
`element`	`TrackElement`	The element to split
`splitTime`	`number`	The time point to split at

Returns

Promise<SplitResult>

SplitResult with first element, second element, and success status

Defined in

core/editor/timeline.editor.ts:459

cloneElement

▸ cloneElement(element): null | TrackElement

Clone an element using the visitor pattern

Parameters

Name	Type	Description
`element`	`TrackElement`	The element to clone

Returns

null | TrackElement

TrackElement | null - the cloned element or null if cloning failed

Defined in

core/editor/timeline.editor.ts:532

reorderTracks

▸ reorderTracks(tracks): void

Parameters

Name	Type
`tracks`	`Track`[]

Returns

void

Defined in

core/editor/timeline.editor.ts:541

moveElementToNewTrackAt

▸ moveElementToNewTrackAt(element, targetTrackIndex, startSec): Promise<boolean>

Move an element to a new track inserted at the given index (OpenVideo-style separator drop). Removes the element from its current track, creates a new track at targetTrackIndex, sets element start/end, and adds the element to the new track.

Parameters

Name	Type
`element`	`TrackElement`
`targetTrackIndex`	`number`
`startSec`	`number`

Returns

Promise<boolean>

Defined in

core/editor/timeline.editor.ts:551

updateHistory

▸ updateHistory(timelineTrackData): void

Parameters

Name	Type
`timelineTrackData`	`TimelineTrackData`

Returns

void

Defined in

core/editor/timeline.editor.ts:596

undo

▸ undo(): void

Trigger undo operation and update timeline data

Returns

void

Defined in

core/editor/timeline.editor.ts:616

redo

▸ redo(): void

Trigger redo operation and update timeline data

Returns

void

Defined in

core/editor/timeline.editor.ts:656

resetHistory

▸ resetHistory(): void

Reset history and clear timeline data

Returns

void

Defined in

core/editor/timeline.editor.ts:696

loadProject

▸ loadProject(«destructured»): void

Parameters

Name	Type
`«destructured»`	`Object`
› `tracks`	`TrackJSON`[]
› `version`	`number`
› `backgroundColor?`	`string`
› `metadata?`	`ProjectMetadata`

Returns

void

Defined in

core/editor/timeline.editor.ts:720

loadProjectSnapshot

▸ loadProjectSnapshot(«destructured»): void

Parameters

Name	Type
`«destructured»`	`Object`
› `tracks`	`TrackJSON`[]
› `version`	`number`
› `backgroundColor?`	`string`
› `metadata?`	`ProjectMetadata`

Returns

void

Defined in

core/editor/timeline.editor.ts:766

getWatermark

▸ getWatermark(): null | Watermark

Returns

null | Watermark

Defined in

core/editor/timeline.editor.ts:800

setWatermark

▸ setWatermark(watermark): void

Parameters

Name	Type
`watermark`	`Watermark`

Returns

void

Defined in

core/editor/timeline.editor.ts:805

removeWatermark

▸ removeWatermark(): void

Returns

void

Defined in

core/editor/timeline.editor.ts:816

getVideoAudio

▸ getVideoAudio(): Promise<string>

Returns

Promise<string>

Defined in

core/editor/timeline.editor.ts:826

addTransition

▸ addTransition(fromElementId, toElementId, kind, duration): boolean

Add transition metadata from one element to the next (e.g. crossfade). Sets optional transition on the "from" element; visualizer can interpret it when implemented.

Parameters

Name	Type
`fromElementId`	`string`
`toElementId`	`string`
`kind`	`string`
`duration`	`number`

Returns

boolean

Defined in

core/editor/timeline.editor.ts:836

removeTransition

▸ removeTransition(elementId): boolean

Remove transition metadata from an element.

Parameters

Name	Type
`elementId`	`string`

Returns

boolean

Defined in

core/editor/timeline.editor.ts:857

getProject

▸ getProject(): ProjectJSON

Get the current project as ProjectJSON (same shape consumed by visualizer).

Returns

ProjectJSON

Defined in

core/editor/timeline.editor.ts:877

getBackgroundColor

▸ getBackgroundColor(): undefined | string

Returns

undefined | string

Defined in

core/editor/timeline.editor.ts:898

setBackgroundColor

▸ setBackgroundColor(backgroundColor): void

Parameters

Name	Type
`backgroundColor`	`string`

Returns

void

Defined in

core/editor/timeline.editor.ts:902

getMetadata

▸ getMetadata(): undefined | ProjectMetadata

Returns

undefined | ProjectMetadata

Defined in

core/editor/timeline.editor.ts:914

setMetadata

▸ setMetadata(metadata): void

Parameters

Name	Type
`metadata`	`ProjectMetadata`

Returns

void

Defined in

core/editor/timeline.editor.ts:918

rippleDelete

▸ rippleDelete(fromTime, toTime): Promise<void>

Ripple delete: remove content in [fromTime, toTime] and shift later content left. Single undo step.

Parameters

Name	Type
`fromTime`	`number`
`toTime`	`number`

Returns

Promise<void>

Defined in

core/editor/timeline.editor.ts:934

trimElement

▸ trimElement(element, newStart, newEnd): boolean

Trim an element to new start and end times. Validates bounds and updates via updateElement.

Parameters

Name	Type
`element`	`TrackElement`
`newStart`	`number`
`newEnd`	`number`

Returns

boolean

Defined in

core/editor/timeline.editor.ts:990

updateElements

▸ updateElements(updates): void

Apply multiple element updates in one batch; single setTimelineData and undo step.

Parameters

Name	Type
`updates`	{ `elementId`: `string` ; `updates`: `Partial`<`ElementJSON`> }[]

Returns

void

Defined in

core/editor/timeline.editor.ts:1008

removeElements

▸ removeElements(elementIds): void

Remove multiple elements by id in one batch; single setTimelineData and undo step.

Parameters

Name	Type
`elementIds`	`string`[]

Returns

void

Defined in

core/editor/timeline.editor.ts:1212

replaceElementsBySource

▸ replaceElementsBySource(src, newElementJson): number

Replace all elements with the given src (e.g. placeholder or same URL) with a new element definition. Preserves id, s, e, and track for each replaced element. Single setTimelineData at end.

Parameters

Name	Type
`src`	`string`
`newElementJson`	`ElementJSON`

Returns

number

Defined in

core/editor/timeline.editor.ts:1239

centerElementInScene

▸ centerElementInScene(elementId, sceneWidth, sceneHeight): boolean

Center an element in the scene by setting its position to the center of scene dimensions.

Parameters

Name	Type
`elementId`	`string`
`sceneWidth`	`number`
`sceneHeight`	`number`

Returns

boolean

Defined in

core/editor/timeline.editor.ts:1278

scaleElementToFit

▸ scaleElementToFit(elementId, sceneWidth, sceneHeight): boolean

Scale an element to fit within scene dimensions while preserving aspect ratio. Updates width/height in props or frame when present.

Parameters

Name	Type
`elementId`	`string`
`sceneWidth`	`number`
`sceneHeight`	`number`

Returns

boolean

Defined in

core/editor/timeline.editor.ts:1299

duplicateElements

▸ duplicateElements(elementIds): Promise<TrackElement[]>

Duplicate multiple elements by id; adds clones to the same track. Single setTimelineData at end.

Parameters

Name	Type
`elementIds`	`string`[]

Returns

Promise<TrackElement[]>

Defined in

core/editor/timeline.editor.ts:1329

Table of contents​

Constructors​

Methods​

Constructors​

constructor​

Parameters​

Returns​

Defined in​

Methods​

registerElementType​

Parameters​

Returns​

Defined in​

unregisterElementType​

Parameters​

Returns​

Defined in​

on​

Parameters​

Returns​

Defined in​

off​

Parameters​

Returns​

Defined in​

getContext​

Returns​

Defined in​

pauseVideo​

Returns​

Defined in​

getTimelineData​

Returns​

Defined in​

getLatestVersion​

Returns​

Defined in​

addTrack​

Parameters​

Returns​

Defined in​

getTrackById​

Parameters​

Returns​

Defined in​

getTrackByName​

Parameters​

Returns​

Defined in​

getCaptionsTrack​

Returns​

Defined in​

getTracksByType​

Parameters​

Returns​

Defined in​

getTracksByPredicate​

Parameters​

Returns​

Defined in​

updateTrackProps​

Parameters​

Returns​

Defined in​

replaceTrackProps​

Parameters​

Returns​

Defined in​

upsertTrack​

Parameters​

Returns​

Defined in​

validateTrackOverlaps​

Parameters​

Returns​

Defined in​

removeTrackById​

Parameters​

Returns​

Defined in​

Table of contents

Constructors

Methods

Constructors

constructor

Parameters

Returns

Defined in

Methods

registerElementType

Parameters

Returns

Defined in

unregisterElementType

Parameters

Returns

Defined in

on

Parameters

Returns

Defined in

off

Parameters

Returns

Defined in

getContext

Returns

Defined in

pauseVideo

Returns

Defined in

getTimelineData

Returns

Defined in

getLatestVersion

Returns

Defined in

addTrack

Parameters

Returns

Defined in

getTrackById

Parameters

Returns

Defined in

getTrackByName

Parameters

Returns

Defined in

getCaptionsTrack

Returns

Defined in

getTracksByType

Parameters

Returns

Defined in

getTracksByPredicate

Parameters

Returns

Defined in

updateTrackProps

Parameters

Returns

Defined in

replaceTrackProps

Parameters

Returns

Defined in

upsertTrack

Parameters

Returns

Defined in

validateTrackOverlaps

Parameters

Returns

Defined in

removeTrackById

Parameters

Returns

Defined in