@videoflow/core

(parent: any, properties: AuditoryLayerProperties, settings: AudioLayerSettings): AudioLayer

(from: Record<string, any>, to: Record<string, any>, settings: { duration?: Time; easing?: Easing; wait?: boolean }): this

Animate properties from one state to another.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer in from transparent.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer out to transparent.

(): this

Hide the layer (set `visible` to `false`).

(): this

Remove this layer at the current flow position. Once removed, calling any further flow method on this layer throws.

(value: Record<string, any>): this

Set property values at the current flow position (step keyframe).

(): this

Show the layer (set `visible` to `true`).

(): LayerJSON

Serialise this layer into the VideoFlow JSON model format. Properties stored as keyframe arrays are converted into the `animations` array, while static properties go into `properties`.

(parent: any, properties: TextualLayerProperties, settings: CaptionsLayerSettings): CaptionsLayer

(from: Record<string, any>, to: Record<string, any>, settings: { duration?: Time; easing?: Easing; wait?: boolean }): this

Animate properties from one state to another.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer in from transparent.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer out to transparent.

(): this

Hide the layer (set `visible` to `false`).

(): this

Remove this layer at the current flow position. Once removed, calling any further flow method on this layer throws.

(value: Record<string, any>): this

Set property values at the current flow position (step keyframe).

(): this

Show the layer (set `visible` to `true`).

(): LayerJSON

Serialise this layer into the VideoFlow JSON model format. Properties stored as keyframe arrays are converted into the `animations` array, while static properties go into `properties`.

(parent: any, properties: MediaLayerProperties, settings: MediaLayerSettings): ImageLayer

(from: Record<string, any>, to: Record<string, any>, settings: { duration?: Time; easing?: Easing; wait?: boolean }): this

Animate properties from one state to another.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer in from transparent.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer out to transparent.

(): this

Hide the layer (set `visible` to `false`).

(): this

Remove this layer at the current flow position. Once removed, calling any further flow method on this layer throws.

(value: Record<string, any>): this

Set property values at the current flow position (step keyframe).

(): this

Show the layer (set `visible` to `true`).

(): LayerJSON

Serialise this layer into the VideoFlow JSON model format. Properties stored as keyframe arrays are converted into the `animations` array, while static properties go into `properties`.

(parent: any, properties: ShapeLayerProperties, settings: ShapeLayerSettings): ShapeLayer

(from: Record<string, any>, to: Record<string, any>, settings: { duration?: Time; easing?: Easing; wait?: boolean }): this

Animate properties from one state to another.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer in from transparent.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer out to transparent.

(): this

Hide the layer (set `visible` to `false`).

(): this

Remove this layer at the current flow position. Once removed, calling any further flow method on this layer throws.

(value: Record<string, any>): this

Set property values at the current flow position (step keyframe).

(): this

Show the layer (set `visible` to `true`).

(): LayerJSON

Serialise this layer into the VideoFlow JSON model format. Properties stored as keyframe arrays are converted into the `animations` array, while static properties go into `properties`.

(parent: any, properties: TextLayerProperties, settings: BaseLayerSettings): TextLayer

(from: Record<string, any>, to: Record<string, any>, settings: { duration?: Time; easing?: Easing; wait?: boolean }): this

Animate properties from one state to another.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer in from transparent.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer out to transparent.

(): this

Hide the layer (set `visible` to `false`).

(): this

Remove this layer at the current flow position. Once removed, calling any further flow method on this layer throws.

(value: Record<string, any>): this

Set property values at the current flow position (step keyframe).

(): this

Show the layer (set `visible` to `true`).

(): LayerJSON

Serialise this layer into the VideoFlow JSON model format. Properties stored as keyframe arrays are converted into the `animations` array, while static properties go into `properties`.

(settings: ProjectSettings): VideoFlow

(properties?: AuditoryLayerProperties, settings?: AudioLayerSettings, options?: AddLayerOptions): AudioLayer

Add an audio layer from a URL or file path.

(properties?: TextualLayerProperties, settings?: CaptionsLayerSettings, options?: AddLayerOptions): CaptionsLayer

Add a captions layer with pre-defined timed captions.

(properties?: MediaLayerProperties, settings?: MediaLayerSettings, options?: AddLayerOptions): ImageLayer

