manager

Last updated last month

MIDI Manager Plugin.

Submodules

API Overview

API Documentation

Constants

Signature

plugins.core.midi.manager.DEFAULT_GROUP -> string

Type

Constant

Description

The default group.

Signature

plugins.core.midi.manager.DEFAULT_MIDI_CONTROLS -> table

Type

Constant

Description

The default MIDI controls, so that the user has a starting point.

FILE_NAME

Signature

plugins.core.midi.manager.FILE_NAME -> string

Type

Constant

Description

File name of settings file.

Signature

plugins.core.midi.manager.FOLDER_NAME -> string

Type

Constant

Description

Folder Name where settings file is contained.

Signature

plugins.core.midi.manager.MMC_COMMAND_TYPE -> table

Type

Constant

Description

MMC Command Types

Signature

plugins.core.midi.manager.MMC_TIMECODE_TYPE -> table

Type

Constant

Description

MMC Timecode Type

Signature

plugins.core.midi.manager.MTC_COMMAND_TYPE -> table

Type

Constant

Description

MTC Command Type

Signature

plugins.core.midi.manager.MTC_MESSAGE_TYPE -> table

Type

Constant

Description

MTC Message Types

Signature

plugins.core.midi.manager.MTC_TIMECODE_TYPE -> table

Type

Constant

Description

MTC Timecode Type

Variables

Signature

plugins.core.midi.manager.learningMode -> boolean

Type

Variable

Description

Whether or not the MIDI Manager is in learning mode.

maxItems

Signature

plugins.core.midi.manager.maxItems -> number

Type

Variable

Description

The maximum number of MIDI items per group.

Signature

plugins.core.midi.manager.numberOfSubGroups -> number

Type

Variable

Description

The number of Sub Groups per Touch Bar Group.

Functions

Signature

plugins.core.midi.manager.activeGroup() -> string

Type

Function

Description

Returns the active group.

Parameters

Returns

Signature

plugins.core.midi.manager.activeSubGroup() -> string

Type

Function

Description

Returns the active sub-group.

Parameters

Returns

clear

Signature

plugins.core.midi.manager.clear() -> none

Type

Function

Description

Clears the MIDI items.

Parameters

Returns

devices

Signature

plugins.core.midi.manager.devices() -> table

Type

Function

Description

Gets a table of Physical MIDI Device Names.

Parameters

Returns

Signature

plugins.core.midi.manager.forcefullyWatchMIDIDevices(devices) -> none

Type

Function

Description

Forces CommandPost to watch a table of MIDI devices.

Parameters

Returns

Signature

plugins.core.midi.manager.forceGroupChange(combinedGroupAndSubGroupID) -> none

Type

Function

Description

Loads a specific sub-group.

Parameters

Returns

getDevice

Signature

`plugins.core.midi.manager.getDevice(deviceName, virtual) -> hs.midi object

nil` </span>

Type

Function

Description

Gets a MIDI Device.

Parameters

Returns

getItem

Signature

plugins.core.midi.manager.getItem(item, button, group) -> table

Type

Function

Description

Gets a MIDI item from Preferences.

Parameters

Returns

getItems

Signature

plugins.core.midi.manager.getItems() -> tables

Type

Function

Description

Gets all the MIDI items in a table.

Parameters

Returns

Signature

plugins.core.midi.manager.gotoSubGroup() -> none

Type

Function

Description

Loads a specific sub-group.

Parameters

Returns

Signature

plugins.core.midi.manager.groupStatus(groupID, status) -> none

Type

Function

Description

Updates a group's visibility status.

Parameters

Returns

init

Signature

plugins.core.midi.manager.init(deps, env) -> none

Type

Function

Description

Initialises the MIDI Plugin

Parameters

Returns

Signature

plugins.core.midi.manager.midiCallback(object, deviceName, commandType, description, metadata) -> none

Type

Function

Description

MIDI Callback

Parameters

Returns

Signature

plugins.core.midi.manager.nextSubGroup() -> none

Type

Function

Description

Goes to the next sub-group for the active group.

Parameters

Returns

Signature

plugins.core.midi.manager.previousSubGroup() -> none

Type

Function

Description

Goes to the previous sub-group for the active group.

Parameters

Returns

Signature

plugins.core.midi.manager.processMMC(sysexData) -> string, ...

Type

Function

Description

Process MMC Data

Parameters

Returns

Notes

Signature

plugins.core.midi.manager.processMTC(mtcData) -> string, ...

Type

Function

Description

Process MTC Data

Parameters

Returns

Signature

plugins.core.midi.manager.registerCallback(id, fn) -> none

Type

Function

Description

Registers a MIDI Callback.

Parameters

Returns

Signature

plugins.core.midi.manager.registerListenMMCFunction(id, fn) -> none

Type

Function

Description

Registers a MMC Listening Function

Parameters

Returns

Signature

plugins.core.midi.manager.registerListenMTCFunction(id, fn) -> none

Type

Function

Description

Registers a MTC Listening Function

Parameters

Returns

sendMMC

Signature

plugins.core.midi.manager.sendMMC(deviceName, virtual, commandType, parameters) -> boolean

Type

Function

Description

Sends MMC Data to a MIDI Device.

Parameters

Returns

Notes

setItem

Signature

plugins.core.midi.manager.setItem(item, button, group, value) -> none

Type

Function

Description

Stores a MIDI item in Preferences.

Parameters

Returns

start

Signature

plugins.core.midi.manager.start() -> boolean

Type

Function

Description

Stops the MIDI Plugin

Parameters

Returns

update

Signature

plugins.core.midi.manager.update() -> none

Type

Function

Description

Updates the MIDI Watchers.

Parameters

Returns

Signature

plugins.core.midi.manager.updateAction(button, group, actionTitle, handlerID, action) -> none

Type

Function

Description

Updates a MIDI action.

Parameters

Returns

Signature

plugins.core.midi.manager.virtualDevices() -> table

Type

Function

Description

Gets a table of Virtual MIDI Source Names.

Parameters

Returns

Fields

buttons

Signature

plugins.core.midi.manager.buttons <cp.prop: table>

Type

Field

Description

Contains all the saved MIDI items

enabled

Signature

plugins.core.midi.manager.enabled <cp.prop: boolean>

Type

Field

Description

Enable or disable MIDI Support.

listenMMC

Signature

plugins.core.midi.manager.listenMMC <cp.prop: boolean>

Type

Field

Description

Enable or disable Listen MMC Support.

Signature

plugins.core.midi.manager.listenMMCDevice <cp.prop: string>

Type

Field

Description

MIDI Device

listenMTC

Signature

plugins.core.midi.manager.listenMTC <cp.prop: boolean>

Type

Field

Description

Enable or disable Listen MTC Support.

Signature

plugins.core.midi.manager.listenMTCDevice <cp.prop: string>

Type

Field

Description

MIDI Device

Signature

plugins.core.midi.manager.transmitMMC <cp.prop: boolean>

Type

Field

Description

Enable or disable Transmit MMC Support.

Signature

plugins.core.midi.manager.transmitMMCDevice <cp.prop: string>

Type

Field

Description

MIDI Device

Signature

plugins.core.midi.manager.transmitMTC <cp.prop: boolean>

Type

Field

Description

Enable or disable Transmit MTC Support.

Signature

plugins.core.midi.manager.transmitMTCDevice <cp.prop: string>

Type

Field

Description

MIDI Device