Home > @unseenco/backstage-core > ISequence
ISequence interface
Public API for a sheet's animation sequence (playback, playhead, and audio).
Signature:
typescript
export interface ISequenceProperties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| pointer | Pointer<{ playing: boolean; length: number; position: number; }> | A Pointer to the sequence's inner state. | |
| position | number | The current position of the playhead. In a time-based sequence, this represents the current time in seconds. | |
| type | 'Backstage_Sequence_PublicAPI' | Discriminator for Backstage.js public sequence instances. |
Methods
| Method | Description |
|---|---|
| __experimental_getGsapClips() | Returns GSAP clip tracks on the active sequence variant for all objects. |
| __experimental_getGsapScrollTriggers() | Runtime ScrollTrigger registrations for page-mode visualization (read-only in Studio). |
| __experimental_getKeyframes(prop) | Given a property, returns a list of keyframes that affect that property. |
| attachAudio(args) | Attaches an audio source to the sequence. Playing the sequence automatically plays the audio source and their times are kept in sync. |
| pause() | Pauses the currently playing animation |
| play(conf) | Starts playback of a sequence. Returns a promise that either resolves to true when the playback completes, or resolves to false if playback gets interrupted (for example by calling sequence.pause()) |