plugins.core.midi.manager.controls.md

docs » plugins.core.midi.manager.controls

---

MIDI Manager Controls.

API Overview

• Variables - Configurable values
• controls
• Functions - API calls offered directly by the extension
• allGroups
• Methods - API calls which can only be made on an object returned by a constructor
• get
• getAll
• id
• new
• params

API Documentation

Variables

controls

Signature	plugins.core.midi.manager.controls -> table
Type	Variable
Description	Controls

Functions

allGroups

Signature	plugins.core.midi.manager.controls.allGroups() -> table
Type	Function
Description	Returns a table containing all of the control groups.
Parameters	None
Returns	Table

Methods

get

Signature	plugins.core.midi.manager.controls:get(id) -> table
Type	Method
Description	Gets a MIDI control.
Parameters	id - The unique ID for the widget you want to return.
Returns	table containing the widget

getAll

Signature	plugins.core.midi.manager.controls:getAll() -> table
Type	Method
Description	Returns all of the created controls.
Parameters	None
Returns	table containing all of the created callbacks

id

Signature	plugins.core.midi.manager.controls:id() -> string
Type	Method
Description	Returns the ID of the control.
Parameters	None
Returns	The ID of the widget as a string

new

Signature	plugins.core.midi.manager.controls:new(id, params) -> table
Type	Method
Description	Creates a new MIDI control.
Parameters	id - The unique ID for this widget. params - A table of parameters for the MIDI control.
Returns	table that has been created
Notes	The parameters table should include: group - The group as a string (i.e. "fcpx") text - The name of the control as it will appear in the Console subText - The subtext of the control as it will appear in the Console fn - The callback function. This functions should accept one parameter which contains all the MIDI callback metadata.

params

Signature	plugins.core.midi.manager.controls:params() -> function
Type	Method
Description	Returns the paramaters of the control.
Parameters	None
Returns	The paramaters of the widget