plugins.finalcutpro.hud.md

docs » plugins.finalcutpro.hud

---

Final Cut Pro HUD.

API Overview

• Constants - Useful values which cannot be changed
• position
• Functions - API calls offered directly by the extension
• assignButton
• choices
• delete
• generateHTML
• getButton
• getButtonCommand
• getButtonText
• getButtonURL
• hide
• init
• javaScriptCallback
• new
• refresh
• setButton
• show
• updateVisibility
• visible
• Fields - Variables which can only be accessed from an object returned by a constructor
• buttonsShown
• dropTargetsShown
• enabled
• inspectorShown

API Documentation

Constants

position

Signature	plugins.finalcutpro.hud.position <cp.prop: table>
Type	Constant
Description	Returns the last HUD frame saved in settings.

Functions

assignButton

Signature	plugins.finalcutpro.hud.assignButton() -> none
Type	Function
Description	Assigns a HUD button.
Parameters	button - which button you want to assign.
Returns	None

choices

Signature	plugins.finalcutpro.hud.choices() -> none
Type	Function
Description	Choices for the Assign HUD Button chooser.
Parameters	None
Returns	Table

delete

Signature	plugins.finalcutpro.hud.delete()
Type	Function
Description	Deletes the existing HUD if it exists
Parameters	None
Returns	None

generateHTML

Signature	plugins.finalcutpro.hud.generateHTML() -> none
Type	Function
Description	Generate the HTML for the HUD.
Parameters	None
Returns	None

getButton

Signature	plugins.finalcutpro.hud.getButton() -> table
Type	Function
Description	Gets the button values from settings.
Parameters	index - Index of the Button defaultValue - Default Value of the Button
Returns	Button value

getButtonCommand

Signature	plugins.finalcutpro.hud.getButtonCommand() -> string
Type	Function
Description	Gets the button command.
Parameters	index - Index of the Button
Returns	Button Command

getButtonText

Signature	plugins.finalcutpro.hud.getButtonText() -> string
Type	Function
Description	Gets the button text.
Parameters	index - Index of the Button
Returns	Button Label or Unassigned Value

getButtonURL

Signature	plugins.finalcutpro.hud.getButtonURL() -> string
Type	Function
Description	Gets the button URL.
Parameters	index - Index of the Button
Returns	Button URL

hide

Signature	plugins.finalcutpro.hud.hide() -> none
Type	Function
Description	Hide the HUD.
Parameters	None
Returns	None

init

Signature	plugins.finalcutpro.hud.init() -> none
Type	Function
Description	Initialise HUD Module.
Parameters	None
Returns	None

javaScriptCallback

Signature	plugins.finalcutpro.hud.javaScriptCallback() -> none
Type	Function
Description	Javascript Callback
Parameters	message - the message for the callback
Returns	None

new

Signature	plugins.finalcutpro.hud.new()
Type	Function
Description	Creates a new HUD
Parameters	None
Returns	None

refresh

Signature	plugins.finalcutpro.hud.refresh() -> none
Type	Function
Description	Refresh the HUD's content.
Parameters	None
Returns	None

setButton

Signature	plugins.finalcutpro.hud.setButton() -> string
Type	Function
Description	Sets the button.
Parameters	index - Index of the Button value - Value you want to set the button to.
Returns	None

show

Signature	plugins.finalcutpro.hud.show() -> none
Type	Function
Description	Show the HUD.
Parameters	None
Returns	None

updateVisibility

Signature	plugins.finalcutpro.hud.updateVisibility() -> none
Type	Function
Description	Update the visibility of the HUD.
Parameters	None
Returns	None

visible

Signature	plugins.finalcutpro.hud.visible() -> none
Type	Function
Description	Is the HUD visible?
Parameters	None
Returns	true or false

Fields

buttonsShown

Signature	plugins.finalcutpro.hud.buttonsShown <cp.prop: boolean>
Type	Field
Description	Should Buttons in the HUD be shown?

dropTargetsShown

Signature	plugins.finalcutpro.hud.dropTargetsShown <cp.prop: boolean>
Type	Field
Description	Should Drop Targets in the HUD be enabled?

enabled

Signature	plugins.finalcutpro.hud.enabled <cp.prop: boolean>
Type	Field
Description	Is the HUD enabled in the settings?

inspectorShown

Signature	plugins.finalcutpro.hud.inspectorShown <cp.prop: boolean>
Type	Field
Description	Should the Inspector in the HUD be shown?