Sequence

Since: 25.6

Properties

Name
Type
Access
Min Version
Description
guid
Guid
R
25.6
The unique identifier of the sequence.
name
string
R
25.6
The sequence name.

Instance Methods

clearSelection

Clears TrackItem Selection

Since: 25.6

Returns: Promise<boolean>

createCloneAction

Creates an action to clone the given sequence

Since: 25.6

Returns: Action

createSetInPointAction

Create SetInPointAction for sequence

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
tickTime
TickTime
-

createSetOutPointAction

Create SetOutPointAction for sequence

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
tickTime
TickTime
-

createSetSettingsAction

Returns an action that updates the settings for the sequence.

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
sequenceSettings
SequenceSettings
-

createSetZeroPointAction

Create an action to set the zero point for the sequence.

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
tickTime
TickTime
-

createSubsequence

Returns a new sequence, which is a sub-sequence of the existing sequence

Since: 25.6

Returns: Promise<Sequence>

Parameters

Name
Type
Description
ignoreTrackTargeting
boolean
-

getAudioTrack

Get audio track from track index

Since: 25.6

Returns: Promise<AudioTrack>

Parameters

Name
Type
Description
trackIndex
number
-

getAudioTrackCount

Get audio track count from this sequence

Since: 25.6

Returns: Promise<number>

getCaptionTrack

Get caption track from track index

Since: 25.6

Returns: Promise<CaptionTrack>

Parameters

Name
Type
Description
trackIndex
number
-

getCaptionTrackCount

Get caption track count from this sequence

Since: 25.6

Returns: Promise<number>

getEndTime

Time representing the end of the sequence

Since: 25.6

Returns: Promise<TickTime>

getFrameSize

Gets the size of the frame

Since: 25.6

Returns: Promise<RectF>

getInPoint

Get time representing the in point of the sequence.

Since: 25.6

Returns: Promise<TickTime>

getOutPoint

Get time representing the out point of the sequence.

Since: 25.6

Returns: Promise<TickTime>

getPlayerPosition

Get the player's current position

Since: 25.6

Returns: Promise<TickTime>

getProjectItem

Get the associated projectItem of the sequence.

Since: 25.6

Returns: Promise<ProjectItem>

getSelection

Returns the current selection group of the sequence.

Since: 25.6

Returns: Promise<TrackItemSelection>

getSequenceAudioTimeDisplayFormat

Get audio time display format of this sequence

Since: 25.6

Returns: Promise<TimeDisplay>

getSequenceVideoTimeDisplayFormat

Get video time display format of this sequence

Since: 25.6

Returns: Promise<TimeDisplay>

getSettings

Get sequence settings object

Since: 25.6

Returns: Promise<SequenceSettings>

getTimebase

Gets the time base of sequence

Since: 25.6

Returns: Promise<string>

getVideoTrack

Get video track from track index

Since: 25.6

Returns: Promise<VideoTrack>

Parameters

Name
Type
Description
trackIndex
number
-

getVideoTrackCount

Get video track count from this sequence

Since: 25.6

Returns: Promise<number>

getZeroPoint

Time representing the zero point of the sequence.

Since: 25.6

Returns: Promise<TickTime>

isDoneAnalyzingForVideoEffects

Returns whether or not the sequence is done analyzing for video effects

Since: 25.6

Returns: Promise<boolean>

setPlayerPosition

Set the player's current position

Since: 25.6

Returns: Promise<boolean>

Parameters

Name
Type
Description
positionTime
TickTime
-

setSelection

Updates sequence selection using the given track item selection.

Since: 25.6

Since: 26.3: This function is now synchronous and returns a boolean instead of a Promise<boolean>.

Returns: boolean

Parameters

Name
Type
Description
trackItemSelection
TrackItemSelection
-