SequenceSettings

Since: 25.6

Instance Methods

getAudioChannelCount

Get number of channels in the sequence

Since: 25.6

Returns: Promise<number>

getAudioChannelType

Get Audio channel type of sequence. Could be 0 (Mono), 1 (Stereo), 2 (5.1), or 3 (multichannel)

Since: 25.6

Returns: Promise<number>

getAudioDisplayFormat

Get Audio display format

Since: 25.6

Returns: Promise<TimeDisplay>

getAudioSampleRate

Get audio sample rate

Since: 25.6

Returns: Promise<FrameRate>

getCompositeInLinearColor

Get if composite in linear color is checked

Since: 25.6

Returns: Promise<boolean>

getEditingMode

Get editing mode of sequence

Since: 25.6

Returns: Promise<string>

getMaximumBitDepth

Find if maximum bit depth is set

Since: 25.6

Returns: Promise<boolean>

getMaxRenderQuality

Find if maximum render quality is set

Since: 25.6

Returns: Promise<boolean>

getPreviewCodec

Get preview codec of sequence

Since: 25.6

Returns: Promise<string>

getPreviewFileFormat

Get preview file format of sequence

Since: 25.6

Returns: Promise<string>

getPreviewFrameRect

Get preview video frame rect in the sequence

Since: 25.6

Returns: Promise<RectF>

getVideoDisplayFormat

Get Video display format

Since: 25.6

Returns: Promise<TimeDisplay>

getVideoFieldType

Get video field type in the sequence

Since: 25.6

Returns: Promise<number>

getVideoFrameRate

Get video frame rate in the sequence

Since: 26.2

Returns: FrameRate

getVideoFrameRect

Get video frame rect in the sequence

Since: 25.6

Returns: Promise<RectF>

getVideoPixelAspectRatio

Get Video display format

Since: 25.6

Returns: Promise<string>

setAudioDisplayFormat

Set audio display format of sequence.

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

audioDisplay

TimeDisplay

setAudioSampleRate

Set audio sample rate

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

inRate

FrameRate

setCompositeInLinearColor

Set if composite in linear color is checked

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

useCompositeInLinearColor

boolean

setEditingMode

Set editing mode of sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

inEditingModeName

string

setMaximumBitDepth

Set maximum bit depth to true/false

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

useMaxBitDepth

boolean

setMaxRenderQuality

Set maximum render quality to true/false

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

useMaxRenderQuality

boolean

setPreviewCodec

Set preview codec of sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

inPreviewCodec

string

setPreviewFileFormat

Set preview file format of sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

inPreviewCodec

string

setPreviewFrameRect

Set preview video frame rect in sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

inPreviewVideoRect

RectF

setVideoDisplayFormat

Set video display format of sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

audioDisplay

TimeDisplay

setVideoFieldType

Set video field type in sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

videoFiledType

number

setVideoFrameRate

Set video frame rate in the sequence

Since: 26.2

Returns: boolean

Parameters

Name

Type

Description

inVideoFrameRate

FrameRate

setVideoFrameRect

Set video frame rect in sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

inVideoFrameRect

RectF

setVideoPixelAspectRatio

Set video display format of sequence

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

inPixelAspectRatio

string