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

Latest commit

 

History

History
99 lines (78 loc) · 5.15 KB

cp.apple.finalcutpro.inspector.audio.AudioInspector.md

File metadata and controls

99 lines (78 loc) · 5.15 KB
Raw

docs » cp.apple.finalcutpro.inspector.audio.AudioInspector

Audio Inspector Module.

Header Rows (compositing, transform, etc.) have the following properties:

  • enabled - (cp.ui.CheckBox) Indicates if the section is enabled.
  • toggle - (cp.ui.Button) Will toggle the Hide/Show button.
  • reset - (cp.ui.Button) Will reset the contents of the section.
  • expanded - (cp.prop ) Get/sets whether the section is expanded.

Property Rows depend on the type of property:

Menu Property:

  • value - (cp.ui.PopUpButton) The current value of the property.

Slider Property:

  • value - (cp.ui.Slider) The current value of the property.

XY Property:

  • x - (cp.ui.TextField) The current 'X' value.
  • y - (cp.ui.TextField) The current 'Y' value.

CheckBox Property:

  • value - (cp.ui.CheckBox) The currently value.

For example:

local audio = fcp.inspector.audio
-- Menu Property:
audio:compositing():blendMode():value("Subtract")
-- Slider Property:
audio:compositing():opacity():value(50.0)
-- XY Property:
audio:transform():position():x(-10.0)
-- CheckBox property:
audio:stabilization():tripodMode():value(true)

You should also be able to show a specific property and it will be revealed:

audio:stabilization():smoothing():show():value(1.5)

API Overview

  • Constants - Useful values which cannot be changed
  • EQ_MODES
  • PAN_MODES
  • Functions - API calls offered directly by the extension
  • matches
  • Constructors - API calls which return an object, typically one that offers API methods
  • AudioInspector
  • Fields - Variables which can only be accessed from an object returned by a constructor
  • audioConfiguration

API Documentation

Constants

EQ_MODES

Signature cp.apple.finalcutpro.inspector.audio.AudioInspector.EQ_MODES -> table
Type Constant
Description EQ Modes

PAN_MODES

Signature cp.apple.finalcutpro.inspector.audio.AudioInspector.PAN_MODES -> table
Type Constant
Description Pan Modes

Functions

matches

Signature cp.apple.finalcutpro.inspector.audio.AudioInspector.matches(element)
Type Function
Description Checks if the provided element could be a AudioInspector.
Parameters
  • element - The element to check
Returns
  • true if it matches, false if not.

Constructors

AudioInspector

Signature cp.apple.finalcutpro.inspector.audio.AudioInspector(parent) -> cp.apple.finalcutpro.audio.AudioInspector
Type Constructor
Description Creates a new AudioInspector object
Parameters
  • parent - The parent
Returns
  • A AudioInspector object

Fields

audioConfiguration

Signature cp.apple.finalcutpro.inspector.audio.AudioInspector.audioConfiguration <AudioConfiguration>
Type Field
Description The AudioConfiguration instance.