cp.apple.finalcutpro.main.MediaBrowser.md

docs » cp.apple.finalcutpro.main.MediaBrowser

---

Media Browser Module.

API Overview

• Constants - Useful values which cannot be changed
• GARAGE_BAND
• ITUNES
• 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.

ITUNES

Signature	cp.apple.finalcutpro.main.MediaBrowser.ITUNES -> number
Type	Constant
Description	iTunes ID.

MAX_SECTIONS

Signature	cp.apple.finalcutpro.main.MediaBrowser.MAX_SECTIONS -> number
Type	Constant
Description	Maximum Sections.

PHOTOS

Signature	cp.apple.finalcutpro.main.MediaBrowser.PHOTOS -> number
Type	Constant
Description	Photos ID.

SOUND_EFFECTS

Signature	cp.apple.finalcutpro.main.MediaBrowser.SOUND_EFFECTS -> number
Type	Constant
Description	Sound Effects ID.

TITLE

Signature	cp.apple.finalcutpro.main.MediaBrowser.TITLE -> string
Type	Constant
Description	Photos & Audio Title.

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.

Fields

group

Signature	cp.apple.finalcutpro.main.MediaBrowser.group <cp.ui.PopUpButton>
Type	Field
Description	The group PopUpButton.

isShowing

Signature	cp.apple.finalcutpro.main.MediaBrowser.isShowing <cp.prop: boolean; read-only>
Type	Field
Description	Checks if the Media Browser is showing.

mainGroupUI

Signature	cp.apple.finalcutpro.main.MediaBrowser.mainGroupUI <cp.prop: hs._asm.axuielement; read-only>
Type	Field
Description	Returns the main group UI for the Media Browser, or nil if not available.

search

Signature	cp.apple.finalcutpro.main.MediaBrowser.search <cp.ui.TextField>
Type	Field
Description	The search TextField.

sidebar

Signature	cp.apple.finalcutpro.main.MediaBrowser.sidebar <cp.ui.Table>
Type	Field
Description	The Sidebar Table.

Methods

hide

Signature	cp.apple.finalcutpro.main.MediaBrowser:hide() -> MediaBrowser
Type	Method
Description	Hide the Media Browser.
Parameters	None
Returns	The MediaBrowser object.

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

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.

show

Signature	cp.apple.finalcutpro.main.MediaBrowser:show() -> MediaBrowser
Type	Method
Description	Show the Media Browser.
Parameters	None
Returns	The MediaBrowser object.

showGarageBand

Signature	cp.apple.finalcutpro.main.MediaBrowser:showGarageBand() -> MediaBrowser
Type	Method
Description	Show Garage Band Section.
Parameters	None
Returns	MediaBrowser object.

showITunes

Signature	cp.apple.finalcutpro.main.MediaBrowser:showITunes() -> MediaBrowser
Type	Method
Description	Show iTunes Section.
Parameters	None
Returns	MediaBrowser object.

showPhotos

Signature	cp.apple.finalcutpro.main.MediaBrowser:showPhotos() -> MediaBrowser
Type	Method
Description	Show Photos Section.
Parameters	None
Returns	MediaBrowser object.

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.

showSidebar

Signature	cp.apple.finalcutpro.main.MediaBrowser:showSidebar() -> MediaBrowser
Type	Method
Description	Show the Media Browser Sidebar.
Parameters	None
Returns	MediaBrowser object.

showSoundEffects

Signature	cp.apple.finalcutpro.main.MediaBrowser:showSoundEffects() -> MediaBrowser
Type	Method
Description	Show Sound Effects Section.
Parameters	None
Returns	MediaBrowser object.

topCategoriesUI

Signature	cp.apple.finalcutpro.main.MediaBrowser:topCategoriesUI() -> axuielementObject
Type	Method
Description	Get the Top Categories UI.
Parameters	None
Returns	axuielementObject object.