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

API Overview

API Documentation

Constants

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.

Variables

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.

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.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

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

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

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

update

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