docs » cp.apple.finalcutpro.main.Inspector.ColorInspector


Color Inspector Module.

Requires Final Cut Pro 10.4 or later.

Submodules

API Overview

API Documentation

Constants

CORRECTION_TYPES

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector.CORRECTION_TYPES
Type Constant
Description Table of Correction Types

Methods

app

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:app() -> table
Type Method
Description Returns the cp.apple.finalcutpro app table
Parameters
  • None
Returns
  • The application object as a table

colorBoard

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

colorCurves

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

colorInspectorBarUI

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:colorInspectorBarUI() -> hs._asm.axuielement object
Type Method
Description Returns the hs._asm.axuielement object for the Final Cut Pro 10.4 Color Board Inspector Bar (i.e. where you can add new Color Corrections from the dropdown)
Parameters
  • None
Returns
  • A `hs._asm.axuielement` object or `nil` if not running Final Cut Pro 10.4 (or later), or if an error occurs.

colorWheels

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

hide

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:hide() -> ColorInspector
Type Method
Description Hides's the Color Inspector
Parameters
  • None
Returns
  • ColorInspector object

hueSaturationCurves

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

isShowing

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:isShowing([correctionType]) -> boolean
Type Method
Description Returns whether or not the Color Inspector is visible
Parameters
  • [correctionType] - A string containing the name of the Correction Type (see cp.apple.finalcutpro.main.Inspector.ColorInspector.CORRECTION_TYPES).
Returns
  • `true` if the Color Inspector is showing, otherwise `false`

new

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:new(parent) -> ColorInspector object
Type Method
Description Creates a new ColorInspector object
Parameters
  • `parent` - The parent
Returns
  • A ColorInspector object

parent

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:parent() -> table
Type Method
Description Returns the ColorInspector's parent table
Parameters
  • None
Returns
  • The parent object as a table

show

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:show([correctionType]) -> ColorInspector
Type Method
Description Show's the Color Inspector
Parameters
  • [correctionType] - A string containing the name of the Correction Type (see cp.apple.finalcutpro.main.Inspector.ColorInspector.CORRECTION_TYPES).
Returns
  • ColorInspector object

UI

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector:UI() -> hs._asm.axuielement object
Type Method
Description Returns the hs._asm.axuielement object for the Final Cut Pro 10.4 Color Board Inspector.
Parameters
  • None
Returns
  • A `hs._asm.axuielement` object or `nil` if not running Final Cut Pro 10.4 (or later), or if an error occurs.

results matching ""

    No results matching ""