# cp.apple.finalcutpro.inspector.color.ColorAdjustments

Color Adjustments Module.

Requires Final Cut Pro v10.6.6 or later.


# API Overview

Constants - Useful values which cannot be changed

  • CONTROL_RANGES

Functions - API calls offered directly by the extension

  • matches

Constructors - API calls which return an object, typically one that offers API methods

  • ColorAdjustments

Fields - Variables which can only be accessed from an object returned by a constructor

  • blackPointRow
  • blackPointSlider
  • blackPointTextField
  • brightnessRow
  • brightnessSlider
  • brightnessTextField
  • contentUI
  • contrastRow
  • contrastSlider
  • contrastTextField
  • exposureRow
  • exposureSlider
  • exposureTextField
  • highlightsRow
  • highlightsSlider
  • highlightsTextField
  • highlightsTintRow
  • highlightsTintSlider
  • highlightsTintTextField
  • highlightsWarmthRow
  • highlightsWarmthSlider
  • highlightsWarmthTextField
  • midtonesTintRow
  • midtonesTintSlider
  • midtonesTintTextField
  • midtonesWarmthRow
  • midtonesWarmthSlider
  • midtonesWarmthTextField
  • mixRow
  • mixSlider
  • mixTextField
  • saturationRow
  • saturationSlider
  • saturationTextField
  • shadowsRow
  • shadowsSlider
  • shadowsTextField
  • shadowsTintRow
  • shadowsTintSlider
  • shadowsTintTextField
  • shadowsWarmthRow
  • shadowsWarmthSlider
  • shadowsWarmthTextField

Methods - API calls which can only be made on an object returned by a constructor

  • controlRange
  • controlRangeLabel
  • show

# API Documentation

# Constants

# CONTROL_RANGES

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.CONTROL_RANGES
Type Constant
Description Table of Control Ranges.
Notes
  • Possible values are:
  • ** SDR
  • ** HLG
  • ** PQ 1000 nits
  • ** PQ 2000 nites
  • ** PQ 4000 nits
  • ** PQ 10000 nits
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 163

# Functions

# matches

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.matches(element)
Type Function
Description Checks if the specified element is the Color Curves element.
Parameters
  • element - The element to check
Returns
  • true if the element is the Color Curves.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 33

# Constructors

# ColorAdjustments

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments(parent) -> ColorAdjustments object
Type Constructor
Description Creates a new ColorAdjustments object
Parameters
  • parent - The parent
Returns
  • A ColorInspector object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 53

# Fields

# blackPointRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.blackPointRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 472

# blackPointSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.blackPointSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 479

# blackPointTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.blackPointTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 491

# brightnessRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.brightnessRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 343

# brightnessSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.brightnessSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 350

# brightnessTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.brightnessTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 362

# contentUI

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.contentUI <cp.prop: hs.axuielement; read-only>
Type Field
Description The axuielement representing the content element of the ColorAdjustments corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 121

# contrastRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.contrastRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 300

# contrastSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.contrastSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 307

# contrastTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.contrastTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 319

# exposureRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.exposureRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 257

# exposureSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.exposureSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 264

# exposureTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.exposureTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 276

# highlightsRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 429

# highlightsSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 436

# highlightsTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 448

# highlightsTintRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsTintRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 601

# highlightsTintSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsTintSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 608

# highlightsTintTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsTintTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 620

# highlightsWarmthRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsWarmthRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 558

# highlightsWarmthSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsWarmthSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 565

# highlightsWarmthTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.highlightsWarmthTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 577

# midtonesTintRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.midtonesTintRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 687

# midtonesTintSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.midtonesTintSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 694

# midtonesTintTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.midtonesTintTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 706

# midtonesWarmthRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.midtonesWarmthRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 644

# midtonesWarmthSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.midtonesWarmthSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 651

# midtonesWarmthTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.midtonesWarmthTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 663

# mixRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.mixRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 816

# mixSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.mixSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 823

# mixTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.mixTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 835

# saturationRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.saturationRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 386

# saturationSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.saturationSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 393

# saturationTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.saturationTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 405

# shadowsRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 515

# shadowsSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 522

# shadowsTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 534

# shadowsTintRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsTintRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 773

# shadowsTintSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsTintSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 780

# shadowsTintTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsTintTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 792

# shadowsWarmthRow

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsWarmthRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the parameter, and axuielement values for that row.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 730

# shadowsWarmthSlider

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsWarmthSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 737

# shadowsWarmthTextField

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.shadowsWarmthTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 749

# Methods

# controlRange

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.controlRange(id) -> boolean
Type Method
Description Sets the Control Range Menu Item.
Parameters
  • id - A string containing the control range value (in English)
Returns
  • true if successful, otherwise false
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 184

# controlRangeLabel

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments.controlRangeLabel(id) -> boolean
Type Method
Description Gets the Control Range i18n Value.
Parameters
  • id - A string containing the control range value (in English)
Returns
  • A string
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 220

# show

Signature cp.apple.finalcutpro.inspector.color.ColorAdjustments:show() -> boolean
Type Method
Description Show's the Color Board within the Color Inspector.
Parameters
  • None
Returns
  • ColorAdjustments object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 99