Object

EncoderHostScriptObject

Provides several utility methods including batch commands to run, pause or stop the batch.

Methods

→ Object

Returns an 'EncoderWrapper' script object for the requested format.

inFormatName String

→ Varies

Returns the current status of the batch encoder. The values are: invalid paused running stopped stopping (available since 23.3).

arg1 String

→ Boolean

Writes out the current batch preview image (tiff format) to the given path.

inOutputPath String Path to store a 'tiff' file.

→ Varies

Returns a list of all available formats.

→ SourceMediaInfo

Returns a 'SourceMediaInfo' script object which can give detailed info about the provided source.

sourcePath String Media path

→ Varies

Returns list of all available formats.

→ Boolean

Returns true if a batch job is running.

→ Varies

Pauses the batch (always returns true). ### Todo: Do we want to return a result when e.g. the batch was already paused or something went wrong?

arg1 Boolean

→ Varies

Runs the batch (always returns true). ### Todo: Do we want to return a result when e.g. the batch was already running or something went wrong?

arg1 Boolean

→ Varies

Stops the batch (always returns true). ### Todo: Do we want to return a result when e.g. the batch was already stopped or something went wrong?

arg1 Boolean