#cp.apple.finalcutpro.inspector.Inspector

Inspector

#API Overview

Constants - Useful values which cannot be changed

Functions - API calls offered directly by the extension

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

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

#API Documentation

#Constants

Signaturecp.apple.finalcutpro.inspector.Inspector.INSPECTOR_TABS -> table
TypeConstant
DescriptionTable of supported Inspector Tabs
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 38

#Functions

Signaturecp.apple.finalcutpro.inspector.Inspector.matches(element) -> boolean
TypeFunction
DescriptionChecks to see if an element matches what we think it should be.
Parameters
  • element - axuielementObject
Returns
  • true if matches otherwise false
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 54

#Constructors

Signaturecp.apple.finalcutpro.inspector.Inspector(parent) -> Inspector
TypeConstructor
DescriptionCreates a new Inspector.
Parameters
  • parent - The parent object.
Returns
  • The Inspector object.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 70

#Fields

Signaturecp.apple.finalcutpro.inspector.Inspector.audio <cp.apple.finalcutpro.inspector.AudioInspector>
TypeField
DescriptionThe AudioInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 609
Signaturecp.apple.finalcutpro.inspector.Inspector.bottomBarUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionReturns the bottom bar axuielement for the Inspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 169
Signaturecp.apple.finalcutpro.inspector.Inspector.color <cp.apple.finalcutpro.inspector.ColorInspector>
TypeField
DescriptionThe ColorInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 635
Signaturecp.apple.finalcutpro.inspector.Inspector.generator <cp.apple.finalcutpro.inspector.GeneratorInspector>
TypeField
DescriptionThe GeneratorInspector
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 537
Signaturecp.apple.finalcutpro.inspector.Inspector.info <cp.apple.finalcutpro.inspector.InfoInspector>
TypeField
DescriptionThe InfoInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 550
Signaturecp.apple.finalcutpro.inspector.Inspector.isFullHeight <cp.prop: boolean>
TypeField
DescriptionReturns true if the Inspector is full height.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 201
Signaturecp.apple.finalcutpro.inspector.Inspector.isShowing <cp.prop: boolean; read-only>
TypeField
DescriptionReturns true if the Inspector is showing otherwise false
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 191
Signaturecp.apple.finalcutpro.inspector.Inspector.labelUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionReturns the axuielement for text label at the top of the Inspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 181
Signaturecp.apple.finalcutpro.inspector.Inspector.panelUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionReturns the central panel axuielement for the Inspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 130
Signaturecp.apple.finalcutpro.inspector.Inspector.projectInfo <cp.apple.finalcutpro.inspector.InfoProjectInspector>
TypeField
DescriptionThe InfoProjectInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 557
Signaturecp.apple.finalcutpro.inspector.Inspector.propertiesUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionReturns the properties axuielement for the Inspector. This contains the rows of property values.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 151
Signaturecp.apple.finalcutpro.inspector.Inspector.share <cp.apple.finalcutpro.inspector.ShareInspector>
TypeField
DescriptionThe ShareInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 622

#text

Signaturecp.apple.finalcutpro.inspector.Inspector.text <cp.apple.finalcutpro.inspector.TextInspector
TypeField
DescriptionThe TextzInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 570
Signaturecp.apple.finalcutpro.inspector.Inspector.title <cp.apple.finalcutpro.inspector.TitleInspector>
TypeField
DescriptionThe TitleInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 583
Signaturecp.apple.finalcutpro.inspector.Inspector.topBarUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionReturns the "top bar" axuielement for the Inspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 118
Signaturecp.apple.finalcutpro.inspector.Inspector.transition <cp.apple.finalcutpro.inspector.TransitionInspector>
TypeField
DescriptionThe TransitionInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 596
Signaturecp.apple.finalcutpro.inspector.Inspector.video <cp.apple.finalcutpro.inspector.VideoInspector>
TypeField
DescriptionThe VideoInspector.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 524

#Methods

Signaturecp.apple.finalcutpro.inspector.Inspector:doFindTabButton(type) -> cp.rx.go.Statement
TypeMethod
DescriptionFinds 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
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.
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 368
Signaturecp.apple.finalcutpro.inspector.Inspector:doHide() -> cp.rx.go.Statement
TypeMethod
DescriptionA 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.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 303
Signaturecp.apple.finalcutpro.inspector.Inspector:doSelectTab(title) -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that selects the specified tab title.
Parameters
  • title - The title of the tab to select.
Returns
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 408
Signaturecp.apple.finalcutpro.inspector.Inspector:doShow() -> cp.rx.go.Statement
TypeMethod
DescriptionA 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.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 268
Signaturecp.apple.finalcutpro.inspector.Inspector:hide() -> Inspector
TypeMethod
DescriptionHides the inspector.
Parameters
  • None
Returns
  • The Inspector instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 285
Signaturecp.apple.finalcutpro.inspector.Inspector:selectedTab() -> string or nil
TypeMethod
DescriptionReturns 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
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 475
Signaturecp.apple.finalcutpro.inspector.Inspector:selectTab(tab) -> boolean
TypeMethod
DescriptionSelects 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
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 319
Signaturecp.apple.finalcutpro.inspector.Inspector:show([tab]) -> Inspector
TypeMethod
DescriptionShows 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
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 225
Signaturecp.apple.finalcutpro.inspector.Inspector:tabAvailable(tab) -> boolean
TypeMethod
DescriptionChecks 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
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/Inspector.lua line 430

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.