docs » cp.apple.finalcutpro.main.Inspector


Inspector

Submodules

API Overview

API Documentation

Constants

INSPECTOR_TABS

Signature cp.apple.finalcutpro.main.Inspector.INSPECTOR_TABS -> table
Type Constant
Description Table of supported Inspector Tabs

Functions

isShowing

Signature cp.apple.finalcutpro.main.Inspector.isShowing() -> boolean
Type Function
Description Returns true if the Inspector is showing otherwise false
Parameters
  • None
Returns
  • `true` if showing, otherwise `false`

matches

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

Methods

app

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

audioInspector

Signature cp.apple.finalcutpro.main.Inspector:audioInspector() -> AudioInspector
Type Method
Description Gets the AudioInspector object.
Parameters
  • None
Returns
  • AudioInspector

colorInspector

Signature cp.apple.finalcutpro.main.Inspector:colorInspector() -> ColorInspector
Type Method
Description Gets the ColorInspector object.
Parameters
  • None
Returns
  • ColorInspector

effectInspector

Signature cp.apple.finalcutpro.main.Inspector:effectInspector() -> EffectInspector
Type Method
Description Gets the EffectInspector object.
Parameters
  • None
Returns
  • EffectInspector

generatorInspector

Signature cp.apple.finalcutpro.main.Inspector:generatorInspector() -> GeneratorInspector
Type Method
Description Gets the GeneratorInspector object.
Parameters
  • None
Returns
  • GeneratorInspector

hide

Signature cp.apple.finalcutpro.main.Inspector:hide() -> Inspector
Type Method
Description Hides the inspector.
Parameters
  • None
Returns
  • The `Inspector` instance.

infoInspector

Signature cp.apple.finalcutpro.main.Inspector:infoInspector() -> InfoInspector
Type Method
Description Gets the InfoInspector object.
Parameters
  • None
Returns
  • InfoInspector

new

Signature cp.apple.finalcutpro.main.Inspector:new(parent) -> Inspector
Type Method
Description Creates a new Inspector.
Parameters
  • None
Returns
  • App

parent

Signature cp.apple.finalcutpro.main.Inspector:parent() -> Parent
Type Method
Description Returns the parent of the Inspector.
Parameters
  • None
Returns
  • App

selectedTab

Signature cp.apple.finalcutpro.main.Inspector:selectedTab() -> string or nil
Type Method
Description Returns the name of the selected inspector tab otherwise nil.
Parameters
  • None
Returns
  • A string of the selected tab, otherwise `nil` if the Inspector is closed or an error occurred.
Notes
  • The tab strings can be:
  • Audio
  • Color
  • Effect
  • Generator
  • Info
  • Share
  • Text
  • Title
  • Transition
  • Video

selectTab

Signature cp.apple.finalcutpro.main.Inspector:selectTab([tab]) -> boolean or nil
Type Method
Description Selects a tab in the inspector.
Parameters
  • [tab] - A string from the `cp.apple.finalcutpro.main.Inspector.INSPECTOR_TABS` table
Returns
  • A string of the selected tab, otherwise `nil` if an error occurred.
Notes
  • This method will open the Inspector if it's closed, and leave it open.
  • Valid strings for `value` are as follows:
  • Audio
  • Color
  • Effect
  • Generator
  • Info
  • Share
  • Text
  • Title
  • Transition
  • Video

shareInspector

Signature cp.apple.finalcutpro.main.Inspector:shareInspector() -> ShareInspector
Type Method
Description Gets the ShareInspector object.
Parameters
  • None
Returns
  • ShareInspector

show

Signature cp.apple.finalcutpro.main.Inspector:show([tab]) -> Inspector
Type Method
Description Shows the inspector.
Parameters
  • [tab] - A string from the `cp.apple.finalcutpro.main.Inspector.INSPECTOR_TABS` table
Returns
  • The `Inspector` instance.
Notes
  • Valid strings for `value` are as follows:
  • Audio
  • Color
  • Effect
  • Generator
  • Info
  • Share
  • Text
  • Title
  • Transition
  • Video

textInspector

Signature cp.apple.finalcutpro.main.Inspector:textInspector() -> TextInspector
Type Method
Description Gets the TextInspector object.
Parameters
  • None
Returns
  • TextInspector

titleInspector

Signature cp.apple.finalcutpro.main.Inspector:titleInspector() -> TitleInspector
Type Method
Description Gets the TitleInspector object.
Parameters
  • None
Returns
  • TitleInspector

transitionInspector

Signature cp.apple.finalcutpro.main.Inspector:transitionInspector() -> TransitionInspector
Type Method
Description Gets the TransitionInspector object.
Parameters
  • None
Returns
  • TransitionInspector

UI

Signature cp.apple.finalcutpro.main.Inspector:UI() -> axuielementObject
Type Method
Description Returns the Inspectors Accessibility Object
Parameters
  • None
Returns
  • An `axuielementObject` on `nil`

videoInspector

Signature cp.apple.finalcutpro.main.Inspector:videoInspector() -> VideoInspector
Type Method
Description Gets the VideoInspector object.
Parameters
  • None
Returns
  • ColorInspector

results matching ""

    No results matching ""