manager

Last updated 9 months ago

Tangent Control Surface Manager
This plugin allows CommandPost 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​
Submodules
​plugins.core.tangent.manager.action​
​plugins.core.tangent.manager.binding​
​plugins.core.tangent.manager.controls​
​plugins.core.tangent.manager.group​
​plugins.core.tangent.manager.menu​
​plugins.core.tangent.manager.mode​
​plugins.core.tangent.manager.named​
​plugins.core.tangent.manager.parameter​
API Overview
Constants - Useful values which cannot be changed
​activeMode​
​FCP_KEYPRESS_APPS_PATH​
​HIDE_FILE_PATH​
​TANGENT_MAPPER_BUNDLE_ID​
Variables - Configurable values
​connectable​
​connected​
​enabled​
​interrupted​
​requiresConnection​
​requiresDisconnection​
​tangentHubInstalled​
​tangentMapperInstalled​
​tangentMapperRunning​
Functions - API calls offered directly by the extension
​addMode​
​areMappingsInstalled​
​disableFinalCutProInTangentHub​
​getMode​
​interruptWhen​
​launchTangentMapper​
​update​
​updateControls​
​writeControlsXML​
API Documentation
Constants
​activeMode​
Signature
plugins.core.tangent.manager.activeMode <cp.prop: mode>
Type
Constant
Description
Represents the currently active mode.
​FCP_KEYPRESS_APPS_PATH​
Signature
plugins.core.tangent.manager.FCP_KEYPRESS_APPS_PATH -> string
Type
Constant
Description
Final Cut Pro Keypress Apps Path for Tangent Mapper.
​HIDE_FILE_PATH​
Signature
plugins.core.tangent.manager.HIDE_FILE_PATH -> string
Type
Constant
Description
Tangent Mapper Hide File Path.
​TANGENT_MAPPER_BUNDLE_ID​
Signature
plugins.core.tangent.manager.TANGENT_MAPPER_BUNDLE_ID -> string
Type
Constant
Description
Tangent Mapper Bundle ID.
Variables
​connectable​
Signature
plugins.core.tangent.manager.connectable <cp.prop: boolean; read-only>
Type
Variable
Description
Is the Tangent Enabled, Not Interrupted, and the Tangent Hub Installed?
​connected​
Signature
plugins.core.tangent.manager.connected <cp.prop: boolean>
Type
Variable
Description
A cp.prop that tracks the connection status to the Tangent Hub.
​enabled​
Signature
plugins.core.tangent.manager.enabled <cp.prop: boolean>
Type
Variable
Description
Enable or disables the Tangent Manager.
​interrupted​
Signature
plugins.core.tangent.manager.interrupted <cp.prop: boolean; read-only>
Type
Variable
Description
If this property is true it will temporarily interrupt the Tangent connection, if it is enabled.
​requiresConnection​
Signature
plugins.core.tangent.manager.requiresConnection <cp.prop: boolean; read-only>
Type
Variable
Description
Is true when the Tangent Manager is both enabled but not connected.
​requiresDisconnection​
Signature
plugins.core.tangent.manager.requiresDisconnection <cp.prop: boolean; read-only>
Type
Variable
Description
Is true when the Tangent Manager is both not enabled but is connected.
​tangentHubInstalled​
Signature
plugins.core.tangent.manager.tangentHubInstalled <cp.prop: boolean>
Type
Variable
Description
Is Tangent Hub Installed?
​tangentMapperInstalled​
Signature
plugins.core.tangent.manager.tangentMapperInstalled <cp.prop: boolean>
Type
Variable
Description
Is Tangent Mapper Installed?
​tangentMapperRunning​
Signature
plugins.core.tangent.manager.tangentMapperRunning <cp.prop: boolean>
Type
Variable
Description
Is Tangent Mapper Running?
Functions
​addMode​
Signature
plugins.core.tangent.manager.addMode(id, name) -> plugins.core.tangent.manager.mode
Type
Function
Description
Adds a new mode with the specified details and returns it.
Parameters
​
Returns
​
​areMappingsInstalled​
Signature
plugins.core.tangent.manager.areMappingsInstalled() -> boolean
Type
Function
Description
Are mapping files installed?
Parameters
​
Returns
​
​disableFinalCutProInTangentHub​
Signature
plugins.core.tangent.manager.disableFinalCutProInTangentHub() -> none
Type
Function
Description
Disables the Final Cut Pro preset in the Tangent Hub Application.
Parameters
​
Returns
​
​getMode​
Signature
plugins.core.tangent.manager.getMode(id) -> plugins.core.tangent.manager.mode
Type
Function
Description
Returns the mode with the specified ID, or nil.
Parameters
​
Returns
​
​interruptWhen​
Signature
plugins.core.tangent.manager.interruptWhen(aProp) -> nil
Type
Function
Description
Adds a cp.prop that will cause an interruption to the Tangent connection when it is true.
Parameters
​
Returns
​
​launchTangentMapper​
Signature
plugins.core.tangent.manager.launchTangentMapper() -> none
Type
Function
Description
Launches the Tangent Mapper.
Parameters
​
Returns
​
​update​
Signature
plugins.core.tangent.manager.update() -> none
Type
Function
Description
Updates the Tangent GUIs.
Parameters
​
Returns
​
​updateControls​
Signature
plugins.core.tangent.manager.updateControls() -> none
Type
Function
Description
Update Controls.
Parameters
​
Returns
​
​writeControlsXML​
Signature
plugins.core.tangent.manager.writeControlsXML() -> boolean, string
Type
Function
Description
Writes the Tangent controls.xml File to the User's Application Support folder.
Parameters
​
Returns
​

