Playhead

Last updated 23 days ago

Playhead Module.

API Overview

  • Functions - API calls offered directly by the extension

  • Constructors - API calls which return an object, typically one that offers API methods

  • Fields - Variables which can only be accessed from an object returned by a constructor

  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Functions

find

Signature

`cp.apple.finalcutpro.main.Playhead.find(containerUI, skimming) -> hs._asm.axuielement object

nil` </span>

Type

Function

Description

Finds the playhead (either persistent or skimming) in the specified container. Defaults to persistent.

Parameters

Returns

matches

Signature

cp.apple.finalcutpro.main.Playhead.matches(element) -> boolean

Type

Function

Description

Checks to see if a GUI element is the Playhead or not

Parameters

Returns

Constructors

new

Signature

cp.apple.finalcutpro.main.Playhead.new(parent[, skimming[, containerFn[, useEventViewer]]]) -> Playhead

Type

Constructor

Description

Constructs a new Playhead

Parameters

Returns

Fields

center

Signature

cp.apple.finalcutpro.main.Playhead.center <cp.prop: hs.geometry.point; read-only; live?>

Type

Field

Description

Gets the centre point ({x, y}) of the playhead.

Signature

cp.apple.finalcutpro.main.Playhead.currentViewer <cp.prop: cp.apple.finalcutpro.main.Viewer; read-only; live>

Type

Field

Description

Represents the current viewer for the playhead. This may be either the primary Viewer or the Event Viewer,

frame

Signature

cp.apple.finalcutpro.main.Playhead.frame <cp.prop: hs.geometry.frame; read-only; live?>

Type

Field

Description

Gets the frame of the playhead.

Signature

cp.apple.finalcutpro.main.Playhead.isPersistent <cp.prop: boolean; read-only>

Type

Field

Description

Is the playhead persistent?

isShowing

Signature

cp.apple.finalcutpro.main.Playhead.isShowing <cp.prop: boolean; read-only; live?>

Type

Field

Description

Is the playhead showing?

position

Signature

cp.apple.finalcutpro.main.Playhead.position <cp.prop; number; read-only; live?>

Type

Field

Description

Gets the horizontal position of the playhead line, which may be different to the x position of the playhead.

timecode

Signature

cp.apple.finalcutpro.main.Playhead.timecode <cp.prop: string; live?>

Type

Field

Description

Gets and sets the current timecode.

UI

Signature

cp.apple.finalcutpro.main.Playhead.UI <cp.prop: hs._asm.axuielement; read-only; live?>

Type

Field

Description

Returns the hs._asm.axuielement object for the Playhead

Methods

app

Signature

cp.apple.finalcutpro.main.Playhead:app() -> table

Type

Method

Description

Returns the cp.apple.finalcutpro app table

Parameters

Returns

hide

Signature

cp.apple.finalcutpro.main.Playhead:hide() -> Playhead object

Type

Method

Description

Hides the Playhead

Parameters

Returns

parent

Signature

cp.apple.finalcutpro.main.Playhead:parent() -> table

Type

Method

Description

Returns the Playhead's parent table

Parameters

Returns

show

Signature

cp.apple.finalcutpro.main.Playhead:show() -> Playhead object

Type

Method

Description

Shows the Playhead

Parameters

Returns