Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
71 lines (57 loc) · 4.94 KB

cp.apple.finalcutpro.import.MediaImport.md

File metadata and controls

71 lines (57 loc) · 4.94 KB

docs » cp.apple.finalcutpro.import.MediaImport


Media Import

API Overview

  • Functions - API calls offered directly by the extension
  • matches
  • Constructors - API calls which return an object, typically one that offers API methods
  • MediaImport
  • Fields - Variables which can only be accessed from an object returned by a constructor
  • importAll
  • stopImport
  • Methods - API calls which can only be made on an object returned by a constructor
  • hide
  • show

API Documentation

Functions

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

Constructors

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

Fields

Signature cp.apple.finalcutpro.import.MediaImport.importAll <cp.ui.Button>
Type Field
Description The Import All button.
Signature cp.apple.finalcutpro.import.MediaImport.stopImport <cp.ui.Button>
Type Field
Description The "Stop Import" button.

Methods

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.
Signature cp.apple.finalcutpro.import.MediaImport:show() -> cp.apple.finalcutpro.import.MediaImport
Type Method
Description Shows the Media Import window.
Parameters
  • None
Returns
  • The cp.apple.finalcutpro.import.MediaImport object for method chaining.