overlays

Last updated 9 months ago

Final Cut Pro Viewer Overlays.

API Overview

API Documentation

Variables

Signature

plugins.finalcutpro.viewer.overlays.activeMemory <cp.prop: number>

Type

Variable

Description

Viewer Custom Grid Color as HTML value

Signature

plugins.finalcutpro.viewer.overlays.basicGridEnabled <cp.prop: boolean>

Type

Variable

Description

Is Viewer Grid Enabled?

Signature

plugins.finalcutpro.viewer.overlays.customGridColor <cp.prop: string>

Type

Variable

Description

Viewer Custom Grid Color as HTML value

disabled

Signature

plugins.finalcutpro.viewer.overlays.disabled <cp.prop: boolean>

Type

Variable

Description

Are all the Viewer Overlay's disabled?

Signature

plugins.finalcutpro.viewer.overlays.draggableGuideEnabled <cp.prop: boolean>

Type

Variable

Description

Is Viewer Grid Enabled?

gridAlpha

Signature

plugins.finalcutpro.viewer.overlays.gridAlpha <cp.prop: number>

Type

Variable

Description

Viewer Grid Alpha

gridColor

Signature

plugins.finalcutpro.viewer.overlays.gridColor <cp.prop: string>

Type

Variable

Description

Viewer Grid Color as HTML value

Signature

plugins.finalcutpro.viewer.overlays.gridSpacing <cp.prop: number>

Type

Variable

Description

Viewer Custom Grid Color as HTML value

Signature

plugins.finalcutpro.viewer.overlays.guidePosition <cp.prop: table>

Type

Variable

Description

Guide Position.

Signature

plugins.finalcutpro.viewer.overlays.stillsLayout <cp.prop: string>

Type

Variable

Description

Stills layout.

Functions

getMemory

Signature

`plugins.finalcutpro.viewer.overlays.getMemory(id) -> image

nil` </span>

Type

Function

Description

Gets an image from memory.

Parameters

Returns

Signature

`plugins.finalcutpro.viewer.overlays.getStillsFolderPath() -> string

nil` </span>

Type

Function

Description

Gets the stills folder path.

Parameters

Returns

Signature

plugins.finalcutpro.viewer.overlays.getViewerUI() -> axuielementObject

Type

Function

Description

Gets the Viewer UI.

Parameters

Returns

hide

Signature

plugins.finalcutpro.viewer.overlays.hide() -> none

Type

Function

Description

Hides the Viewer Grid.

Parameters

Returns

Signature

plugins.finalcutpro.viewer.overlays.saveMemory() -> none

Type

Function

Description

Saves a still frame to file.

Parameters

Returns

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

Returns

Signature

plugins.finalcutpro.viewer.overlays.setGridAlpha(value) -> none

Type

Function

Description

Sets Grid Alpha.

Parameters

Returns

Signature

plugins.finalcutpro.viewer.overlays.setGridColor(value) -> none

Type

Function

Description

Sets Grid Color.

Parameters

Returns

Signature

plugins.finalcutpro.viewer.overlays.setGridSpacing(value) -> none

Type

Function

Description

Sets Grid Spacing.

Parameters

Returns

show

Signature

plugins.finalcutpro.viewer.overlays.show() -> none

Type

Function

Description

Show's the Viewer Grid.

Parameters

Returns

update

Signature

plugins.finalcutpro.viewer.overlays.update() -> none

Type

Function

Description

Updates the Viewer Grid.

Parameters

Returns

Signature

plugins.finalcutpro.viewer.overlays.viewMemory(id) -> none

Type

Function

Description

View a memory.

Parameters

Returns