#cp.apple.finalcutpro.main.MediaBrowser

Media Browser Module.

#API Overview

Constants - Useful values which cannot be changed

GARAGE_BAND
ITUNES
LEGACY_TITLE
MAX_SECTIONS
PHOTOS
SOUND_EFFECTS
TITLE

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

MediaBrowser

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

group
isShowing
mainGroupUI
search
sidebar

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

hide
loadLayout
saveLayout
show
showGarageBand
showITunes
showPhotos
showSection
showSidebar
showSoundEffects
topCategoriesUI

#API Documentation

#Constants

#GARAGE_BAND


Signature	`cp.apple.finalcutpro.main.MediaBrowser.GARAGE_BAND -> number`
Type	Constant
Description	Garage Band ID.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 46

#ITUNES


Signature	`cp.apple.finalcutpro.main.MediaBrowser.ITUNES -> number`
Type	Constant
Description	iTunes ID.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 51

#LEGACY_TITLE


Signature	`cp.apple.finalcutpro.main.MediaBrowser.LEGACY_TITLE -> string`
Type	Constant
Description	Photos & Audio Title in v10.6.1 and earlier.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 31

#MAX_SECTIONS


Signature	`cp.apple.finalcutpro.main.MediaBrowser.MAX_SECTIONS -> number`
Type	Constant
Description	Maximum Sections.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 36

#PHOTOS


Signature	`cp.apple.finalcutpro.main.MediaBrowser.PHOTOS -> number`
Type	Constant
Description	Photos ID.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 41

#SOUND_EFFECTS


Signature	`cp.apple.finalcutpro.main.MediaBrowser.SOUND_EFFECTS -> number`
Type	Constant
Description	Sound Effects ID.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 56

#TITLE


Signature	`cp.apple.finalcutpro.main.MediaBrowser.TITLE -> string`
Type	Constant
Description	Photos & Audio Title in v10.6.2 and later.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 26

#Constructors

#MediaBrowser


Signature	`cp.apple.finalcutpro.main.MediaBrowser(parent) -> MediaBrowser`
Type	Constructor
Description	Creates a new `Browser` instance.
Parameters	parent - The parent object.
Returns	A new `MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 61

#Fields

#group


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

#isShowing


Signature	`cp.apple.finalcutpro.main.MediaBrowser.isShowing <cp.prop: boolean; read-only>`
Type	Field
Description	Checks if the Media Browser is showing.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 80

#mainGroupUI


Signature	`cp.apple.finalcutpro.main.MediaBrowser.mainGroupUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	Returns the main group UI for the Media Browser, or `nil` if not available.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 88

#search


Signature	`cp.apple.finalcutpro.main.MediaBrowser.search <cp.ui.TextField>`
Type	Field
Description	The search TextField.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 166


Signature	`cp.apple.finalcutpro.main.MediaBrowser.sidebar <cp.ui.OldTable>`
Type	Field
Description	The Sidebar `Table`.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 148

#Methods

#hide


Signature	`cp.apple.finalcutpro.main.MediaBrowser:hide() -> MediaBrowser`
Type	Method
Description	Hide the Media Browser.
Parameters	None
Returns	The `MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 128

#loadLayout


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

#saveLayout


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

#show


Signature	`cp.apple.finalcutpro.main.MediaBrowser:show() -> MediaBrowser`
Type	Method
Description	Show the Media Browser.
Parameters	None
Returns	The `MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 106

#showGarageBand


Signature	`cp.apple.finalcutpro.main.MediaBrowser:showGarageBand() -> MediaBrowser`
Type	Method
Description	Show Garage Band Section.
Parameters	None
Returns	`MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 235

#showITunes


Signature	`cp.apple.finalcutpro.main.MediaBrowser:showITunes() -> MediaBrowser`
Type	Method
Description	Show iTunes Section.
Parameters	None
Returns	`MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 248

#showPhotos


Signature	`cp.apple.finalcutpro.main.MediaBrowser:showPhotos() -> MediaBrowser`
Type	Method
Description	Show Photos Section.
Parameters	None
Returns	`MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 222

#showSection


Signature	`cp.apple.finalcutpro.main.MediaBrowser:showSection(index) -> MediaBrowser`
Type	Method
Description	Show a specific section.
Parameters	index - The index ID of the section you want to show as a number.
Returns	`MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 204

#showSidebar


Signature	`cp.apple.finalcutpro.main.MediaBrowser:showSidebar() -> MediaBrowser`
Type	Method
Description	Show the Media Browser Sidebar.
Parameters	None
Returns	`MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 175

#showSoundEffects


Signature	`cp.apple.finalcutpro.main.MediaBrowser:showSoundEffects() -> MediaBrowser`
Type	Method
Description	Show Sound Effects Section.
Parameters	None
Returns	`MediaBrowser` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 261

#topCategoriesUI


Signature	`cp.apple.finalcutpro.main.MediaBrowser:topCategoriesUI() -> axuielementObject`
Type	Method
Description	Get the Top Categories UI.
Parameters	None
Returns	`axuielementObject` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/MediaBrowser.lua line 189