CommandPost Developer Guide
CommandPost Developer Guide
Download
User Guide
Facebook Group
Introduction
Getting Started
Introduction
Installation & Setup
Lua
Lua Overview
Memory Management
Contributing
Naming Conventions
CommandPost-App
CommandPost
Control CommandPost
AppleScript
URL Handler
Command Line Tool
Plugins
Plugins Overview
Internationalisation
Translating CommandPost
Final Cut Pro
Package Contents
FCPXML
Bundled Extensions
i18n
mimetypes
moses
resty
semver
slaxml
CommandPost API
cp
Bundled Plugins API
plugins
tangent
accessibility
console
language
quit
setup
panel
manager
commandpost
favourites
functions
global
manager
action
binding
controls
group
menu
mode
named
parameter
os
display
pasteboard
sound
window
prefs
manager
virtual
widgets
volume
windowSlide
manager
panel
menuitem
webapp
commands
console
hud
language
open
streamdeck
text2speech
pasteboard
window
Hammerspoon API
hs
Powered by GitBook

action

Represents a Tangent Action

API Overview

  • Constructors - API calls which return an object, typically one that offers API methods

    • ​new​

  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Constructors

​new​

Signature

plugins.core.tangent.manager.action.new(id[, name]) -> action

Type

Constructor

Description

Creates a new Action instance.

Parameters

​

Returns

​

Methods

​controls​

Signature

plugins.core.tangent.manager.action:controls()

Type

Method

Description

Returns the controls the action belongs to.

Parameters

​

Returns

​

​is​

Signature

plugins.core.tangent.manager.action.is() -> boolean

Type

Method

Description

Is an object an action?

Parameters

​

Returns

​

​onPress​

Signature

plugins.core.tangent.manager.action:onPress(pressFn) -> self

Type

Method

Description

Sets the function that will be called when the Tangent sends a 'action on' request.

Parameters

​

Returns

​

​onRelease​

Signature

plugins.core.tangent.manager.action:onRelease(releaseFn) -> self

Type

Method

Description

Sets the function that will be called when the Tangent sends a 'action off' request.

Parameters

​

Returns

​

​parent​

Signature

`plugins.core.tangent.manager.action:parent() -> group

controls` </span>

Type

Method

​

Description

Returns the group or controls that contains this action.

​

Parameters

​

​

Returns

​

​

​xml​

Signature

plugins.core.tangent.manager.action:xml() -> cp.web.xml

Type

Method

Description

Returns the xml configuration for the Action.

Parameters

​

Returns

​

Previous
manager
Next
binding
Last updated 3 years ago
Edit on GitHub
Contents
API Overview
API Documentation
Constructors
Methods