#plugins.finalcutpro.export.batch

Timeline Batch Export Plugin.

#Submodules

#API Overview

Constants - Useful values which cannot be changed

Functions - API calls offered directly by the extension

Fields - Variables which can only be accessed from an object returned by a constructor

#API Documentation

#Constants

Signatureplugins.finalcutpro.export.batch.DEFAULT_CUSTOM_FILENAME -> string
TypeConstant
DescriptionDefault Custom Filename
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 55

#Functions

Signatureplugins.finalcutpro.export.batch.batchExport() -> boolean
TypeFunction
DescriptionOpens the Batch Export popup.
Parameters
  • None
Returns
  • true if successful otherwise false
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 702
Signatureplugins.finalcutpro.export.batch.batchExportTimelineClips(clips) -> boolean
TypeFunction
DescriptionBatch Export Timeline Clips
Parameters
  • clips - table of selected Clips
Returns
  • true if successful otherwise false
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 115
Signatureplugins.finalcutpro.export.batch.changeCustomFilename() -> none
TypeFunction
DescriptionChange Custom Filename String.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 542
Signatureplugins.finalcutpro.export.batch.changeExportDestinationFolder() -> none
TypeFunction
DescriptionChange Export Destination Folder.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 518
Signatureplugins.finalcutpro.export.batch.changeExportDestinationPreset() -> none
TypeFunction
DescriptionChange Export Destination Preset.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 482
Signatureplugins.finalcutpro.export.batch.getDestinationFolder() -> string
TypeFunction
DescriptionGets the destination folder path.
Parameters
  • None
Returns
  • The destination folder path as a string.
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 571
Signatureplugins.finalcutpro.export.batch.getDestinationPreset() -> string | nil
TypeFunction
DescriptionGets the destination preset.
Parameters
  • None
Returns
  • The destination preset as a string, or nil if no preset is set.
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 596
Signatureplugins.finalcutpro.export.batch.performBatchExport() -> none
TypeFunction
DescriptionPerforms the Browser Batch Export function.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 764

#Fields

Signatureplugins.finalcutpro.export.batch.customFilename <cp.prop: string>
TypeField
DescriptionCustom Filename for Batch Export.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 90
Signatureplugins.finalcutpro.export.batch.destinationPreset <cp.prop: boolean>
TypeField
DescriptionDestination Preset.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 75
Signatureplugins.finalcutpro.export.batch.ignoreBackgroundTasks <cp.prop: boolean>
TypeField
DescriptionDefines whether or not a Batch Export should Ignore Background Tasks.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 110
Signatureplugins.finalcutpro.export.batch.ignoreInvalidCaptions <cp.prop: boolean>
TypeField
DescriptionDefines whether or not a Batch Export should Ignore Invalid Captions.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 100
Signatureplugins.finalcutpro.export.batch.ignoreMissingEffects <cp.prop: boolean>
TypeField
DescriptionDefines whether or not a Batch Export should Ignore Missing Effects.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 95
Signatureplugins.finalcutpro.export.batch.ignoreProxies <cp.prop: boolean>
TypeField
DescriptionDefines whether or not a Batch Export should Ignore Proxies.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 105
Signatureplugins.finalcutpro.export.batch.replaceExistingFiles <cp.prop: boolean>
TypeField
DescriptionDefines whether or not a Batch Export should Replace Existing Files.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 80
Signatureplugins.finalcutpro.export.batch.useCustomFilename <cp.prop: boolean>
TypeField
DescriptionDefines whether or not the Batch Export tool should override the clipname with a custom filename.
NotesNone
Sourcesrc/plugins/finalcutpro/export/batch/batch.lua line 85

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