# plugins.finalcutpro.export.batch

Timeline Batch Export Plugin.

# Submodules

# 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
  • getDestinationPreset
  • 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
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 55

# 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
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 702

# 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
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 115

# changeCustomFilename

Signature plugins.finalcutpro.export.batch.changeCustomFilename() -> none
Type Function
Description Change Custom Filename String.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 542

# changeExportDestinationFolder

Signature plugins.finalcutpro.export.batch.changeExportDestinationFolder() -> none
Type Function
Description Change Export Destination Folder.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 518

# changeExportDestinationPreset

Signature plugins.finalcutpro.export.batch.changeExportDestinationPreset() -> none
Type Function
Description Change Export Destination Preset.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 482

# getDestinationFolder

Signature plugins.finalcutpro.export.batch.getDestinationFolder() -> string
Type Function
Description Gets the destination folder path.
Parameters
  • None
Returns
  • The destination folder path as a string.
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 571

# getDestinationPreset

Signature plugins.finalcutpro.export.batch.getDestinationPreset() -> 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.
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 596

# performBatchExport

Signature plugins.finalcutpro.export.batch.performBatchExport() -> none
Type Function
Description Performs the Browser Batch Export function.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/export/batch/batch.lua line 764

# Fields

# customFilename

Signature plugins.finalcutpro.export.batch.customFilename <cp.prop: string>
Type Field
Description Custom Filename for Batch Export.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 90

# destinationPreset

Signature plugins.finalcutpro.export.batch.destinationPreset <cp.prop: boolean>
Type Field
Description Destination Preset.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 75

# ignoreBackgroundTasks

Signature plugins.finalcutpro.export.batch.ignoreBackgroundTasks <cp.prop: boolean>
Type Field
Description Defines whether or not a Batch Export should Ignore Background Tasks.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 110

# ignoreInvalidCaptions

Signature plugins.finalcutpro.export.batch.ignoreInvalidCaptions <cp.prop: boolean>
Type Field
Description Defines whether or not a Batch Export should Ignore Invalid Captions.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 100

# ignoreMissingEffects

Signature plugins.finalcutpro.export.batch.ignoreMissingEffects <cp.prop: boolean>
Type Field
Description Defines whether or not a Batch Export should Ignore Missing Effects.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 95

# ignoreProxies

Signature plugins.finalcutpro.export.batch.ignoreProxies <cp.prop: boolean>
Type Field
Description Defines whether or not a Batch Export should Ignore Proxies.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 105

# replaceExistingFiles

Signature plugins.finalcutpro.export.batch.replaceExistingFiles <cp.prop: boolean>
Type Field
Description Defines whether or not a Batch Export should Replace Existing Files.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 80

# 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.
Notes None
Source src/plugins/finalcutpro/export/batch/batch.lua line 85

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.