#cp.apple.finalcutpro.export.ExportDialog

Export Dialog Module.


#API Overview

Constructors - API calls which return an object, typically one that offers API methods

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

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Constructors

Signaturecp.apple.finalcutpro.export.ExportDialogTitleText(parent)
TypeConstructor
DescriptionCreates a new Export Dialog
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/export/ExportDialog.lua line 37

#Fields

Signaturecp.apple.finalcutpro.export.ExportDialog.fileExtension <cp.ui.StaticText>
TypeField
DescriptionThe "File Extension" StaticText.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/export/ExportDialog.lua line 288

Signaturecp.apple.finalcutpro.export.ExportDialog.saveSheet <SaveSheet>
TypeField
DescriptionThe SaveSheet.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/export/ExportDialog.lua line 299

#Methods

Signaturecp.apple.finalcutpro.export.ExportDialog:hide() -> cp.apple.finalcutpro.export.ExportDialog
TypeMethod
DescriptionHides the Export Dialog
Parameters
  • None
Returns
  • The cp.apple.finalcutpro.export.ExportDialog object for method chaining.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/export/ExportDialog.lua line 234

Signaturecp.apple.finalcutpro.export.ExportDialog:pressCancel() -> cp.apple.finalcutpro.export.ExportDialog
TypeMethod
DescriptionPresses the Cancel Button.
Parameters
  • None
Returns
  • The cp.apple.finalcutpro.export.ExportDialog object for method chaining.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/export/ExportDialog.lua line 255

Signaturecp.apple.finalcutpro.export.ExportDialog:pressNext() -> cp.apple.finalcutpro.export.ExportDialog
TypeMethod
DescriptionPresses the Next Button.
Parameters
  • None
Returns
  • The cp.apple.finalcutpro.export.ExportDialog object for method chaining.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/export/ExportDialog.lua line 275

Signaturecp.apple.finalcutpro.export.ExportDialog:show(destinationSelect, ignoreProxyWarning, ignoreMissingMedia, ignoreInvalidCaptions, quiet) -> cp.apple.finalcutpro.export.ExportDialog, string
TypeMethod
DescriptionShows the Export Dialog with the Destination that matches the destinationSelect.
Parameters
  • destinationSelect - The name, number or match function of the destination to export with.
  • ignoreProxyWarning - if true, the warning regarding exporting Proxies will be ignored.
  • ignoreMissingMedia - if true, the warning regarding exporting with missing media will be ignored.
  • ignoreInvalidCaptions - if true, the warning regarding exporting with Bad Captions will be ignored.
  • quiet - if true, no dialogs will be shown if there is an error.
Returns
  • The cp.apple.finalcutpro.export.ExportDialog object for method chaining.
  • If an error occurred, the message is returned as the second value
Notes
  • If providing a function, it will be passed one item - the name of the destination, and should return true to indicate a match. The name will not contain " (default)" if present.
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/export/ExportDialog.lua line 72