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

parameter

Represents a Tangent Parameter

API Overview

  • Functions - API calls offered directly by the extension

    • ​is​

  • 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

Functions

​is​

Signature

plugins.core.tangent.manager.parameter.is(other) -> boolean

Type

Function

Description

Checks if the other is a parameter instance.

Parameters

​

Returns

​

Constructors

​new​

Signature

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

Type

Constructor

Description

Creates a new Parameter instance.

Parameters

​

Returns

​

Methods

​change​

Signature

plugins.core.tangent.manager.parameter:change(amount) -> number

Type

Method

Description

Executes the change function if present, and returns the new result. If

Parameters

​

Returns

​

​controls​

Signature

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

Type

Method

Description

Returns the controls the parameter belongs to.

Parameters

​

Returns

​

​get​

Signature

plugins.core.tangent.manager.parameter:get() -> number

Type

Method

Description

Executes the get function if present, and returns the result. If

Parameters

​

Returns

​

​maxValue​

Signature

`plugins.core.tangent.manager.parameter:maxValue([value]) -> number

self` </span>

Type

Method

​

Description

Gets or sets the maximum value for the parameter.

​

Parameters

​

​

Returns

​

​

​minValue​

Signature

`plugins.core.tangent.manager.parameter:minValue([value]) -> number

self` </span>

Type

Method

​

Description

Gets or sets the minimum value for the parameter.

​

Parameters

​

​

Returns

​

​

​onChange​

Signature

plugins.core.tangent.manager.parameter:onChange(changeFn) -> self

Type

Method

Description

Sets the function that will be called when the Tangent sends a 'parameter change' request.

Parameters

​

Returns

​

​onGet​

Signature

plugins.core.tangent.manager.parameter:onGet(getFn) -> self

Type

Method

Description

Sets the function that will be called when the Tangent sends a 'parameter value' request.

Parameters

​

Returns

​

​onReset​

Signature

plugins.core.tangent.manager.parameter:onReset(resetFn) -> self

Type

Method

Description

Sets the function that will be called when the Tangent sends a 'parameter reset' request.

Parameters

​

Returns

​

​parent​

Signature

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

controls` </span>

Type

Method

​

Description

Returns the group or controls that contains this parameter.

​

Parameters

​

​

Returns

​

​

​press​

Signature

plugins.core.tangent.manager.parameter:press() -> nil

Type

Method

Description

Executes the press function, if present.

Parameters

​

Returns

​

​release​

Signature

plugins.core.tangent.manager.parameter:release() -> nil

Type

Method

Description

Executes the release function, if present.

Parameters

​

Returns

​

​reset​

Signature

plugins.core.tangent.manager.parameter:reset() -> number

Type

Method

Description

Executes the reset function if present. Returns the current value of the parameter after reset.

Parameters

​

Returns

​

​stepSize​

Signature

`plugins.core.tangent.manager.parameter:stepSize([value]) -> number

self` </span>

Type

Method

​

Description

Gets or sets the step size for the parameter.

​

Parameters

​

​

Returns

​

​

​xml​

Signature

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

Type

Method

Description

Returns the xml configuration for the Parameter.

Parameters

​

Returns

​

Previous
named
Next
os
Last updated 3 years ago
Edit on GitHub
Contents
API Overview
API Documentation
Functions
Constructors
Methods