cp.apple.finalcutpro.export.ExportDialog.md

docs » cp.apple.finalcutpro.export.ExportDialog

---

Export Dialog Module.

API Overview

• Constructors - API calls which return an object, typically one that offers API methods
• ExportDialogTitleText
• Fields - Variables which can only be accessed from an object returned by a constructor
• fileExtension
• saveSheet
• Methods - API calls which can only be made on an object returned by a constructor
• hide
• pressCancel
• pressNext
• show

API Documentation

Constructors

ExportDialogTitleText

Signature	cp.apple.finalcutpro.export.ExportDialogTitleText(parent)
Type	Constructor
Description	Creates a new Export Dialog

Fields

fileExtension

Signature	cp.apple.finalcutpro.export.ExportDialog.fileExtension <cp.ui.StaticText>
Type	Field
Description	The "File Extension" StaticText.

saveSheet

Signature	cp.apple.finalcutpro.export.ExportDialog.saveSheet <SaveSheet>
Type	Field
Description	The SaveSheet.

Methods

hide

Signature	cp.apple.finalcutpro.export.ExportDialog:hide() -> cp.apple.finalcutpro.export.ExportDialog
Type	Method
Description	Hides the Export Dialog
Parameters	None
Returns	The cp.apple.finalcutpro.export.ExportDialog object for method chaining.

pressCancel

Signature	cp.apple.finalcutpro.export.ExportDialog:pressCancel() -> cp.apple.finalcutpro.export.ExportDialog
Type	Method
Description	Presses the Cancel Button.
Parameters	None
Returns	The cp.apple.finalcutpro.export.ExportDialog object for method chaining.

pressNext

Signature	cp.apple.finalcutpro.export.ExportDialog:pressNext() -> cp.apple.finalcutpro.export.ExportDialog
Type	Method
Description	Presses the Next Button.
Parameters	None
Returns	The cp.apple.finalcutpro.export.ExportDialog object for method chaining.

show

Signature	cp.apple.finalcutpro.export.ExportDialog:show(destinationSelect, ignoreProxyWarning, ignoreMissingMedia, ignoreInvalidCaptions, quiet) -> cp.apple.finalcutpro.export.ExportDialog, string
Type	Method
Description	Shows 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.