global

action

Signature	`plugins.core.tangent.manager.activeMode <cp.prop: mode>`
Type	Constant
Description	Represents the currently active `mode`.

Signature	`plugins.core.tangent.manager.FCP_KEYPRESS_APPS_PATH -> string`
Type	Constant
Description	Final Cut Pro Keypress Apps Path for Tangent Mapper.

Signature	`plugins.core.tangent.manager.HIDE_FILE_PATH -> string`
Type	Constant
Description	Tangent Mapper Hide File Path.

Signature	`plugins.core.tangent.manager.TANGENT_MAPPER_BUNDLE_ID -> string`
Type	Constant
Description	Tangent Mapper Bundle ID.

Signature	`plugins.core.tangent.manager.connectable <cp.prop: boolean; read-only>`
Type	Variable
Description	Is the Tangent Enabled, Not Interrupted, and the Tangent Hub Installed?

Signature	`plugins.core.tangent.manager.connected <cp.prop: boolean>`
Type	Variable
Description	A `cp.prop` that tracks the connection status to the Tangent Hub.

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

Signature	`plugins.core.tangent.manager.interrupted <cp.prop: boolean; read-only>`
Type	Variable
Description	If this property is `true` it will temporarily interrupt the Tangent connection, if it is enabled.

Signature	`plugins.core.tangent.manager.requiresConnection <cp.prop: boolean; read-only>`
Type	Variable
Description	Is `true` when the Tangent Manager is both `enabled` but not `connected`.

Signature	`plugins.core.tangent.manager.requiresDisconnection <cp.prop: boolean; read-only>`
Type	Variable
Description	Is `true` when the Tangent Manager is both not `enabled` but is `connected`.

Signature	`plugins.core.tangent.manager.tangentHubInstalled <cp.prop: boolean>`
Type	Variable
Description	Is Tangent Hub Installed?

Signature	`plugins.core.tangent.manager.tangentMapperInstalled <cp.prop: boolean>`
Type	Variable
Description	Is Tangent Mapper Installed?

Signature	`plugins.core.tangent.manager.addMode(id, name) -> plugins.core.tangent.manager.mode`
Type	Function
Description	Adds a new `mode` with the specified details and returns it.
Parameters
Returns

Signature	`plugins.core.tangent.manager.areMappingsInstalled() -> boolean`
Type	Function
Description	Are mapping files installed?
Parameters
Returns

Signature	`plugins.core.tangent.manager.disableFinalCutProInTangentHub() -> none`
Type	Function
Description	Disables the Final Cut Pro preset in the Tangent Hub Application.
Parameters
Returns

Signature	`plugins.core.tangent.manager.getMode(id) -> plugins.core.tangent.manager.mode`
Type	Function
Description	Returns the `mode` with the specified ID, or `nil`.
Parameters
Returns

Signature	`plugins.core.tangent.manager.interruptWhen(aProp) -> nil`
Type	Function
Description	Adds a `cp.prop` that will cause an interruption to the Tangent connection when it is `true`.
Parameters
Returns

Signature	`plugins.core.tangent.manager.launchTangentMapper() -> none`
Type	Function
Description	Launches the Tangent Mapper.
Parameters
Returns

Signature	`plugins.core.tangent.manager.update() -> none`
Type	Function
Description	Updates the Tangent GUIs.
Parameters
Returns

Signature	`plugins.core.tangent.manager.updateControls() -> none`
Type	Function
Description	Update Controls.
Parameters
Returns

Signature	`plugins.core.tangent.manager.writeControlsXML() -> boolean, string`
Type	Function
Description	Writes the Tangent controls.xml File to the User's Application Support folder.
Parameters
Returns

manager

Submodules

API Overview

API Documentation

Constants

​activeMode​

​FCP_KEYPRESS_APPS_PATH​

​HIDE_FILE_PATH​

​TANGENT_MAPPER_BUNDLE_ID​

Variables

​connectable​

​connected​

​enabled​

​interrupted​

​requiresConnection​

​requiresDisconnection​

​tangentHubInstalled​

​tangentMapperInstalled​

​tangentMapperRunning​

Functions

​addMode​

​areMappingsInstalled​

​disableFinalCutProInTangentHub​

​getMode​

​interruptWhen​

​launchTangentMapper​

​update​

​updateControls​

​writeControlsXML​

activeMode

FCP_KEYPRESS_APPS_PATH

HIDE_FILE_PATH

TANGENT_MAPPER_BUNDLE_ID

connectable

connected

enabled

interrupted

requiresConnection

requiresDisconnection

tangentHubInstalled

tangentMapperInstalled

tangentMapperRunning

addMode

areMappingsInstalled

disableFinalCutProInTangentHub

getMode

interruptWhen

launchTangentMapper

update

updateControls

writeControlsXML