# cp.apple.finalcutpro.main.EffectsBrowser

Effects Browser Module.

# API Overview

Constants - Useful values which cannot be changed

  • EFFECTS
  • TRANSITIONS

Variables - Configurable values

  • isShowing

Functions - API calls offered directly by the extension

  • matches

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

  • EffectsBrowser

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

  • contents
  • group
  • mainGroupUI
  • search
  • sidebar
  • sidebarToggle
  • toggleButton

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

  • applyItem
  • audioCategoryRowsUI
  • currentItemsUI
  • doHideSidebar
  • doShow
  • doShowSidebar
  • doToggleSidebar
  • getCurrentTitles
  • hide
  • hideSidebar
  • itemIsSelected
  • loadLayout
  • saveLayout
  • selectedItemsUI
  • show
  • showAllAudioEffects
  • showAllEffects
  • showAllTransitions
  • showAllVideoEffects
  • showAudioCategory
  • showInstalledEffects
  • showInstalledTransitions
  • showSidebar
  • showTransitionsCategory
  • showVideoCategory
  • toggleSidebar
  • type
  • videoCategoryRowsUI

# API Documentation

# Constants

# EFFECTS

Signature cp.apple.finalcutpro.main.EffectsBrowser.EFFECTS -> string
Type Constant
Description Effects.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 33

# TRANSITIONS

Signature cp.apple.finalcutpro.main.EffectsBrowser.TRANSITIONS -> string
Type Constant
Description Transitions.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 38

# Variables

# isShowing

Signature cp.apple.finalcutpro.main.EffectsBrowser.isShowing <cp.prop: boolean>
Type Variable
Description Is the Effects Browser showing?
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 101

# Functions

# matches

Signature cp.apple.finalcutpro.main.EffectsBrowser.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/main/EffectsBrowser.lua line 43

# Constructors

# EffectsBrowser

Signature cp.apple.finalcutpro.main.EffectsBrowser(parent, type) -> EffectsBrowser
Type Constructor
Description Creates a new EffectsBrowser instance.
Parameters
  • parent - The parent object.
  • type - A string determining whether the Effects Browser is for Effects (cp.apple.finalcutpro.main.EffectsBrowser.EFFECTS) or Transitions (cp.apple.finalcutpro.main.EffectsBrowser.TRANSITIONS).
Returns
  • A new EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 56

# Fields

# contents

Signature cp.apple.finalcutpro.main.EffectsBrowser.contents <cp.ui.ScrollArea>
Type Field
Description The Effects Browser Contents.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 651

# group

Signature cp.apple.finalcutpro.main.EffectsBrowser.group <cp.ui.PopUpButton>
Type Field
Description The group PopUpButton.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 671

# mainGroupUI

Signature cp.apple.finalcutpro.main.EffectsBrowser:mainGroupUI() -> <cp.prop: hs.axuielement; read-only>
Type Field
Description Main Group UI.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 629

# search

Signature cp.apple.finalcutpro.main.EffectsBrowser.search <cp.ui.PopUpButton>
Type Field
Description The Search PopUpButton object.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 680

# sidebar

Signature cp.apple.finalcutpro.main.EffectsBrowser.sidebar <cp.ui.OldTable>
Type Field
Description The sidebar Table object.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 642

# sidebarToggle

Signature cp.apple.finalcutpro.main.EffectsBrowser.sidebarToggle <cp.ui.CheckBox>
Type Field
Description The Sidebar Toggle.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 662

# toggleButton

Signature cp.apple.finalcutpro.main.EffectsBrowser.toggleButton <cp.ui.RadioButton>
Type Field
Description The Effects Browser Toggle Button.
Notes None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 108

# Methods

# applyItem

Signature cp.apple.finalcutpro.main.EffectsBrowser:applyItem(itemUI) -> EffectsBrowser
Type Method
Description Applies an item by double clicking on it.
Parameters
  • itemUI - The axuielementObject of the item you want to apply.
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 580

# audioCategoryRowsUI

Signature cp.apple.finalcutpro.main.EffectsBrowser:audioCategoryRowsUI() -> axuielementObject
Type Method
Description Gets the Audio Category Rows UI.
Parameters
  • None
Returns
  • axuielementObject object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 395

# currentItemsUI

Signature cp.apple.finalcutpro.main.EffectsBrowser:currentItemsUI() -> axuielementObject
Type Method
Description Gets the current items UI.
Parameters
  • None
Returns
  • axuielementObject object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 533

# doHideSidebar

Signature cp.apple.finalcutpro.main.EffectsBrowser:doHideSidebar() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will hide the Sidebar.
Parameters
  • None
Returns
  • The Statement.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 240

# doShow

Signature cp.apple.finalcutpro.main.EffectsBrowser:doShow() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will show the Effects Browser.
Parameters
  • None
Returns
  • The Statement.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 170

# doShowSidebar

Signature cp.apple.finalcutpro.main.EffectsBrowser:doShowSidebar() -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will show the Sidebar.
Parameters
  • None
Returns
  • The Statement.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 210

# doToggleSidebar

