docs » plugins.finalcutpro.export.batch


Batch Export Plugin

Submodules

API Overview

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
  • mode - "timeline" or "browser". If no mode is specified then we will determine
  • the mode based off the mouse location.
Returns
  • `true` if successful otherwise `false`

batchExportBrowserClips

Signature plugins.finalcutpro.export.batch.batchExportBrowserClips(clips) -> boolean
Type Function
Description Batch Export Clips
Parameters
  • clips - table of selected Clips
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
Returns
  • `true` if successful otherwise `false`

changeCustomFilename

Signature plugins.finalcutpro.export.batch.changeCustomFilename() -> boolean
Type Function
Description Change Custom Filename String.
Parameters
  • None
Returns
  • `true` if successful otherwise `false`

changeExportDestinationFolder

Signature plugins.finalcutpro.export.batch.changeExportDestinationFolder() -> boolean
Type Function
Description Change Export Destination Folder.
Parameters
  • None
Returns
  • `true` if successful otherwise `false`

changeExportDestinationPreset

Signature plugins.finalcutpro.export.batch.changeExportDestinationPreset() -> boolean
Type Function
Description Change Export Destination Preset.
Parameters
  • None
Returns
  • `true` if successful otherwise `false`

getDestinationFolder

Signature `plugins.finalcutpro.export.batch.getDestinationFolder() -> string nil` </span>
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

sendBrowserClipsToCompressor

Signature plugins.finalcutpro.export.batch.sendBrowserClipsToCompressor(clips) -> boolean
Type Function
Description Send Clips to Compressor
Parameters
  • clips - table of selected Clips
Returns
  • `true` if successful otherwise `false`

sendTimelineClipsToCompressor

Signature plugins.finalcutpro.export.batch.sendTimelineClipsToCompressor(clips) -> boolean
Type Function
Description Send Timeline Clips to Compressor.
Parameters
  • clips - table of selected Clips
Returns
  • `true` if successful otherwise `false`

Fields

customFilename

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

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.

results matching ""

    No results matching ""