HeliosState
TheHeliosState interface represents the complete runtime state of a Helios composition. It combines configuration, playback status, and computed values.
Type parameters
The type of input properties for the composition.
Composition dimensions
Canvas width in pixels.
Canvas height in pixels.
Time and frames
Total duration of the composition in seconds.
Frame rate in frames per second.
Current playback position in frames.
Current playback position in seconds. Computed as
currentFrame / fps.Playback status
Whether the composition is currently playing.
Whether playback loops at the end.
Playback speed multiplier.
Active playback range as
[startFrame, endFrame], or null for full duration.Input properties
User-defined input properties for the composition.
Audio state
Master volume from 0.0 to 1.0.
Whether all audio is muted.
Per-track audio state. Keys are track IDs, values contain volume and mute state.
List of available audio tracks with metadata.
Captions
All caption cues for the composition.
Caption cues active at the current time.
Timeline
Clips currently active based on the timeline and current time.
Timeline markers for navigation.
HeliosSubscriber
Callback type for subscribing to state changes.Related types
CaptionCue
Represents a single caption cue.Unique identifier for the cue.
Start time in milliseconds.
End time in milliseconds.
Caption text content.
Marker
Represents a timeline marker.Unique identifier for the marker. Required and must be non-empty.
Marker position in seconds. Must be non-negative.
Optional human-readable label.
Optional hex color code for visual representation.
Optional custom metadata.
HeliosClip
Represents a clip in a timeline.Unique clip identifier.
Source identifier or path.
Start time in seconds.
Clip duration in seconds.
Optional track index.
Optional clip properties.
AudioTrackMetadata
Metadata for an audio track.Unique track identifier.
Audio source URL or path.
Track start time in composition.
Track duration in seconds.
Optional fade-in duration in seconds.
Optional fade-out duration in seconds.
Optional easing function for fades.
Usage example
Related types
- HeliosConfig - Configuration interface
- TimeDriver - Driver interfaces