Home > @theatre/core > ISequence

ISequence interface

Signature:

export interface ISequence 

Properties

Property 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 'Theatre_Sequence_PublicAPI'

Methods

Method Description
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())