Media Encoder2027
Object

EncoderWrapper

Queue item object to set encode properties

Properties

NameType AccessDescription
Varies readonly Gets the list of files the encode generated
Number readonly Gets the height of the encoded output file
Number readonly Gets the width of the encoded output file

Methods

→ Boolean

Toggle the inclusion of source XMP [boolean] input value required

includeSourceXMP Boolean
→ Number

Returns the encode progress as percentage

→ Number

Return the encode time in milliseconds

→ String

Returns the log output including possible warnings and errors (available since 23.2.).

→ Varies

Returns a list of missing assets

includeSource Boolean Get missing asset list from the source group if requested
includeOutput Boolean
→ Varies

Returns the presets available for the assigned format

→ Boolean

Changes the format for the batch item

format String E.g. 'H.264' Loads all presets available for the assigned format
→ Boolean

Loads and assigns the preset to the batch item

presetPath String
→ Boolean

Sets the crop state [boolean] input value required

cropState Boolean
→ Boolean

Sets the scale type

cropType Varies
arg2 Varies
arg3 Varies
arg4 Varies
arg5 Varies
arg6 Number 6 StretchToFillBeforeCrop
→ Boolean

Sets the cue point data

inCuePointsFilePath String
→ Boolean

Sets the frame rate for the batch item

framerate String E.g. '24' as string
→ Boolean

Toggle the inclusion of cue points [boolean] input value required

includeSourceCuePoints Boolean
→ Boolean

Sets the output frame size

width Number
height Number
→ Boolean

Sets the rotation (in a 360 degree system)

rotationValue Number E.g. 0.0 - 360.0
→ Boolean

Sets the scale type

scaleType Varies
arg2 Varies
arg3 Varies
arg4 Varies
arg5 Varies
arg6 Number 6 StretchToFillBeforeCrop
→ Boolean

Set the time interpolation type

interpolationType Varies
arg2 Number 2 OpticalFlow
→ Boolean

Toggle the use of frame blending [boolean] input value required

useFrameBlending Boolean
→ Boolean

Toggle the use of maximum render quality [boolean] input value required

useMaximumRenderQuality Boolean
→ Boolean

Toggle the use of previews files. [boolean] input value required

usePreviewFiles Boolean
→ Boolean

Sets the work area type start and end time for the batch item

workAreaType Varies
arg2 Varies
arg3 Varies
arg4 Number 4 UseDefault
startTime Number
endTime Number
→ Boolean

Sets the work area type start and end time in ticks for the batch item (available since 23.3)

workAreaType Varies
arg2 Varies
arg3 Varies
arg4 Number 4 UseDefault
startTime String
endTime String
→ Boolean

Sets XMP data to given template

templateXMPFilePath String

Return 1

Methods that return a EncoderWrapper.