Getting Started
Lua
Contributing
Control CommandPost
Plugins
Internationalisation
Final Cut Pro
Bundled Extensions
CommandPost API
Bundled Plugins API
Hammerspoon API
Have an account? Sign in

MediaImport

Last updated 23 days ago

Media Import

API Overview

  • Functions - API calls offered directly by the extension

  • 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

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

Returns

Constructors

new

Signature

cp.apple.finalcutpro.import.MediaImport.new(app) -> MediaImport

Type

Constructor

Description

Creates a new Media Import object.

Parameters

Returns

Fields

frame

Signature

cp.apple.finalcutpro.import.MediaImport.frame <cp.prop: frame>

Type

Field

Description

The current position (x, y, width, height) of the window.

hsWindow

Signature

cp.apple.finalcutpro.import.MediaImport.hsWindow <cp.prop: hs.window; read-only>

Type

Field

Description

The hs.window instance for the window, or nil if it can't be found.

Signature

cp.apple.finalcutpro.import.MediaImport.isFullScreen <cp.prop: boolean>

Type

Field

Description

Is true if the window is full-screen.

isShowing

Signature

cp.apple.finalcutpro.import.MediaImport.isShowing <cp.prop: boolean>

Type

Field

Description

Is true if the window is visible.

Methods

app

Signature

cp.apple.finalcutpro.import.MediaImport:app() -> App

Type

Method

Description

Returns the App instance representing Final Cut Pro.

Parameters

Returns

getTitle

Signature

`cp.apple.finalcutpro.import.MediaImport:getTitle() -> string

nil` </span>

Type

Method

Description

The title of the Media Import window or nil.

Parameters

Returns

hide

Signature

cp.apple.finalcutpro.import.MediaImport:hide() -> cp.apple.finalcutpro.import.MediaImport

Type

Method

Description

Hides the Media Import window.

Parameters

Returns

show

Signature

cp.apple.finalcutpro.import.MediaImport:show() -> cp.apple.finalcutpro.import.MediaImport

Type

Method

Description

Triggers the Import All button.

Parameters

Returns

UI

Signature

cp.apple.finalcutpro.import.MediaImport:UI() -> axuielementObject

Type

Method

Description

Returns the Media Import Accessibility Object

Parameters

Returns