docs » cp.apple.finalcutpro.import.MediaImport


Media Import

API Overview

  • Functions - API calls offered directly by the extension
  • 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

Functions

matches

Signature cp.apple.finalcutpro.import.MediaImport.matches(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An `axuielementObject` to check.
Returns
  • `true` if matches otherwise `false`

new

Signature cp.apple.finalcutpro.import.MediaImport:new(app) -> MediaImport
Type Function
Description Creates a new Media Import object.
Parameters
  • app - The `cp.apple.finalcutpro` object.
Returns
  • A new MediaImport object.

Fields

isShowing

Signature cp.apple.finalcutpro.import.MediaImport.isShowing <cp.prop: boolean; read-only>
Type Field
Description Is the Media Import window showing?

Methods

app

Signature cp.apple.finalcutpro.import.MediaImport:app() -> App
Type Method
Description Returns the App instance representing Final Cut Pro.
Parameters
  • None
Returns
  • App

getTitle

Signature `cp.apple.finalcutpro.import.MediaImport:getTitle() -> string nil` </span>
Type Method
Description The title of the Media Import window or nil.
Parameters
  • None
Returns
  • The title of the Media Import window as a string or `nil`.

hide

Signature cp.apple.finalcutpro.import.MediaImport:hide() -> cp.apple.finalcutpro.import.MediaImport
Type Method
Description Hides the Media Import window.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.import.MediaImport` object for method chaining.

show

Signature cp.apple.finalcutpro.import.MediaImport:show() -> cp.apple.finalcutpro.import.MediaImport
Type Method
Description Triggers the Import All button.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.import.MediaImport` object for method chaining.

UI

Signature cp.apple.finalcutpro.import.MediaImport:UI() -> axuielementObject
Type Method
Description Returns the Media Import Accessibility Object
Parameters
  • None
Returns
  • An `axuielementObject` or `nil`

unwatch

Signature cp.apple.finalcutpro.import.MediaImport:unwatch() -> none
Type Method
Description Removes the watch with the specified ID.
Parameters
  • `id` - The ID returned from `watch` that wants to be removed.
Returns
  • None

watch

Signature cp.apple.finalcutpro.import.MediaImport:watch() -> table
Type Method
Description Watch for events that happen in the Media Import window. The optional functions will be called when the window is shown or hidden, respectively.
Parameters
  • `events` - A table of functions with to watch. These may be:
  • `show(window)` - Triggered when the window is shown.
  • `hide(window)` - Triggered when the window is hidden.
Returns
  • An ID which can be passed to `unwatch` to stop watching.

results matching ""

    No results matching ""