#plugins.finalcutpro.viewer.overlays

Final Cut Pro Viewer Overlays.

#API Overview

Variables - Configurable values

activeMemory
basicGridEnabled
capslock
crossHairAlpha
crossHairColor
crossHairEnabled
customCrossHairColor
customGridColor
customGuideColor
disabled
draggableGuideEnabled
enableViewerRightClick
gridAlpha
gridColor
gridSpacing
guideAlpha
guideColor
guidePosition
letterboxEnabled
letterboxHeight
stillsLayout

Functions - API calls offered directly by the extension

deleteMemory
disableAllDraggableGuides
draggableGuidesEnabled
enableAllDraggableGuides
getCustomGuideColor
getDraggableGuideEnabled
getGuideAlpha
getGuideColor
getGuidePosition
getMemory
getStillsFolderPath
hide
importMemory
resetDraggableGuide
resetOverlays
saveMemory
setCustomCrossHairColor
setCustomGridColor
setCustomGuideColor
setGridAlpha
setGridColor
setGridSpacing
setGuideAlpha
setGuideColor
show
toggleDraggableGuide
update
viewMemory

#API Documentation

#Variables

#activeMemory


Signature	`plugins.finalcutpro.viewer.overlays.activeMemory <cp.prop: number>`
Type	Variable
Description	Viewer Custom Grid Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 148

#basicGridEnabled


Signature	`plugins.finalcutpro.viewer.overlays.basicGridEnabled <cp.prop: boolean>`
Type	Variable
Description	Is Viewer Grid Enabled?
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 113

#capslock


Signature	`plugins.finalcutpro.viewer.overlays.capslock <cp.prop: boolean>`
Type	Variable
Description	Toggle Viewer Overlays with Caps Lock.
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 188

#crossHairAlpha


Signature	`plugins.finalcutpro.viewer.overlays.crossHairAlpha <cp.prop: number>`
Type	Variable
Description	Viewer Grid Alpha
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 123

#crossHairColor


Signature	`plugins.finalcutpro.viewer.overlays.crossHairColor <cp.prop: string>`
Type	Variable
Description	Viewer Grid Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 118

#crossHairEnabled


Signature	`plugins.finalcutpro.viewer.overlays.crossHairEnabled <cp.prop: boolean>`
Type	Variable
Description	Is Viewer Cross Hair Enabled?
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 98

#customCrossHairColor


Signature	`plugins.finalcutpro.viewer.overlays.customCrossHairColor <cp.prop: table>`
Type	Variable
Description	Viewer Custom Cross Hair Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 183

#customGridColor


Signature	`plugins.finalcutpro.viewer.overlays.customGridColor <cp.prop: string>`
Type	Variable
Description	Viewer Custom Grid Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 138

#customGuideColor


Signature	`plugins.finalcutpro.viewer.overlays.customGuideColor <cp.prop: table>`
Type	Variable
Description	Viewer Custom Guide Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 178

#disabled


Signature	`plugins.finalcutpro.viewer.overlays.disabled <cp.prop: boolean>`
Type	Variable
Description	Are all the Viewer Overlay's disabled?
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 93

#draggableGuideEnabled


Signature	`plugins.finalcutpro.viewer.overlays.draggableGuideEnabled <cp.prop: table>`
Type	Variable
Description	Is Viewer Grid Enabled?
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 158

#enableViewerRightClick


Signature	`plugins.finalcutpro.viewer.overlays.enableViewerRightClick <cp.prop: boolean>`
Type	Variable
Description	Allow the user to right click on the top of the viewer to access the menu?
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 88

#gridAlpha


Signature	`plugins.finalcutpro.viewer.overlays.gridAlpha <cp.prop: number>`
Type	Variable
Description	Viewer Grid Alpha
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 133

#gridColor


Signature	`plugins.finalcutpro.viewer.overlays.gridColor <cp.prop: string>`
Type	Variable
Description	Viewer Grid Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 128

#gridSpacing


Signature	`plugins.finalcutpro.viewer.overlays.gridSpacing <cp.prop: number>`
Type	Variable
Description	Viewer Custom Grid Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 143

#guideAlpha


Signature	`plugins.finalcutpro.viewer.overlays.guideAlpha <cp.prop: table>`
Type	Variable
Description	Viewer Guide Alpha
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 173

#guideColor


Signature	`plugins.finalcutpro.viewer.overlays.guideColor <cp.prop: table>`
Type	Variable
Description	Viewer Guide Color as HTML value
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 168

#guidePosition


Signature	`plugins.finalcutpro.viewer.overlays.guidePosition <cp.prop: table>`
Type	Variable
Description	Guide Position.
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 163

#letterboxEnabled


Signature	`plugins.finalcutpro.viewer.overlays.letterboxEnabled <cp.prop: boolean>`
Type	Variable
Description	Is Viewer Letterbox Enabled?
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 103

#letterboxHeight


Signature	`plugins.finalcutpro.viewer.overlays.letterboxHeight <cp.prop: number>`
Type	Variable
Description	Letterbox Height
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 108

#stillsLayout


Signature	`plugins.finalcutpro.viewer.overlays.stillsLayout <cp.prop: string>`
Type	Variable
Description	Stills layout.
Notes	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 153

#Functions

#deleteMemory


Signature	`plugins.finalcutpro.viewer.overlays.deleteMemory() -> none`
Type	Function
Description	Deletes a memory.
Parameters	id - An identifier in the form of a number.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1125

#disableAllDraggableGuides


Signature	`plugins.finalcutpro.viewer.overlays.disableAllDraggableGuides() -> none`
Type	Function
Description	Disable all draggable guides.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1502

#draggableGuidesEnabled


