#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

Functions - API calls offered directly by the extension

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


#API Documentation

#Variables

Signatureplugins.finalcutpro.workflowextension.connected -> boolean
TypeVariable
DescriptionIs CommandPost connecting to the Workflow Extension?
NotesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 97

Signatureplugins.finalcutpro.workflowextension.lastPlayheadPosition -> string
TypeVariable
DescriptionThe last playhead position.
NotesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 107

Signatureplugins.finalcutpro.workflowextension.skimmingRestoreTimer -> hs.timer.delayed
TypeVariable
DescriptionDelayed Timer to Restore the Skimming Feature (if required)
NotesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 371

Signatureplugins.finalcutpro.workflowextension.wasSkimmingEnabled -> boolean
TypeVariable
DescriptionWas the Skimming Feature enabled?
NotesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 366

#Functions

Signatureplugins.finalcutpro.workflowextension.callback() -> none
TypeFunction
DescriptionTriggers when the Socket receives data.
Parameters
  • data - The incoming data.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 229

Signatureplugins.finalcutpro.workflowextension.connect() -> none
TypeFunction
DescriptionConnect to the Workflow Extension Socket Server.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 257

Signatureplugins.finalcutpro.workflowextension.connectionCallback() -> none
TypeFunction
DescriptionTriggers when the Socket makes a connection.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 158

Signatureplugins.finalcutpro.workflowextension.decrementPlayhead(frames) -> none
TypeFunction
DescriptionDecrements the Final Cut Pro playhead via the Workflow Extension
Parameters
  • frames - The amount of frames to increment by
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 424

Signatureplugins.finalcutpro.workflowextension.disconnect() -> none
TypeFunction
DescriptionDisconnects from the Workflow Extension Socket Server.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 295

Signatureplugins.finalcutpro.workflowextension.forcefullyInstall() -> none
TypeFunction
DescriptionForcefully installs the Workflow Extension.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 615

Signatureplugins.finalcutpro.workflowextension.incrementPlayhead(frames) -> none
TypeFunction
DescriptionIncrements the Final Cut Pro playhead via the Workflow Extension
Parameters
  • frames - The amount of frames to increment by
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 409

Signatureplugins.finalcutpro.workflowextension.movePlayheadToSeconds(seconds) -> none
TypeFunction
DescriptionMoves 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
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 439

Signatureplugins.finalcutpro.workflowextension.ping() -> none
TypeFunction
DescriptionSends a ping to the Workflow Extension
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 452

Signatureplugins.finalcutpro.workflowextension.repositionWorkflowExtension() -> none
TypeFunction
DescriptionRepositions the Workflow Extension.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 527

Signatureplugins.finalcutpro.workflowextension.sendCommand(command) -> none
TypeFunction
DescriptionSends a command to the Workflow
Parameters
  • command - The command as a string
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 331

Signatureplugins.finalcutpro.workflowextension.setupActions() -> none
TypeFunction
DescriptionSetup the Workflow Extension Actions
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 466

#Fields

Signatureplugins.finalcutpro.workflowextension.hasWorkflowExtensionBeenAddedVersion -> cp.prop
TypeField
DescriptionReturns the CommandPost Version String for the last time the Workflow Extension was added.
NotesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 82

Signatureplugins.finalcutpro.workflowextension.hasWorkflowExtensionBeenMovedVersion -> cp.prop
TypeField
DescriptionReturns the CommandPost Version String for the last time the Workflow Extension was moved.
NotesNone
Sourcesrc/plugins/finalcutpro/workflowextension/init.lua line 87