plugins.finalcutpro.export.batch.md

docs » plugins.finalcutpro.export.batch

---

Timeline Batch Export Plugin.

Submodules

• plugins.finalcutpro.export.batch.manager

API Overview

• Constants - Useful values which cannot be changed
• DEFAULT_CUSTOM_FILENAME
• Functions - API calls offered directly by the extension
• batchExport
• batchExportTimelineClips
• changeCustomFilename
• changeExportDestinationFolder
• changeExportDestinationPreset
• getDestinationFolder
• performBatchExport
• Fields - Variables which can only be accessed from an object returned by a constructor
• customFilename
• destinationPreset
• ignoreBackgroundTasks
• ignoreInvalidCaptions
• ignoreMissingEffects
• ignoreProxies
• replaceExistingFiles
• useCustomFilename

API Documentation

Constants

DEFAULT_CUSTOM_FILENAME

Signature	plugins.finalcutpro.export.batch.DEFAULT_CUSTOM_FILENAME -> string
Type	Constant
Description	Default Custom Filename

Functions

batchExport

Signature	plugins.finalcutpro.export.batch.batchExport() -> boolean
Type	Function
Description	Opens the Batch Export popup.
Parameters	None
Returns	true if successful otherwise false

batchExportTimelineClips

Signature	plugins.finalcutpro.export.batch.batchExportTimelineClips(clips) -> boolean
Type	Function
Description	Batch Export Timeline Clips
Parameters	clips - table of selected Clips sendToCompressor - true if sending to Compressor, otherwise false
Returns	true if successful otherwise false

changeCustomFilename

Signature	plugins.finalcutpro.export.batch.changeCustomFilename() -> none
Type	Function
Description	Change Custom Filename String.
Parameters	None
Returns	None

changeExportDestinationFolder

Signature	plugins.finalcutpro.export.batch.changeExportDestinationFolder() -> none
Type	Function
Description	Change Export Destination Folder.
Parameters	None
Returns	None

changeExportDestinationPreset

Signature	plugins.finalcutpro.export.batch.changeExportDestinationPreset() -> none
Type	Function
Description	Change Export Destination Preset.
Parameters	None
Returns	None

getDestinationFolder

| Signature | plugins.finalcutpro.export.batch.getDestinationFolder() -> string | nil | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Gets the destination preset. | | Parameters |

• None

| | Returns |

• The destination preset as a string, or nil if no preset is set.

|

performBatchExport

Signature	plugins.finalcutpro.export.batch.performBatchExport() -> none
Type	Function
Description	Performs the Browser Batch Export function.
Parameters	None
Returns	None

Fields

customFilename

Signature	plugins.finalcutpro.export.batch.customFilename <cp.prop: string>
Type	Field
Description	Custom Filename for Batch Export.

destinationPreset

Signature	plugins.finalcutpro.export.batch.destinationPreset <cp.prop: boolean>
Type	Field
Description	Destination Preset.

ignoreBackgroundTasks

Signature	plugins.finalcutpro.export.batch.ignoreBackgroundTasks <cp.prop: boolean>
Type	Field
Description	Defines whether or not a Batch Export should Ignore Background Tasks.

ignoreInvalidCaptions

Signature	plugins.finalcutpro.export.batch.ignoreInvalidCaptions <cp.prop: boolean>
Type	Field
Description	Defines whether or not a Batch Export should Ignore Invalid Captions.

ignoreMissingEffects

Signature	plugins.finalcutpro.export.batch.ignoreMissingEffects <cp.prop: boolean>
Type	Field
Description	Defines whether or not a Batch Export should Ignore Missing Effects.

ignoreProxies

Signature	plugins.finalcutpro.export.batch.ignoreProxies <cp.prop: boolean>
Type	Field
Description	Defines whether or not a Batch Export should Ignore Proxies.

replaceExistingFiles

Signature	plugins.finalcutpro.export.batch.replaceExistingFiles <cp.prop: boolean>
Type	Field
Description	Defines whether or not a Batch Export should Replace Existing Files.

useCustomFilename

Signature	plugins.finalcutpro.export.batch.useCustomFilename <cp.prop: boolean>
Type	Field
Description	Defines whether or not the Batch Export tool should override the clipname with a custom filename.