Signature	`plugins.finalcutpro.viewer.overlays.draggableGuidesEnabled() -> boolean`
Type	Function
Description	Are any draggable guides enabled?
Parameters	None
Returns	`true` if at least one draggable guide is enabled otherwise `false`
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 596

#enableAllDraggableGuides


Signature	`plugins.finalcutpro.viewer.overlays.enableAllDraggableGuides() -> none`
Type	Function
Description	Enable all draggable guides.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1484

#getCustomGuideColor


Signature	`plugins.finalcutpro.viewer.overlays.getCustomGuideColor(id) -> none`
Type	Function
Description	Get Custom Guide Color.
Parameters	id - The ID of the guide.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1403

#getDraggableGuideEnabled


Signature	`plugins.finalcutpro.viewer.overlays.getDraggableGuideEnabled(id) -> none`
Type	Function
Description	Get Guide Enabled.
Parameters	id - The ID of the guide.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1520

#getGuideAlpha


Signature	`plugins.finalcutpro.viewer.overlays.getGuideAlpha() -> none`
Type	Function
Description	Get Guide Alpha.
Parameters	id - The ID of the guide.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1373

#getGuideColor


Signature	`plugins.finalcutpro.viewer.overlays.getGuideColor(id) -> none`
Type	Function
Description	Get Guide Color.
Parameters	id - The ID of the guide.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1388

#getGuidePosition


Signature	`plugins.finalcutpro.viewer.overlays.getGuidePosition() -> none`
Type	Function
Description	Get Guide Position.
Parameters	id - The ID of the guide.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1358

#getMemory


Signature	`plugins.finalcutpro.viewer.overlays.getMemory(id) -> image \| nil`
Type	Function
Description	Gets an image from memory.
Parameters	id - The ID of the memory you want to retrieve.
Returns	The memory as a `hs.image` or `nil` if the memory could not be retrieved.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1209

#getStillsFolderPath


Signature	`plugins.finalcutpro.viewer.overlays.getStillsFolderPath() -> string \| nil`
Type	Function
Description	Gets the stills folder path.
Parameters	None
Returns	The stills folder path as a string or `nil` if an error occurs.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1100

#hide


Signature	`plugins.finalcutpro.viewer.overlays.hide() -> none`
Type	Function
Description	Hides the Viewer Grid.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 580

#importMemory


Signature	`plugins.finalcutpro.viewer.overlays.importMemory() -> none`
Type	Function
Description	Import a file to memory.
Parameters	id - An identifier in the form of a number.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1179

#resetDraggableGuide


Signature	`plugins.finalcutpro.viewer.overlays.resetDraggableGuide(id) -> none`
Type	Function
Description	Reset a specific Draggable Guide.
Parameters	id - The ID of the guide.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1556

#resetOverlays


Signature	`plugins.finalcutpro.viewer.overlays.resetOverlays() -> none`
Type	Function
Description	Resets all overlays to their default values.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1594

#saveMemory


Signature	`plugins.finalcutpro.viewer.overlays.saveMemory() -> none`
Type	Function
Description	Saves a still frame to file.
Parameters	id - An identifier in the form of a number.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1149

#setCustomCrossHairColor


Signature	`plugins.finalcutpro.viewer.overlays.setCustomCrossHairColor() -> none`
Type	Function
Description	Pops up a Color Dialog box allowing the user to select a custom colour for cross hairs.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1319

#setCustomGridColor


Signature	`plugins.finalcutpro.viewer.overlays.setCustomGridColor() -> none`
Type	Function
Description	Pops up a Color Dialog box allowing the user to select a custom colour for grid lines.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1296

#setCustomGuideColor


Signature	`plugins.finalcutpro.viewer.overlays.setCustomGuideColor() -> none`
Type	Function
Description	Pops up a Color Dialog box allowing the user to select a custom colour for guide lines.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1454

#setGridAlpha


Signature	`plugins.finalcutpro.viewer.overlays.setGridAlpha(value) -> none`
Type	Function
Description	Sets Grid Alpha.
Parameters	value - The value you want to set.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1268

#setGridColor


Signature	`plugins.finalcutpro.viewer.overlays.setGridColor(value) -> none`
Type	Function
Description	Sets Grid Color.
Parameters	value - The value you want to set.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1282

#setGridSpacing


Signature	`plugins.finalcutpro.viewer.overlays.setGridSpacing(value) -> none`
Type	Function
Description	Sets Grid Spacing.
Parameters	value - The value you want to set.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1254

#setGuideAlpha


Signature	`plugins.finalcutpro.viewer.overlays.setGuideAlpha(id, value) -> none`
Type	Function
Description	Sets Guide Alpha.
Parameters	id - The ID of the guide. value - The value you want to set.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1418

#setGuideColor


Signature	`plugins.finalcutpro.viewer.overlays.setGuideColor(id, value) -> none`
Type	Function
Description	Sets Guide Color.
Parameters	id - The ID of the guide. value - The value you want to set.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1436

#show


Signature	`plugins.finalcutpro.viewer.overlays.show() -> none`
Type	Function
Description	Show's the Viewer Grid.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 200

#toggleDraggableGuide


Signature	`plugins.finalcutpro.viewer.overlays.toggleDraggableGuide(id) -> none`
Type	Function
Description	Toggle Guide Enabled.
Parameters	id - The ID of the guide.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1535

#update


Signature	`plugins.finalcutpro.viewer.overlays.update() -> none`
Type	Function
Description	Updates the Viewer Grid.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 961

#viewMemory


Signature	`plugins.finalcutpro.viewer.overlays.viewMemory(id) -> none`
Type	Function
Description	View a memory.
Parameters	id - The ID of the memory you want to retrieve.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/viewer/overlays.lua line 1232