#plugins.finalcutpro.menu.proxyicon

Final Cut Pro Proxy Icon Plugin.

#API Overview

Constants - Useful values which cannot be changed

procyMenuIconEnabled

Functions - API calls offered directly by the extension

generateProxyTitle
init

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

usingProxies

#API Documentation

#Constants

#procyMenuIconEnabled


Signature	`plugins.finalcutpro.menu.proxyicon.procyMenuIconEnabled <cp.prop: boolean>`
Type	Constant
Description	Toggles the Enable Proxy Menu Icon
Notes	None
Source	src/plugins/finalcutpro/menu/proxyicon.lua line 34

#Functions

#generateProxyTitle


Signature	`plugins.finalcutpro.menu.proxyicon.generateProxyTitle() -> string`
Type	Function
Description	Generates the Proxy Title
Parameters	None
Returns	String containing the Proxy Title
Notes	None
Examples	None
Source	src/plugins/finalcutpro/menu/proxyicon.lua line 18

#init


Signature	`plugins.finalcutpro.menu.proxyicon.init(menuManager) -> none`
Type	Function
Description	Initalise the module.
Parameters	menuManager - The menu manager plugin
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/menu/proxyicon.lua line 39

#Fields

#usingProxies


Signature	`plugins.finalcutpro.menu.proxyicon.usingProxies -> <cp.prop: boolean>`
Type	Field
Description	Using Proxies?
Notes	None
Source	src/plugins/finalcutpro/menu/proxyicon.lua line 13