@timelinx/core API
Auto-generated type-level API reference for @timelinx/core
Timeline Creation
These factories create the canonical data structures used by the dispatcher and invariants.
createTimeline
Creates a timeline definition.
Prop
Type
createTimelineState
Creates the initial timeline state from a timeline definition and optional asset registry.
Prop
Type
createAsset
Registers a media asset.
Prop
Type
createTrack
Creates a track definition.
Prop
Type
createClip
Creates a clip that references an asset and defines a time range.
Prop
Type
Frame And Time Utilities
Timelinx stores timeline positions as branded integer frames. Use toFrame() when a value is already a frame count, and conversion helpers when crossing from seconds or timecode display.
toFrame
Brands a known frame count as TimelineFrame.
Prop
Type
frameRate
Validates and brands a supported frame rate.
Prop
Type
framesToTimecode
Formats frame counts for display.
Prop
Type
Dispatch
dispatch
Processes a transaction against the current state. Returns a DispatchResult.
Prop
Type
History
For new editor integrations, prefer HistoryStack. The pure helper functions remain useful for compatibility and simple immutable history containers.
HistoryStack
Snapshot history with compression, checkpoints, and serialization support.
Prop
Type
createHistory
Creates a history state from an initial timeline state. Deprecated in favor of HistoryStack.
Prop
Type
Tools And Snapping
Prop
Type
Prop
Type
Prop
Type
Effects And Transitions
createEffect
Creates effect objects for the effects system.
Prop
Type
createTransition
Creates transition objects for clip transition metadata.
Prop
Type
Subtitles And Captions
parseSRT
Parses SRT text into caption import data.
Prop
Type
subtitleImportToOps
Converts parsed subtitle data into timeline operations that can be reviewed and dispatched.
Prop
Type