#plugins.finalcutpro.browser.playhead

Browser Playhead Plugin.

#API Overview

Functions - API calls offered directly by the extension

changeHighlightColor
deleteHighlight
getHighlightColor
getHighlightCustomColor
getHighlightShape
getHighlightTime
highlight
highlightFrame
setHighlightColor
setHighlightCustomColor
setHighlightShape
setHighlightTime

#API Documentation

#Functions

#changeHighlightColor


Signature	`plugins.finalcutpro.browser.playhead.changeHighlightColor([value]) -> none`
Type	Function
Description	Prompts the user to change the Playhead Highlight Colour.
Parameters	value - An RGB table with the selected colour (see `hs.drawing.color`)
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 100

#deleteHighlight


Signature	`plugins.finalcutpro.browser.playhead.deleteHighlight() -> none`
Type	Function
Description	Delete's the highlight if it's currently visible on the screen.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 273

#getHighlightColor


Signature	`plugins.finalcutpro.browser.playhead.getHighlightColor() -> table`
Type	Function
Description	Returns the current highlight colour.
Parameters	None
Returns	An RGB table with the selected colour (see `hs.drawing.color`) or `nil`
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 48

#getHighlightCustomColor


Signature	`plugins.finalcutpro.browser.playhead.getHighlightCustomColor() -> table`
Type	Function
Description	Returns the current custom highlight colour.
Parameters	None
Returns	An RGB table with the selected colour (see `hs.drawing.color`) or `nil`
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 74

#getHighlightShape


Signature	`plugins.finalcutpro.browser.playhead.getHighlightShape() -> string`
Type	Function
Description	Returns the current highlight shape.
Parameters	None
Returns	"Rectangle", "Circle" or "Diamond" or `nil`.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 123

#getHighlightTime


Signature	`plugins.finalcutpro.browser.playhead.getHighlightTime() -> number`
Type	Function
Description	Returns the current highlight playhead time.
Parameters	None
Returns	A number or `nil`
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 149

#highlight


Signature	`plugins.finalcutpro.browser.playhead.highlight() -> none`
Type	Function
Description	Highlight's the Final Cut Pro Browser Playhead.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 175

#highlightFrame


Signature	`plugins.finalcutpro.browser.playhead.highlightFrame([frame]) -> none`
Type	Function
Description	Highlights a specific frame.
Parameters	frame - Frame as per `hs.geometry.rect`
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 200

#setHighlightColor


Signature	`plugins.finalcutpro.browser.playhead.setHighlightColor([value]) -> none`
Type	Function
Description	Sets the Playhead Highlight Colour.
Parameters	value - An RGB table with the selected colour (see `hs.drawing.color`)
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 61

#setHighlightCustomColor


Signature	`plugins.finalcutpro.browser.playhead.setHighlightCustomColor([value]) -> none`
Type	Function
Description	Sets the Custom Playhead Highlight Colour.
Parameters	value - An RGB table with the selected colour (see `hs.drawing.color`)
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 87

#setHighlightShape


Signature	`plugins.finalcutpro.browser.playhead.setHighlightShape([value]) -> none`
Type	Function
Description	Sets the Custom Playhead Highlight Shape.
Parameters	value - A string which can be "Rectangle", "Circle" or "Diamond".
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 136

#setHighlightTime


Signature	`plugins.finalcutpro.browser.playhead.setHighlightTime([value]) -> none`
Type	Function
Description	Sets the Custom Playhead Highlight Time.
Parameters	value - A number
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/browser/playhead.lua line 162