Signature cp.apple.finalcutpro.main.EffectsBrowser:doToggleSidebar() -> cp.rx.go.Statement
Type Method
Description A Statement to toggle the Sidebar.
Parameters
  • None
Returns
  • The Statement object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 267

# getCurrentTitles

Signature cp.apple.finalcutpro.main.EffectsBrowser:getCurrentTitles() -> table
Type Method
Description Returns the list of titles for all effects/transitions currently visible.
Parameters
  • None
Returns
  • A table
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 604

# hide

Signature cp.apple.finalcutpro.main.EffectsBrowser:hide() -> EffectsBrowser
Type Method
Description Hide the Effects Browser.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 153

# hideSidebar

Signature cp.apple.finalcutpro.main.EffectsBrowser:hideSidebar() -> EffectsBrowser
Type Method
Description Hide Sidebar.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 223

# itemIsSelected

Signature cp.apple.finalcutpro.main.EffectsBrowser:itemIsSelected(itemUI) -> boolean
Type Method
Description Checks to see if an item is selected.
Parameters
  • itemUI - A axuielementObject to check.
Returns
  • true if the item is selected, otherwise false.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 559

# loadLayout

Signature cp.apple.finalcutpro.main.EffectsBrowser:loadLayout(layout) -> none
Type Method
Description Loads a Effects Browser layout.
Parameters
  • layout - A table containing the Effects Browser layout settings - created using cp.apple.finalcutpro.main.Browser:saveLayout().
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 717

# saveLayout

Signature cp.apple.finalcutpro.main.EffectsBrowser:saveLayout() -> table
Type Method
Description Saves the current Effects Browser layout to a table.
Parameters
  • None
Returns
  • A table containing the current Effects Browser Layout.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 689

# selectedItemsUI

Signature cp.apple.finalcutpro.main.EffectsBrowser:selectedItemsUI() -> axuielementObject
Type Method
Description Gets the selected items UI.
Parameters
  • None
Returns
  • axuielementObject object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 546

# show

Signature cp.apple.finalcutpro.main.EffectsBrowser:show() -> EffectsBrowser
Type Method
Description Show the Effects Browser.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 121

# showAllAudioEffects

Signature cp.apple.finalcutpro.main.EffectsBrowser:showAllAudioEffects() -> boolean
Type Method
Description Show All Audio Effects.
Parameters
  • None
Returns
  • true if successful otherwise false.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 483

# showAllEffects

Signature cp.apple.finalcutpro.main.EffectsBrowser:showAllEffects() -> EffectsBrowser
Type Method
Description Show All Effects.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 308

# showAllTransitions

Signature cp.apple.finalcutpro.main.EffectsBrowser:showAllTransitions() -> EffectsBrowser
Type Method
Description Show All Transitions.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 323

# showAllVideoEffects

Signature cp.apple.finalcutpro.main.EffectsBrowser:showAllVideoEffects() -> boolean
Type Method
Description Show All Video Effects.
Parameters
  • None
Returns
  • true if successful otherwise false.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 441

# showAudioCategory

Signature cp.apple.finalcutpro.main.EffectsBrowser:showAudioCategory(name) -> self
Type Method
Description Ensures the sidebar is showing and that the selected 'Audio' category is selected, if available.
Parameters
  • name - The category name, in the current language.
Returns
  • The browser.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 510

# showInstalledEffects

Signature cp.apple.finalcutpro.main.EffectsBrowser:showInstalledEffects() -> EffectsBrowser
Type Method
Description Show Installed Effects.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 280

# showInstalledTransitions

Signature cp.apple.finalcutpro.main.EffectsBrowser:showInstalledTransitions() -> EffectsBrowser
Type Method
Description Show Installed Transitions.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 294

# showSidebar

Signature cp.apple.finalcutpro.main.EffectsBrowser:showSidebar() -> EffectsBrowser
Type Method
Description Show Sidebar.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 194

# showTransitionsCategory

Signature cp.apple.finalcutpro.main.EffectsBrowser:showTransitionsCategory(name) -> EffectsBrowser
Type Method
Description Ensures the sidebar is showing and that the selected 'Transitions' category is selected, if available.
Parameters
  • name - The category name, in the current language.
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 336

# showVideoCategory

Signature cp.apple.finalcutpro.main.EffectsBrowser:showVideoCategory(name) -> EffectsBrowser
Type Method
Description Ensures the sidebar is showing and that the selected 'Video' category is selected, if available.
Parameters
  • name - The category name, in the current language.
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 468

# toggleSidebar

Signature cp.apple.finalcutpro.main.EffectsBrowser:toggleSidebar() -> EffectsBrowser
Type Method
Description Toggle Sidebar.
Parameters
  • None
Returns
  • The EffectsBrowser object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 253

# type

Signature cp.apple.finalcutpro.main.EffectsBrowser:type() -> App
Type Method
Description Type of Effects Browser.
Parameters
  • None
Returns
  • App
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 82

# videoCategoryRowsUI

Signature cp.apple.finalcutpro.main.EffectsBrowser:videoCategoryRowsUI() -> axuielementObject
Type Method
Description Gets the Video Category Rows UI.
Parameters
  • None
Returns
  • axuielementObject object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/main/EffectsBrowser.lua line 372

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