# cp.apple.finalcutpro.inspector.audio.AudioConfiguration

The Audio Configuration section of the Audio Inspector.


# API Overview

Functions - API calls offered directly by the extension

  • AudioConfiguration
  • matches

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

  • component
  • doShow
  • show
  • subcomponent

# API Documentation

# Functions

# AudioConfiguration

Signature cp.apple.finalcutpro.inspector.audio.AudioConfiguration(parent) -> AudioConfiguration
Type Function
Description Creates a new Media Import object.
Parameters
  • parent - The parent object.
Returns
  • A new AudioConfiguration object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/audio/AudioConfiguration.lua line 33

# matches

Signature cp.apple.finalcutpro.inspector.audio.AudioConfiguration.matches(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/audio/AudioConfiguration.lua line 20

# Methods

# component

Signature cp.apple.finalcutpro.inspector.audio.AudioConfiguration:component() -> table
Type Method
Description Returns a table of AudioComponent objects for all main audio components.
Parameters
  • None
Returns
  • A table containing AudioComponent objects.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/audio/AudioConfiguration.lua line 61

# doShow

Signature cp.apple.finalcutpro.inspector.audio.AudioConfiguration:doShow() -> cp.rx.go.Statement
Type Method
Description A Statement that will attempt to show the bar.
Parameters
  • None
Returns
  • The Statement, which will resolve to true if successful, or send an error if not.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/audio/AudioConfiguration.lua line 110

# show

Signature cp.apple.finalcutpro.inspector.audio.AudioConfiguration:show() -> self
Type Method
Description Attempts to show the bar.
Parameters
  • None
Returns
  • The AudioConfiguration instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/audio/AudioConfiguration.lua line 95

# subcomponent

Signature cp.apple.finalcutpro.inspector.audio.AudioConfiguration:subcomponent() -> table
Type Method
Description Returns a table of AudioComponent objects for all audio subcomponents.
Parameters
  • None
Returns
  • A table containing AudioComponent objects.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/audio/AudioConfiguration.lua line 78