#cp.apple.finalcutpro.inspector.audio.AudioComponent

The Audio Configuration section of the Audio Inspector.

#API Overview

Functions - API calls offered directly by the extension

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

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


Signature	`cp.apple.finalcutpro.inspector.audio.AudioComponent(parent, subcomponent, index) -> AudioComponent`
Type	Function
Description	Creates a new Audio Component object.
Parameters	parent - The parent object. subcomponent - A boolean that defines whether or not this is a subcomponent. index - The index of the component
Returns	A new AudioComponent object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/audio/AudioComponent.lua line 74


Signature	`cp.apple.finalcutpro.inspector.audio.AudioComponent.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/AudioComponent.lua line 30


Signature	`cp.apple.finalcutpro.inspector.audio.AudioComponent.channels <cp.ui.MenuButton>`
Type	Field
Description	The channels popup menu button for the component. This only present for
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/audio/AudioComponent.lua line 232


Signature	`cp.apple.finalcutpro.inspector.audio.AudioComponent.role <cp.ui.MenuButton>`
Type	Field
Description	The role popup menu button for the subcomponent. Only present for
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/audio/AudioComponent.lua line 266


Signature	`cp.apple.finalcutpro.inspector.audio.AudioComponent.showAs <cp.ui.MenuButton>`
Type	Field
Description	The subroles popup menu button for the component. Only present for
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/audio/AudioComponent.lua line 249


Signature	`cp.apple.finalcutpro.inspector.audio.AudioComponent: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/AudioComponent.lua line 298


Signature	`cp.apple.finalcutpro.inspector.audio.AudioComponent:enabled() -> Button`
Type	Method
Description	Gets the enable/disable button for the component.
Parameters	None
Returns	The `Button` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/audio/AudioComponent.lua line 188


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