Track object

Track

Description

The Track object represents a video or audio track, within a sequence.


Attributes

name

track.name

Description

The name of the track.

Type

String; read-only.


id

track.id

Description

This is the ordinal assigned to the track, upon creation.

Type

Integer, read-only.


mediaType

track.mediaType

Description

The type of media, contained in this track.

Type

String, read-only; valid values are Audio and Video.


clips

track.clips

Description

An array of trackItem objects, contained within the track, in temporal order.

Type

Array; read-only.


transitions

track.transitions

Description

An array of transitions objects, contained within the track, in temporal order.

Type

Array; read-only.

Methods

isMuted()

track.isMuted()

Description

Retrieves the current mute state, of the track.

Parameters

None.

Returns

Returns true if track is currently muted; false if not.


setMute()

track.setMute(isMuted)

Description

Sets the mute state, of the track.

Parameters

Integer; if 1, mute the track. If isMuted is 0, the track will be unmuted.

Returns

Returns 0 if successful.


insertClip()

track.insertClip(srcProjectItem, time)

Description

Adds a ‘clip’ (media segment from a projectItem) to the track, at the specified time. Media will be inserted, at that time.

Parameters

A projectItem from which to get media, and the time at which to add it, in Ticks.

Returns

Returns 0 if successful.


overwriteClip()

track.overwriteClip(srcProjectItem, time)

Description

Adds a ‘clip’ (media segment from a projectItem) to the track, at the specified time. This will overwrite any existing media, at that time.

Parameters

A projectItem from which to get media, and the time at which to add it, in Ticks.

Returns

Returns 0 if successful.