plugins.finalcutpro.tangent.manager.md

docs » plugins.finalcutpro.tangent.manager

---

Tangent Control Surface Manager

This plugin allows Hammerspoon to communicate with Tangent's range of panels (Element, Virtual Element Apps, Wave, Ripple and any future panels).

Download the Tangent Developer Support Pack & Tangent Hub Installer for Mac here: http://www.tangentwave.co.uk/developer-support

API Overview

• Constants - Useful values which cannot be changed
• MODES
• Variables - Configurable values
• active
• customParameters
• Functions - API calls offered directly by the extension
• callback
• init
• start
• stop
• updateMode
• Fields - Variables which can only be accessed from an object returned by a constructor
• enabled

API Documentation

Constants

MODES

Signature	plugins.finalcutpro.tangent.manager.MODES() -> none
Type	Constant
Description	The default Modes for CommandPost in the Tangent Mapper.

Variables

active

Signature	plugins.finalcutpro.tangent.manager.active -> boolean
Type	Variable
Description	Returns true if plugin is active, otherwise false.

customParameters

Signature	plugins.finalcutpro.tangent.manager.customParameters
Type	Variable
Description	Table containing custom Tangent parameters.

Functions

callback

Signature	plugins.finalcutpro.tangent.manager.callback(id, metadata) -> none
Type	Function
Description	Tangent Manager Callback Function
Parameters	id - The ID of the Tangent Message metadata - A table of metadata
Returns	None

init

Signature	plugins.finalcutpro.tangent.manager.init(deps, env) -> none
Type	Function
Description	Initialises the Tangent Plugin
Parameters	deps - Dependencies Table env - Environment Table
Returns	None

start

Signature	plugins.finalcutpro.tangent.manager.start() -> boolean
Type	Function
Description	Starts the Tangent Plugin
Parameters	resetControlMap - When true, CommandPost will rebuild the Control Map for Tangent Mapper.
Returns	true if successfully started, otherwise false

stop

Signature	plugins.finalcutpro.tangent.manager.stop() -> boolean
Type	Function
Description	Stops the Tangent Plugin
Parameters	None
Returns	None

updateMode

Signature	plugins.finalcutpro.tangent.manager.updateMode() -> none
Type	Function
Description	Updates the Mode on the Tangent Hub
Parameters	None
Returns	None

Fields

enabled

Signature	plugins.finalcutpro.tangent.manager.enabled <cp.prop: boolean>
Type	Field
Description	Enable or disables the Tangent Manager.