# plugins.finalcutpro.workflowextension

Workflow Extension Helper

Commands that can be SENT to the Workflow Extension:

PING - Send a ping INCR f - Increment by Frame (where f is number of frames) DECR f - Decrement by Frame (where f is number of frames) GOTO s - Goto Timeline Position (where s is number of seconds)

Commands that can be RECEIVED from the Workflow Extension:

DONE - Connection successful DEAD - Server is shutting down PONG - Recieve a pong PLHD s - The playhead time has changed (where s is playhead position in seconds)

SEQC sequenceName || startTime || duration || frameDuration || container || timecodeFormat || objectType - The active sequence has changed (sequenceName is a string) (startTime in seconds) (duration in seconds) (frameDuration in seconds) (container as a string) (timecodeFormat as a string: DropFrame, NonDropFrame, Unspecified or Unknown) (objectType as a string: Event, Library, Project, Sequence or Unknown)

RNGC startTime || duration - The active sequence time range has changed (startTime in seconds) (duration in seconds)


# API Overview

Variables - Configurable values

  • connected
  • lastPlayheadPosition
  • skimmingRestoreTimer
  • wasSkimmingEnabled

Functions - API calls offered directly by the extension

  • callback
  • connect
  • connectionCallback
  • decrementPlayhead
  • disconnect
  • forcefullyInstall
  • incrementPlayhead
  • movePlayheadToSeconds
  • ping
  • repositionWorkflowExtension
  • sendCommand
  • setupActions

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

  • hasWorkflowExtensionBeenAddedVersion
  • hasWorkflowExtensionBeenMovedVersion

# API Documentation

# Variables

# connected

Signature plugins.finalcutpro.workflowextension.connected -> boolean
Type Variable
Description Is CommandPost connecting to the Workflow Extension?
Notes None
Source src/plugins/finalcutpro/workflowextension/init.lua line 97

# lastPlayheadPosition

Signature plugins.finalcutpro.workflowextension.lastPlayheadPosition -> string
Type Variable
Description The last playhead position.
Notes None
Source src/plugins/finalcutpro/workflowextension/init.lua line 107

# skimmingRestoreTimer

Signature plugins.finalcutpro.workflowextension.skimmingRestoreTimer -> hs.timer.delayed
Type Variable
Description Delayed Timer to Restore the Skimming Feature (if required)
Notes None
Source src/plugins/finalcutpro/workflowextension/init.lua line 371

# wasSkimmingEnabled

Signature plugins.finalcutpro.workflowextension.wasSkimmingEnabled -> boolean
Type Variable
Description Was the Skimming Feature enabled?
Notes None
Source src/plugins/finalcutpro/workflowextension/init.lua line 366

# Functions

# callback

Signature plugins.finalcutpro.workflowextension.callback() -> none
Type Function
Description Triggers when the Socket receives data.
Parameters
  • data - The incoming data.
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 229

# connect

Signature plugins.finalcutpro.workflowextension.connect() -> none
Type Function
Description Connect to the Workflow Extension Socket Server.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 257

# connectionCallback

Signature plugins.finalcutpro.workflowextension.connectionCallback() -> none
Type Function
Description Triggers when the Socket makes a connection.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 158

# decrementPlayhead

Signature plugins.finalcutpro.workflowextension.decrementPlayhead(frames) -> none
Type Function
Description Decrements the Final Cut Pro playhead via the Workflow Extension
Parameters
  • frames - The amount of frames to increment by
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 424

# disconnect

Signature plugins.finalcutpro.workflowextension.disconnect() -> none
Type Function
Description Disconnects from the Workflow Extension Socket Server.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 295

# forcefullyInstall

Signature plugins.finalcutpro.workflowextension.forcefullyInstall() -> none
Type Function
Description Forcefully installs the Workflow Extension.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 615

# incrementPlayhead

Signature plugins.finalcutpro.workflowextension.incrementPlayhead(frames) -> none
Type Function
Description Increments the Final Cut Pro playhead via the Workflow Extension
Parameters
  • frames - The amount of frames to increment by
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 409

# movePlayheadToSeconds

Signature plugins.finalcutpro.workflowextension.movePlayheadToSeconds(seconds) -> none
Type Function
Description Moves the Final Cut Pro playhead via the Workflow Extension
Parameters
  • seconds - The value you want the timeline playhead to move to in seconds
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 439

# ping

Signature plugins.finalcutpro.workflowextension.ping() -> none
Type Function
Description Sends a ping to the Workflow Extension
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 452

# repositionWorkflowExtension

Signature plugins.finalcutpro.workflowextension.repositionWorkflowExtension() -> none
Type Function
Description Repositions the Workflow Extension.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 527

# sendCommand

Signature plugins.finalcutpro.workflowextension.sendCommand(command) -> none
Type Function
Description Sends a command to the Workflow
Parameters
  • command - The command as a string
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 331

# setupActions

Signature plugins.finalcutpro.workflowextension.setupActions() -> none
Type Function
Description Setup the Workflow Extension Actions
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/workflowextension/init.lua line 466

# Fields

# hasWorkflowExtensionBeenAddedVersion

Signature plugins.finalcutpro.workflowextension.hasWorkflowExtensionBeenAddedVersion -> cp.prop
Type Field
Description Returns the CommandPost Version String for the last time the Workflow Extension was added.
Notes None
Source src/plugins/finalcutpro/workflowextension/init.lua line 82

# hasWorkflowExtensionBeenMovedVersion

Signature plugins.finalcutpro.workflowextension.hasWorkflowExtensionBeenMovedVersion -> cp.prop
Type Field
Description Returns the CommandPost Version String for the last time the Workflow Extension was moved.
Notes None
Source src/plugins/finalcutpro/workflowextension/init.lua line 87