Add an image layer from a URL or file path.

(LayerClass: (parent: VideoFlow, properties?: any, settings?: any) => T, properties: Record<string, any>, settings: Record<string, any>, options: AddLayerOptions): T

Add a layer of the given class to the flow.

(properties?: ShapeLayerProperties, settings?: ShapeLayerSettings, options?: AddLayerOptions): ShapeLayer

Add a vector shape layer (rectangle, ellipse, polygon, or star).

(properties?: TextLayerProperties, settings?: BaseLayerSettings, options?: AddLayerOptions): TextLayer

Add a text layer.

(properties?: VideoLayerProperties, settings?: MediaLayerSettings, options?: AddLayerOptions): VideoLayer

Add a video layer from a URL or file path.

(): Promise<VideoJSON>

Compile the flow into a VideoJSON object. This method: 1. Walks the flow actions sequentially, maintaining a time pointer. 2. Converts all time values to frame numbers. 3. Builds keyframe arrays from `set` / `animate` actions. 4. Calculates the total project duration. 5. Returns the complete JSON ready for rendering. Media metadata (image dimensions, video/audio duration) is resolved during compilation so that `waitFor: 'finish'` and auto-duration work correctly.

(properties: VisualLayerProperties, settings: BaseLayerSettings, fn: (group: GroupLayer) => void, options: AddLayerOptions): GroupLayer

Add a layer group — a container that nests other layers and treats them as one. Inside `fn`, the flow's time pointer resets to `0` (relative to the group's start), so children's timing is authored independently of where the group sits on the project timeline. The flow pointer of the outer scope advances by the group's `waitFor` (default `'finish'` = the group's full footprint). The group itself is a VisualLayer, so its `position`, `scale`, `rotation`, `opacity`, filters, transitions and effects all apply to the composited child sub-tree. ```ts const card = $.group({ position: [0.5, 0.5], scale: 1 }, {}, () => { $.addShape({ width: 60, height: 30, fill: '#fff' }); $.addText({ text: 'Hello' }); }); card.animate({ scale: 1 }, { scale: 1.1 }, { duration: '500ms' }); ``` Group timing is auto-derived: `startTime` defaults to the current flow time, and `sourceDuration` defaults to the latest child's end (so a group whose last child finishes at +5s lasts 5s). Both can still be overridden in `settings` if you need to.

(funcs: () => void[]): this

Execute multiple sequences of actions in parallel. Each function receives its own timeline; the overall flow pointer advances to the end of the longest parallel branch. ```ts $.parallel([ () => { text.animate({opacity:0},{opacity:1},{duration:'1s'}); }, () => { bg.animate({filterBlur:0},{filterBlur:5},{duration:'2s'}); }, ]); ```

(action: Action): void

Push a raw action onto the current flow pointer. Used by layers to record their actions.

(): Promise<any>

Compile and render the full audio track of the video. Automatically detects the environment and uses the appropriate renderer. The renderer package must be installed separately.

(frame: number): Promise<any>

Compile and render a single frame of the video. Automatically detects the environment and uses the appropriate renderer. The renderer package must be installed separately.

(options: Record<string, any>): Promise<any>

Compile and render the video in one call. Automatically detects the environment and uses the appropriate renderer: - **Browser** (window/DOM present) → `@videoflow/renderer-browser` - **Node.js** (no DOM, `process.versions.node` exists) → `@videoflow/renderer-server` The renderer package must be installed separately.

(time: Time): this

Pause the timeline for the given duration before the next action.

(parent: any, properties: VideoLayerProperties, settings: MediaLayerSettings): VideoLayer

(from: Record<string, any>, to: Record<string, any>, settings: { duration?: Time; easing?: Easing; wait?: boolean }): this

Animate properties from one state to another.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer in from transparent.

(duration: Time, easing?: Easing, wait?: boolean): this

Fade the layer out to transparent.

(): this

Hide the layer (set `visible` to `false`).

(): this

Remove this layer at the current flow position. Once removed, calling any further flow method on this layer throws.

(value: Record<string, any>): this

Set property values at the current flow position (step keyframe).

(): this

Show the layer (set `visible` to `true`).

(): LayerJSON

Serialise this layer into the VideoFlow JSON model format. Properties stored as keyframe arrays are converted into the `animations` array, while static properties go into `properties`.