Object

Transcoder

The Transcoder object provides the main access for full export settings information and control.

Properties

Type	Access	Description
String	readonly	Returns color management info.
String	readonly	Returns the JSON for the current selected destination.
Boolean	readonly	Returns the logged-in state of the current selected destination. Returns 'false' if we can't determine logged-in state (MediaFile CreativeCloud FTP).
String	readonly	Returns the list and names of the current Preset Setting Groups.
Array	readonly	Get the currently selected source masterclip(s).
Sequence	readonly	Get the currently selected source sequence.
String	readonly	Returns a JSON list of all destinations for an export.
String	readonly	Returns the calculated file size information for the current source with the selected Preset.
Boolean	readonly	Start a direct modal Export with all for export marked destinations of the current Transcoder settings.
Boolean	readonly	Start a direct modal Export with the current Transcoder settings.
Boolean	readonly	Returns the current JSON convert option for hide hidden params.
Boolean	readonly	Returns the current JSON convert option for hide unset values.
Boolean	readonly	Returns the import into Project preference value.
Boolean	readonly	Check if match Sequence settings are allowed.
Boolean	readonly	Returns the locked status of the output file.
Boolean	readonly	Returns the match Sequence settings value.
String	readonly	Returns JSON describing whether the selected format cannot match the source audio channelization plus source\|output channel counts.
Boolean	readonly	Check if the original applied preset contains any enabled publish settings. Publish settings will be controlled by the destination settings which overwrites any original preset publish settings.
String	readonly	Returns the path to the output file.
String	readonly	Returns the current selected Preset Actions Settings.
String	readonly	Returns the current selected Preset Audio Settings.
String	readonly	Returns the current selected Preset Caption Settings.
String	readonly	Returns the current selected Preset Effects Settings.
String	readonly	Returns the current selected Preset Ingest Settings.
String	readonly	Returns the current selected Preset Metadata Settings.
String	readonly	Returns the current selected Preset Publish Settings.
String	readonly	Returns the current selected Preset Video Settings.
Varies	readonly
Varies	readonly
String	readonly	Returns a JSON list of the currently selected source object.

Methods

→ Boolean

Change the export format selected preset will be reset to the default preset for a given format.

newFormat String

→ Boolean

Change match source state for the given Parameter.

id String

value Boolean

→ Boolean

Change an existing Parameter.

group String

id String

value String

→ String

Returns the information about the current selected Preset.

includeSettings Boolean

→ String

Returns the current selected Preset settings from a special group.

groupKey String

→ Boolean

Export the current Preset.

filePath String

presetComments String

→ Boolean

Get the aspect ratio lock state.

→ String

Returns the localized display string for Output Summary when content credentials are applied.

→ Boolean

Returns true if the current selection (sequence or project items) contains content credentials.

→ Boolean

Returns true if the export of content credentials (cr) is activated

→ Boolean

Returns true if the export format is supported by content credentials (cr)

→ String

Returns the full path to a selected file

defaultDir String

defaultFileName String

extension String

→ String

Returns the full path to a selected file

fullPathWithExtension String

→ Boolean

Save a custom preset.

presetName String

saveEffectSettings Boolean

savePublishSettings Boolean

→ Boolean

Select a new destination.

destID String

groupIndex Number

→ Boolean

Set the aspect ratio lock state.

value Boolean

→ Boolean

Set currently selected Preset.

presetID String

→ Boolean

Set new Custom Data to the destination to store plugin or UI related information for this destination as JSON.

destID String

groupIndex Number

customData String

→ Boolean

Set the import into Project preference value.

importExportedFile Boolean

→ Boolean

Set the JSON return parameter for this class. Hide Hidden doesn't expose not UI visible params. Hide Unset returns smaller JSON by not exposing the parameter when set to default (e.g. disable = false will not expose but disable = true will). Will return true then an options has changed.

includeHiddenParams Boolean

includeUnsetValues Boolean

→ Boolean

Set the Sequence settings as Preset.

matchSequenceSettings Boolean

→ Boolean

Set the new path to the output file. The filename can be made unique based on other files already on disk.

filePath String

createUniqueFilename Boolean

→ Boolean

Set the current Range Option: Entire(0) InToOut(1) WorkArea(2) Custom(3) Default(4).

rangeOption Number

→ Boolean

Set the current Scaling Option: Scale to fit(0) Scale to fill(3) Stretch to fill(5).

scalingOption Number

→ Number

Returns output filepath collision type for a given filepath. There could be no collision collision with another destination or collision with existing file on disk.

filePath String

→ Boolean

Returns true if the current selection (sequence or project items) will be signed with content credentials.

Object of 2

Properties elsewhere that hold a Transcoder.

ExportMenuManager.transcoder ExportModeManager.transcoder