hud

Last updated 9 months ago

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​
​update​
​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
​
Returns
​
​choices​
Signature
plugins.finalcutpro.hud.choices() -> none
Type
Function
Description
Choices for the Assign HUD Button chooser.
Parameters
​
Returns
​
​delete​
Signature
plugins.finalcutpro.hud.delete()
Type
Function
Description
Deletes the existing HUD if it exists
Parameters
​
Returns
​
​generateHTML​
Signature
plugins.finalcutpro.hud.generateHTML() -> none
Type
Function
Description
Generate the HTML for the HUD.
Parameters
​
Returns
​
​getButton​
Signature
plugins.finalcutpro.hud.getButton() -> table
Type
Function
Description
Gets the button values from settings.
Parameters
​
Returns
​
​getButtonCommand​
Signature
plugins.finalcutpro.hud.getButtonCommand() -> string
Type
Function
Description
Gets the button command.
Parameters
​
Returns
​
​getButtonText​
Signature
plugins.finalcutpro.hud.getButtonText() -> string
Type
Function
Description
Gets the button text.
Parameters
​
Returns
​
​getButtonURL​
Signature
plugins.finalcutpro.hud.getButtonURL() -> string
Type
Function
Description
Gets the button URL.
Parameters
​
Returns
​
​hide​
Signature
plugins.finalcutpro.hud.hide() -> none
Type
Function
Description
Hide the HUD.
Parameters
​
Returns
​
​init​
Signature
plugins.finalcutpro.hud.init() -> none
Type
Function
Description
Initialise HUD Module.
Parameters
​
Returns
​
​javaScriptCallback​
Signature
plugins.finalcutpro.hud.javaScriptCallback() -> none
Type
Function
Description
Javascript Callback
Parameters
​
Returns
​
​new​
Signature
plugins.finalcutpro.hud.new()
Type
Function
Description
Creates a new HUD
Parameters
​
Returns
​
​refresh​
Signature
plugins.finalcutpro.hud.refresh() -> none
Type
Function
Description
Refresh the HUD's content.
Parameters
​
Returns
​
​setButton​
Signature
plugins.finalcutpro.hud.setButton() -> string
Type
Function
Description
Sets the button.
Parameters
​
Returns
​
​show​
Signature
plugins.finalcutpro.hud.show() -> none
Type
Function
Description
Show the HUD.
Parameters
​
Returns
​
​update​
Signature
plugins.finalcutpro.hud.update() -> none
Type
Function
Description
Enables or Disables the HUD.
Parameters
​
Returns
​
​updateVisibility​
Signature
plugins.finalcutpro.hud.updateVisibility() -> none
Type
Function
Description
Update the visibility of the HUD.
Parameters
​
Returns
​
​visible​
Signature
plugins.finalcutpro.hud.visible() -> none
Type
Function
Description
Is the HUD visible?
Parameters
​
Returns
​
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?

smartcollectionslabel

ignorecard

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

Signature	`plugins.finalcutpro.hud.assignButton() -> none`
Type	Function
Description	Assigns a HUD button.
Parameters
Returns

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

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

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

Signature	`plugins.finalcutpro.hud.getButton() -> table`
Type	Function
Description	Gets the button values from settings.
Parameters
Returns

Signature	`plugins.finalcutpro.hud.getButtonCommand() -> string`
Type	Function
Description	Gets the button command.
Parameters
Returns

Signature	`plugins.finalcutpro.hud.getButtonText() -> string`
Type	Function
Description	Gets the button text.
Parameters
Returns

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

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

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

Signature	`plugins.finalcutpro.hud.javaScriptCallback() -> none`
Type	Function
Description	Javascript Callback
Parameters
Returns

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

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

Signature	`plugins.finalcutpro.hud.setButton() -> string`
Type	Function
Description	Sets the button.
Parameters
Returns

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

Signature	`plugins.finalcutpro.hud.update() -> none`
Type	Function
Description	Enables or Disables the HUD.
Parameters
Returns

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

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

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

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

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

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

hud

API Overview

API Documentation

Constants

​position​

Functions

​assignButton​

​choices​

​delete​

​generateHTML​

​getButton​

​getButtonCommand​

​getButtonText​

​getButtonURL​

​hide​

​init​

​javaScriptCallback​

​new​

​refresh​

​setButton​

​show​

​update​

​updateVisibility​

​visible​

Fields

​buttonsShown​

​dropTargetsShown​

​enabled​

​inspectorShown​

position

assignButton

choices

delete

generateHTML

getButton

getButtonCommand

getButtonText

getButtonURL

hide

init

javaScriptCallback

new

refresh

setButton

show

update

updateVisibility

visible

buttonsShown

dropTargetsShown

enabled

inspectorShown