# cp.apple.finalcutpro.inspector.Inspector

Inspector

# API Overview

Constants - Useful values which cannot be changed

INSPECTOR_TABS

Functions - API calls offered directly by the extension

matches

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

Inspector

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

audio
bottomBarUI
color
generator
info
isFullHeight
isShowing
labelUI
panelUI
projectInfo
propertiesUI
share
text
title
topBarUI
transition
video

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

doFindTabButton
doHide
doSelectTab
doShow
hide
selectedTab
selectTab
show
tabAvailable

# API Documentation

# Constants

# INSPECTOR_TABS


Signature	`cp.apple.finalcutpro.inspector.Inspector.INSPECTOR_TABS -> table`
Type	Constant
Description	Table of supported Inspector Tabs
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 38

# Functions

# matches


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

# Constructors

# Inspector


Signature	`cp.apple.finalcutpro.inspector.Inspector(parent) -> Inspector`
Type	Constructor
Description	Creates a new Inspector.
Parameters	parent - The parent object.
Returns	The Inspector object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 70

# Fields

# audio


Signature	`cp.apple.finalcutpro.inspector.Inspector.audio <cp.apple.finalcutpro.inspector.AudioInspector>`
Type	Field
Description	The AudioInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 609

# bottomBarUI


Signature	`cp.apple.finalcutpro.inspector.Inspector.bottomBarUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	Returns the bottom bar `axuielement` for the Inspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 169

# color


Signature	`cp.apple.finalcutpro.inspector.Inspector.color <cp.apple.finalcutpro.inspector.ColorInspector>`
Type	Field
Description	The ColorInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 635

# generator


Signature	`cp.apple.finalcutpro.inspector.Inspector.generator <cp.apple.finalcutpro.inspector.GeneratorInspector>`
Type	Field
Description	The GeneratorInspector
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 537

# info


Signature	`cp.apple.finalcutpro.inspector.Inspector.info <cp.apple.finalcutpro.inspector.InfoInspector>`
Type	Field
Description	The InfoInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 550

# isFullHeight


Signature	`cp.apple.finalcutpro.inspector.Inspector.isFullHeight <cp.prop: boolean>`
Type	Field
Description	Returns `true` if the Inspector is full height.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 201

# isShowing


Signature	`cp.apple.finalcutpro.inspector.Inspector.isShowing <cp.prop: boolean; read-only>`
Type	Field
Description	Returns `true` if the Inspector is showing otherwise `false`
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 191

# labelUI


Signature	`cp.apple.finalcutpro.inspector.Inspector.labelUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	Returns the `axuielement` for text label at the top of the Inspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 181

# panelUI


Signature	`cp.apple.finalcutpro.inspector.Inspector.panelUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	Returns the central panel `axuielement` for the Inspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 130

# projectInfo


Signature	`cp.apple.finalcutpro.inspector.Inspector.projectInfo <cp.apple.finalcutpro.inspector.InfoProjectInspector>`
Type	Field
Description	The InfoProjectInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 557

# propertiesUI


Signature	`cp.apple.finalcutpro.inspector.Inspector.propertiesUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	Returns the properties `axuielement` for the Inspector. This contains the rows of property values.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 151


Signature	`cp.apple.finalcutpro.inspector.Inspector.share <cp.apple.finalcutpro.inspector.ShareInspector>`
Type	Field
Description	The ShareInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 622

# text


Signature	`cp.apple.finalcutpro.inspector.Inspector.text <cp.apple.finalcutpro.inspector.TextInspector`
Type	Field
Description	The TextzInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 570

# title


Signature	`cp.apple.finalcutpro.inspector.Inspector.title <cp.apple.finalcutpro.inspector.TitleInspector>`
Type	Field
Description	The TitleInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 583

# topBarUI


Signature	`cp.apple.finalcutpro.inspector.Inspector.topBarUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	Returns the "top bar" `axuielement` for the Inspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 118

# transition


Signature	`cp.apple.finalcutpro.inspector.Inspector.transition <cp.apple.finalcutpro.inspector.TransitionInspector>`
Type	Field
Description	The TransitionInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 596

# video


Signature	`cp.apple.finalcutpro.inspector.Inspector.video <cp.apple.finalcutpro.inspector.VideoInspector>`
Type	Field
Description	The VideoInspector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 524

# Methods

# doFindTabButton


Signature	`cp.apple.finalcutpro.inspector.Inspector:doFindTabButton(type) -> cp.rx.go.Statement`
Type	Method
Description	Finds the named Inspector tab button, or sends an error if the type is unsupported.
Parameters	type - the type of the button to return. (e.g. "Video")
Returns	A Statement to execute.
Notes	Valid strings for `type` are as follows: Audio Color Effect Generator Info Share Text Title Transition Video Not all button types are available in all contexts.
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 368

# doHide


Signature	`cp.apple.finalcutpro.inspector.Inspector:doHide() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that attempts to hide the `Inspector`.
Parameters	None
Returns	The `Statement`, resolving to `true` if the Inspector was hidden successfully, or an error if not.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 303

# doSelectTab


Signature	`cp.apple.finalcutpro.inspector.Inspector:doSelectTab(title) -> cp.rx.go.Statement`
Type	Method
Description	A Statement that selects the specified tab title.
Parameters	title - The title of the tab to select.
Returns	The Statement
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 408

# doShow


Signature	`cp.apple.finalcutpro.inspector.Inspector:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that attempts to show the `Inspector`.
Parameters	None
Returns	The `Statement`, resolving to `true` if the Inspector was shown successfully, or an error if not.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 268

# hide


Signature	`cp.apple.finalcutpro.inspector.Inspector:hide() -> Inspector`
Type	Method
Description	Hides the inspector.
Parameters	None
Returns	The `Inspector` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 285

# selectedTab


Signature	`cp.apple.finalcutpro.inspector.Inspector:selectedTab() -> string or nil`
Type	Method
Description	Returns the name of the selected inspector tab otherwise `nil`.
Parameters	None
Returns	A string of the selected tab, otherwise `nil` if the Inspector is closed or an error occurred.
Notes	The tab strings can be: Audio Color Effect Generator Info Share Text Title Transition Video
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 475

# selectTab


Signature	`cp.apple.finalcutpro.inspector.Inspector:selectTab(tab) -> boolean`
Type	Method
Description	Selects a tab in the inspector.
Parameters	tab - A string from the `cp.apple.finalcutpro.inspector.Inspector.INSPECTOR_TABS` table
Returns	A string of the selected tab, otherwise `nil` if an error occurred.
Notes	This method will open the Inspector if it's closed, and leave it open. Valid strings for `value` are as follows: Audio Color Effect Generator Info Share Text Title Transition Video
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 319

# show


Signature	`cp.apple.finalcutpro.inspector.Inspector:show([tab]) -> Inspector`
Type	Method
Description	Shows the inspector.
Parameters	[tab] - A string from the `cp.apple.finalcutpro.inspector.Inspector.INSPECTOR_TABS` table
Returns	The `Inspector` instance.
Notes	Valid strings for `value` are as follows: Audio Color Effect Generator Info Share Text Title Transition Video
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 225

# tabAvailable


Signature	`cp.apple.finalcutpro.inspector.Inspector:tabAvailable(tab) -> boolean`
Type	Method
Description	Checks to see if a tab is currently available in the Inspector.
Parameters	tab - A string from the `cp.apple.finalcutpro.inspector.Inspector.INSPECTOR_TABS` table
Returns	`true` if available otherwise `false`.
Notes	Valid strings for `value` are as follows: Audio Color Effect Generator Info Share Text Title Transition Video
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 430