playhead

Last updated 4 months ago

Browser Playhead Plugin.

API Overview

API Documentation

Functions

Signature

plugins.finalcutpro.browser.playhead.changeHighlightColor([value]) -> none

Type

Function

Description

Prompts the user to change the Playhead Highlight Colour.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.deleteHighlight() -> none

Type

Function

Description

Delete's the highlight if it's currently visible on the screen.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.getHighlightColor() -> table

Type

Function

Description

Returns the current highlight colour.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.getHighlightCustomColor() -> table

Type

Function

Description

Returns the current custom highlight colour.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.getHighlightShape() -> string

Type

Function

Description

Returns the current highlight shape.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.getHighlightTime() -> number

Type

Function

Description

Returns the current highlight playhead time.

Parameters

Returns

highlight

Signature

plugins.finalcutpro.browser.playhead.highlight() -> none

Type

Function

Description

Highlight's the Final Cut Pro Browser Playhead.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.highlightFrame([frame]) -> none

Type

Function

Description

Highlights a specific frame.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.setHighlightColor([value]) -> none

Type

Function

Description

Sets the Playhead Highlight Colour.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.setHighlightCustomColor([value]) -> none

Type

Function

Description

Sets the Custom Playhead Highlight Colour.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.setHighlightShape([value]) -> none

Type

Function

Description

Sets the Custom Playhead Highlight Shape.

Parameters

Returns

Signature

plugins.finalcutpro.browser.playhead.setHighlightTime([value]) -> none

Type

Function

Description

Sets the Custom Playhead Highlight Time.

Parameters

Returns