Skip to main content

API Reference

MidiRemoteAPI​

Entry point to the MIDI Remote API.

Properties

Methods

  • makeDeviceDriver(vendorName : string, deviceName : string, createdBy : string) : DeviceDriver

Example

//-----------------------------------------------------------------------------
// 1. DRIVER SETUP - create driver object, midi ports and detection information
//-----------------------------------------------------------------------------

// get the api's entry point
var midiremote_api = require('midiremote_api_v1')

// create the device driver main object
var deviceDriver = midiremote_api.makeDeviceDriver('ExampleCompany', 'SimpleDevice', 'Steinberg Media Technologies GmbH')

HostDefaults​

Referenced by: MidiRemoteAPI

Methods

  • getAppName() : string
  • getNumberOfInsertEffectSlots() : number
  • getNumberOfStripEffectSlots() : number
  • getNumberOfSendSlots() : number
  • getNumberOfQuickControls() : number
  • getMaxControlRoomTalkbackChannels() : number
  • getMaxControlRoomExternalInputChannels() : number
  • getMaxControlRoomCueChannels() : number
  • getMaxControlRoomPhonesChannels() : number
  • getMaxControlRoomMonitorChannels() : number

DeviceDriver​

Represents specific hardware device.

Referenced by: MidiRemoteAPI

Properties

Methods

Example

//-----------------------------------------------------------------------------
// 1. DRIVER SETUP - create driver object, midi ports and detection information
//-----------------------------------------------------------------------------

// get the api's entry point
var midiremote_api = require('midiremote_api_v1')

// create the device driver main object
var deviceDriver = midiremote_api.makeDeviceDriver('ExampleCompany', 'SimpleDevice', 'Steinberg Media Technologies GmbH')

// create objects representing the hardware's MIDI ports
var midiInput = deviceDriver.mPorts.makeMidiInput()

Ports​

Device driver sub section for creating midi port objects.

Referenced by: DeviceDriver

Methods

Example

var midiInput = deviceDriver.mPorts.makeMidiInput()
var midiOutput = deviceDriver.mPorts.makeMidiOutput()

DeviceMidiInput​

Device driver MIDI input port.

Referenced by: Ports, SurfaceValueMidiBinding, DetectionPortPair, DetectionSingleInput

Properties

Example

var midiInput = deviceDriver.mPorts.makeMidiInput()

DeviceMidiOutput​

Device driver MIDI output port.

Referenced by: Ports, SurfaceValueMidiBinding, DetectionPortPair

Methods

Example

var midiOutput = deviceDriver.mPorts.makeMidiOutput()

Surface​

Emulates hardware surface elements.

Referenced by: DeviceDriver

Methods

  • makePushEncoder(x : number, y : number, w : number, h : number) : PushEncoder
  • makeKnob(x : number, y : number, w : number, h : number) : Knob
  • makeFader(x : number, y : number, w : number, h : number) : Fader
  • makeButton(x : number, y : number, w : number, h : number) : Button
  • makeModWheel(x : number, y : number, w : number, h : number) : ModWheel
  • makePitchBend(x : number, y : number, w : number, h : number) : PitchBend
  • makeTriggerPad(x : number, y : number, w : number, h : number) : TriggerPad
  • makePadXY(x : number, y : number, w : number, h : number) : PadXY
  • makeJoyStickXY(x : number, y : number, w : number, h : number) : JoyStickXY
  • makeLamp(x : number, y : number, w : number, h : number) : Lamp
  • makeBlindPanel(x : number, y : number, w : number, h : number) : BlindPanel
  • makePianoKeys(x : number, y : number, w : number, h : number, firstKeyIndex : number, lastKeyIndex : number) : PianoKeys
  • makeLabelField(x : number, y : number, w : number, h : number) : SurfaceLabelField
  • makeControlLayerZone(name : string) : ControlLayerZone
  • makeCustomValueVariable(name : string) : SurfaceCustomValueVariable

Example

//-----------------------------------------------------------------------------
// 2. SURFACE LAYOUT - create control elements and midi bindings
//-----------------------------------------------------------------------------

// create control element representing your hardware's surface
var knob1 = deviceDriver.mSurface.makeKnob(0, 0, 1, 1.5)
var knob2 = deviceDriver.mSurface.makeKnob(1, 0, 1, 1.5)
var knob3 = deviceDriver.mSurface.makeKnob(2, 0, 1, 1.5)
var knob4 = deviceDriver.mSurface.makeKnob(3, 0, 1, 1.5)

// bind midi ports to surface elements

(abstract) SurfaceElement​

Inherited by: PushEncoder, Knob, Fader, Button, ModWheel, PitchBend, TriggerPad, PadXY, JoyStickXY, Lamp, BlindPanel, PianoKeys

Referenced by: Surface

PushEncoder​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

Knob​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

Fader​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

  • setTypeVertical() : this
  • setTypeHorizontal() : this
  • setControlLayer(controlLayer : ControlLayer) : this

Button​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

  • setTypePush() : this
  • setTypeToggle() : this
  • setShapeRectangle() : this
  • setShapeCircle() : this
  • setControlLayer(controlLayer : ControlLayer) : this

ModWheel​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

PitchBend​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

TriggerPad​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

PadXY​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

JoyStickXY​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

Lamp​

Inherits From: SurfaceElement

Referenced by: Surface

Properties

Methods

  • setShapeRectangle() : this
  • setShapeCircle() : this

BlindPanel​

Inherits From: SurfaceElement

Referenced by: Surface

Methods

  • setShapeRectangle() : this
  • setShapeCircle() : this

PianoKeys​

Inherits From: SurfaceElement

Referenced by: Surface

SurfaceLabelField​

Referenced by: Surface

Methods

ControlLayerZone​

Referenced by: Surface

Methods

ControlLayer​

Referenced by: ControlLayerZone, PushEncoder, Knob, Fader, Button, ModWheel, PitchBend, TriggerPad, PadXY, JoyStickXY

(abstract) SurfaceValue​

Represents a continuous value state of a SurfaceElement.

Inherited by: SurfaceElementValue, SurfaceCustomValueVariable

Referenced by: ValueBinding, CommandBinding, ActionBinding

SurfaceElementValue​

Represents a continuous value state of a SurfaceElement.

Inherits From: SurfaceValue

Referenced by: PushEncoder, Knob, Fader, Button, ModWheel, PitchBend, TriggerPad, PadXY, JoyStickXY, Lamp, ValueBinding, CommandBinding, ActionBinding

Properties

  • mMidiBinding : SurfaceValueMidiBinding
  • mOnProcessValueChange : function (activeDevice : ActiveDevice, value : number, diff : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, r : number, g : number, b : number, a : number, isActive : boolean)
  • mTouchState : SurfaceValueTouchState

Methods

SurfaceCustomValueVariable​

Represents a continuous value state of a SurfaceElement.

Inherits From: SurfaceValue

Referenced by: Surface, ValueBinding, CommandBinding, ActionBinding

Properties

  • mMidiBinding : SurfaceValueMidiBinding
  • mOnProcessValueChange : function (activeDevice : ActiveDevice, value : number, diff : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, r : number, g : number, b : number, a : number, isActive : boolean)
  • mTouchState : SurfaceValueTouchState

Methods

SurfaceValueMidiBinding​

Referenced by: SurfaceElementValue, SurfaceCustomValueVariable

Methods

MidiBindingValueRange7Bit​

Referenced by: MidiBindingToNote, MidiBindingToControlChange, MidiBindingToChannelPressure

MidiBindingValueRange14Bit​

Referenced by: MidiBindingToControlChange14Bit, MidiBindingToControlChange14BitNRPN, MidiBindingToPitchBend

(abstract) MidiChannelBinding​

Inherited by: MidiBindingToNote, MidiBindingToControlChange, MidiBindingToControlChange14Bit, MidiBindingToControlChange14BitNRPN, MidiBindingToPitchBend, MidiBindingToChannelPressure

Referenced by: SurfaceValueMidiBinding

MidiBindingToNote​

Inherits From: MidiChannelBinding

Referenced by: SurfaceValueMidiBinding

Methods

  • setValueRange(min : number, max : number) : this

MidiBindingToControlChange​

Inherits From: MidiChannelBinding

Referenced by: SurfaceValueMidiBinding

Methods

  • setValueRange(min : number, max : number) : this
  • setTypeAbsolute() : this
  • setTypeRelativeSignedBit() : this
  • setTypeRelativeBinaryOffset() : this
  • setTypeRelativeTwosComplement() : this

MidiBindingToControlChange14Bit​

Inherits From: MidiChannelBinding

Inherited by: MidiBindingToControlChange14BitNRPN

Referenced by: SurfaceValueMidiBinding

Methods

  • setValueRange(min : number, max : number) : this
  • setTypeAbsolute() : this
  • setTypeRelativeSignedBit() : this
  • setTypeRelativeBinaryOffset() : this
  • setTypeRelativeTwosComplement() : this

MidiBindingToControlChange14BitNRPN​

Inherits From: MidiChannelBinding

Referenced by: SurfaceValueMidiBinding

Methods

  • setValueRange(min : number, max : number) : this
  • setTypeAbsolute() : this
  • setTypeRelativeSignedBit() : this
  • setTypeRelativeBinaryOffset() : this
  • setTypeRelativeTwosComplement() : this

MidiBindingToPitchBend​

Inherits From: MidiChannelBinding

Referenced by: SurfaceValueMidiBinding

Properties

MidiBindingToChannelPressure​

Inherits From: MidiChannelBinding

Referenced by: SurfaceValueMidiBinding

Properties

SurfaceValueTouchState​

Referenced by: SurfaceElementValue, SurfaceCustomValueVariable

Methods

(abstract) Mapping​

Inherited by: FactoryMapping

FactoryMapping​

Inherits From: Mapping

Referenced by: DeviceDriver

Methods

(abstract) Page​

Inherited by: FactoryMappingPage

FactoryMappingPage​

Inherits From: Page

Referenced by: FactoryMapping

Properties

Methods

HostAccess​

Provides objects and methods to bind the defined Surface to host functions.

Referenced by: FactoryMappingPage

Properties

Example

//-----------------------------------------------------------------------------
// 3. HOST MAPPING - create mapping pages and host bindings
//-----------------------------------------------------------------------------

// create at least one mapping page
var page = deviceDriver.mMapping.makePage('Example Mixer Page')

// create host accessing objects
var hostSelectedTrackChannel = page.mHostAccess.mTrackSelection.mMixerChannel


// bind surface elements to host accessing object values
page.makeValueBinding(knob1.mSurfaceValue, hostSelectedTrackChannel.mValue.mVolume)
page.makeValueBinding(knob2.mSurfaceValue, hostSelectedTrackChannel.mSends.getByIndex(0).mLevel)
page.makeValueBinding(knob3.mSurfaceValue, hostSelectedTrackChannel.mSends.getByIndex(1).mLevel)
page.makeValueBinding(knob4.mSurfaceValue, hostSelectedTrackChannel.mSends.getByIndex(2).mLevel)

(abstract) HostObject​

Inherited by: HostObjectUndefined, Transport, QuickControls, FocusedQuickControls, HostPluginParameterBankZone, HostStripEffectSlotFolder, SendSlotFolder, ControlRoomCueSendSlotFolder, MixerBankChannel, SelectedTrackChannel, HostMouseCursor, HostControlRoomChannelMain, HostControlRoomChannelPhonesByIndex, HostControlRoomChannelCueByIndex, HostControlRoomChannelExternalInputByIndex, HostControlRoomChannelTalkbackByIndex, HostControlRoomChannelMonitorByIndex, HostControlRoom, MixConsole, TransportValues, PreFilter, ChannelEQBand, ChannelEQ, HostInstrumentPluginSlot, HostStripEffectSlotGate, HostStripEffectSlotCompressor, HostStripEffectSlotLimiter, HostStripEffectSlotSaturator, HostStripEffectSlotTools, HostInsertEffectViewer, HostInsertAndStripEffects, SendSlot, ControlRoomCueSendSlot, MixerChannelValues, MixerBankZone, TrackSelection

HostObjectUndefined​

Inherits From: HostObject

Referenced by: FactoryMappingPage

Properties

  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, title : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

Transport​

Access transport functions.

Inherits From: HostObject

Referenced by: HostAccess

Properties

QuickControls​

Inherits From: HostObject

Inherited by: FocusedQuickControls

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, title : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

FocusedQuickControls​

Inherits From: HostObject

Referenced by: HostAccess, MixerBankChannel, SelectedTrackChannel

Properties

Methods

HostPluginParameterBankZone​

Inherits From: HostObject

Referenced by: HostInstrumentPluginSlot, HostStripEffectSlotGate, HostStripEffectSlotCompressor, HostStripEffectSlotLimiter, HostStripEffectSlotSaturator, HostStripEffectSlotTools, HostInsertEffectViewer

Properties

Methods

HostStripEffectSlotFolder​

Inherits From: HostObject

Referenced by: HostInsertAndStripEffects

Properties

SendSlotFolder​

Inherits From: HostObject

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, title : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

  • getByIndex(index : number) : SendSlot
  • getSize() : number

ControlRoomCueSendSlotFolder​

Inherits From: HostObject

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

Methods

MixerBankChannel​

Inherits From: HostObject

Referenced by: MixerBankZone

Properties

SelectedTrackChannel​

Inherits From: HostObject

Referenced by: TrackSelection

Properties

HostMouseCursor​

Inherits From: HostObject

Referenced by: HostAccess

Properties

HostControlRoomChannelMain​

Inherits From: HostObject

Referenced by: HostControlRoom

Properties

Methods

HostControlRoomChannelPhonesByIndex​

Inherits From: HostObject

Referenced by: HostControlRoom

Properties

Methods

HostControlRoomChannelCueByIndex​

Inherits From: HostObject

Referenced by: HostControlRoom

Properties

HostControlRoomChannelExternalInputByIndex​

Inherits From: HostObject

Referenced by: HostControlRoom

Properties

HostControlRoomChannelTalkbackByIndex​

Inherits From: HostObject

Referenced by: HostControlRoom

Properties

HostControlRoomChannelMonitorByIndex​

Inherits From: HostObject

Referenced by: HostControlRoom

Properties

HostControlRoom​

Inherits From: HostObject

Referenced by: HostAccess

Properties

Methods

MixConsole​

Inherits From: HostObject

Referenced by: HostAccess

Properties

  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, title : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

TransportValues​

Inherits From: HostObject

Referenced by: Transport

Properties

PreFilter​

Inherits From: HostObject

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

ChannelEQBand​

Inherits From: HostObject

Referenced by: ChannelEQ

Properties

ChannelEQ​

Inherits From: HostObject

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

HostInstrumentPluginSlot​

Inherits From: HostObject

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

HostStripEffectSlotGate​

Inherits From: HostObject

Referenced by: HostStripEffectSlotFolder

Properties

HostStripEffectSlotCompressor​

Inherits From: HostObject

Referenced by: HostStripEffectSlotFolder

Properties

HostStripEffectSlotLimiter​

Inherits From: HostObject

Referenced by: HostStripEffectSlotFolder

Properties

HostStripEffectSlotSaturator​

Inherits From: HostObject

Referenced by: HostStripEffectSlotFolder

Properties

HostStripEffectSlotTools​

Inherits From: HostObject

Referenced by: HostStripEffectSlotFolder

Properties

HostInsertEffectViewer​

Inherits From: HostObject

Referenced by: HostInsertAndStripEffects

Properties

Methods

  • includeEmptySlotsOnly() : this
  • excludeEmptySlots() : this
  • followPluginWindowInFocus() : this

HostInsertAndStripEffects​

Inherits From: HostObject

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

Methods

SendSlot​

Inherits From: HostObject

Referenced by: SendSlotFolder

Properties

ControlRoomCueSendSlot​

Inherits From: HostObject

Referenced by: ControlRoomCueSendSlotFolder

Properties

MixerChannelValues​

Inherits From: HostObject

Referenced by: MixerBankChannel, SelectedTrackChannel

Properties

MixerBankZone​

Inherits From: HostObject

Referenced by: MixConsole

Properties

Methods

  • includeAudioChannels() : this
  • includeInstrumentChannels() : this
  • includeSamplerChannels() : this
  • includeMIDIChannels() : this
  • includeFXChannels() : this
  • includeGroupChannels() : this
  • includeVCAChannels() : this
  • includeInputChannels() : this
  • includeOutputChannels() : this
  • includeWindowZoneLeftChannels() : this
  • includeWindowZoneRightChannels() : this
  • excludeAudioChannels() : this
  • excludeInstrumentChannels() : this
  • excludeSamplerChannels() : this
  • excludeMIDIChannels() : this
  • excludeFXChannels() : this
  • excludeGroupChannels() : this
  • excludeVCAChannels() : this
  • excludeInputChannels() : this
  • excludeOutputChannels() : this
  • excludeWindowZoneLeftChannels() : this
  • excludeWindowZoneRightChannels() : this
  • setFollowVisibility(followVisibility : boolean) : this
  • makeMixerBankChannel() : MixerBankChannel

TrackSelection​

Inherits From: HostObject

Referenced by: HostAccess

Properties

(abstract) HostValue​

Represents a continuous value state of a HostObject.

Inherited by: HostValueUndefined, StartValue, StopValue, RecordValue, RewindValue, ForwardValue, CycleActiveValue, MetronomeActiveValue, MetronomeClickLevel, VolumeValue, PanValue, MuteValue, SoloValue, MonitorEnableValue, RecordEnableValue, EditorOpenValue, InstrumentOpenValue, SelectedValue, AutomationReadValue, AutomationWriteValue, VUMeterValue, VUMeterMaxValue, VUMeterClipValue, VUMeterPeakValue, SendOn, SendPrePost, SendLevel, ControlRoomCueSendOnValue, ControlRoomCueSendPrePostValue, ControlRoomCueSendLevelValue, ControlRoomCueSendPanValue, ControlRoomCueSendFolderBypassValue, PluginOnValue, PluginBypassValue, PluginEditValue, PreFilterBypassValue, PreFilterGainValue, PreFilterPhaseSwitchValue, PreFilterHighCutFrequencyValue, PreFilterHighCutOnValue, PreFilterHighCutSlopeValue, PreFilterLowCutFrequencyValue, PreFilterLowCutOnValue, PreFilterLowCutSlopeValue, EQBandGainValue, EQBandFrequencyValue, EQBandQualityValue, EQBandOnValue, EQBandFilterTypeValue, QuickControlValue, FocusedQuickControlsLockedStateValue, HostPluginParameterBankValue, HostValueAtMouseCursor, HostValueAtMouseCursorLockedState, HostControlRoomValue, HostControlRoomSelectSourceCueValueByIndex, HostControlRoomSelectTargetMonitorValueByIndex, HostControlRoomSelectSourceExternalInputValueByIndex

Referenced by: ValueBinding

HostValueUndefined​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostObjectUndefined, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

StartValue​

Indicates if transport has been started.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

StopValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

RecordValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

RewindValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

ForwardValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

CycleActiveValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

MetronomeActiveValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

MetronomeClickLevel​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: TransportValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

VolumeValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PanValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

MuteValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

SoloValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

MonitorEnableValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

RecordEnableValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

EditorOpenValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

InstrumentOpenValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

SelectedValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

AutomationReadValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostInstrumentPluginSlot, HostStripEffectSlotGate, HostStripEffectSlotCompressor, HostStripEffectSlotLimiter, HostStripEffectSlotSaturator, HostStripEffectSlotTools, HostInsertEffectViewer, MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

AutomationWriteValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostInstrumentPluginSlot, HostStripEffectSlotGate, HostStripEffectSlotCompressor, HostStripEffectSlotLimiter, HostStripEffectSlotSaturator, HostStripEffectSlotTools, HostInsertEffectViewer, MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

VUMeterValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

VUMeterMaxValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

VUMeterClipValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

VUMeterPeakValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: MixerChannelValues, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

SendOn​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: SendSlot, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

SendPrePost​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: SendSlot, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

SendLevel​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: SendSlot, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

ControlRoomCueSendOnValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ControlRoomCueSendSlot, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

ControlRoomCueSendPrePostValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ControlRoomCueSendSlot, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

ControlRoomCueSendLevelValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ControlRoomCueSendSlot, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

ControlRoomCueSendPanValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ControlRoomCueSendSlot, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

ControlRoomCueSendFolderBypassValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ControlRoomCueSendSlotFolder, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PluginOnValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostInstrumentPluginSlot, HostStripEffectSlotGate, HostStripEffectSlotCompressor, HostStripEffectSlotLimiter, HostStripEffectSlotSaturator, HostStripEffectSlotTools, HostInsertEffectViewer, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PluginBypassValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostInstrumentPluginSlot, HostStripEffectSlotGate, HostStripEffectSlotCompressor, HostStripEffectSlotLimiter, HostStripEffectSlotSaturator, HostStripEffectSlotTools, HostInsertEffectViewer, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PluginEditValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostInstrumentPluginSlot, HostStripEffectSlotGate, HostStripEffectSlotCompressor, HostStripEffectSlotLimiter, HostStripEffectSlotSaturator, HostStripEffectSlotTools, HostInsertEffectViewer, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterBypassValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterGainValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterPhaseSwitchValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterHighCutFrequencyValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterHighCutOnValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterHighCutSlopeValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterLowCutFrequencyValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterLowCutOnValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

PreFilterLowCutSlopeValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: PreFilter, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

EQBandGainValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ChannelEQBand, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

EQBandFrequencyValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ChannelEQBand, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

EQBandQualityValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ChannelEQBand, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

EQBandOnValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ChannelEQBand, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

EQBandFilterTypeValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: ChannelEQBand, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

QuickControlValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: QuickControls, FocusedQuickControls, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

FocusedQuickControlsLockedStateValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: FocusedQuickControls, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

HostPluginParameterBankValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostPluginParameterBankZone, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

HostValueAtMouseCursor​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostMouseCursor, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

HostValueAtMouseCursorLockedState​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostMouseCursor, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

HostControlRoomValue​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostControlRoomChannelMain, HostControlRoomChannelPhonesByIndex, HostControlRoomChannelCueByIndex, HostControlRoomChannelExternalInputByIndex, HostControlRoomChannelTalkbackByIndex, HostControlRoomChannelMonitorByIndex, HostControlRoom, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

HostControlRoomSelectSourceCueValueByIndex​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostControlRoomChannelMain, HostControlRoomChannelPhonesByIndex, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

HostControlRoomSelectTargetMonitorValueByIndex​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostControlRoom, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

HostControlRoomSelectSourceExternalInputValueByIndex​

Represents a continuous value state of a HostObject.

Inherits From: HostValue

Referenced by: HostControlRoom, ValueBinding

Properties

  • mOnProcessValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : number)
  • mOnDisplayValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, value : string, units : string)
  • mOnTitleChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, objectTitle : string, valueTitle : string)
  • mOnColorChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, r : number, g : number, b : number, a : number, isActive : boolean)

Methods

(abstract) TransportTimeDisplayDetails​

Inherited by: TransportTimeDisplayDetailsPrimary, TransportTimeDisplayDetailsSecondary

TransportTimeDisplayDetailsPrimary​

Inherits From: TransportTimeDisplayDetails

Referenced by: TransportTimeDisplay

Properties

TransportTimeDisplayDetailsSecondary​

Inherits From: TransportTimeDisplayDetails

Referenced by: TransportTimeDisplay

Properties

TransportTimeDisplay​

Referenced by: Transport

Properties

Methods

TransportTime​

Referenced by: TransportTimeDisplayDetailsPrimary, TransportTimeDisplayDetailsSecondary

Properties

Methods

HostPluginParameterBankZoneActions​

Referenced by: HostPluginParameterBankZone

Properties

(abstract) HostInsertEffectFilter​

Inherited by: HostInsertEffectFilterIncludeEmptySlotsOnly, HostInsertEffectFilterExcludeEmptySlots, HostInsertEffectFilterFollowPluginWindowInFocus

Referenced by: HostInsertEffectViewer

HostInsertEffectFilterIncludeEmptySlotsOnly​

Inherits From: HostInsertEffectFilter

Referenced by: HostInsertEffectViewer

HostInsertEffectFilterExcludeEmptySlots​

Inherits From: HostInsertEffectFilter

Referenced by: HostInsertEffectViewer

HostInsertEffectFilterFollowPluginWindowInFocus​

Inherits From: HostInsertEffectFilter

Referenced by: HostInsertEffectViewer

HostInsertEffectViewerActions​

Referenced by: HostInsertEffectViewer

Properties

MixerBankZoneActions​

Referenced by: MixerBankZone

Properties

TrackSelectionActions​

Referenced by: TrackSelection

Properties

(abstract) HostBinding​

Inherited by: ValueBinding, CommandBinding, ActionBinding

Referenced by: FactoryMappingPage

ValueBinding​

Inherits From: HostBinding

Referenced by: FactoryMappingPage

Properties

  • mOnValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, currValue : number, valueDiff : number)

Methods

  • setTypeDefault() : this
  • setTypeToggle() : this
  • setValueTakeOverModeJump() : this
  • setValueTakeOverModePickup() : this
  • setValueTakeOverModeScaled() : this
  • setSubPage(subPage : SubPage) : this
  • filterByValue(filterValue : number) : this
  • filterByValueRange(from : number, to : number) : this
  • mapToValue(mapValue : number) : this
  • mapToValueRange(from : number, to : number) : this

CommandBinding​

Inherits From: HostBinding

Referenced by: FactoryMappingPage

Properties

  • mOnValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, currValue : number, valueDiff : number)

Methods

  • makeRepeating(delaySeconds : number, rateHz : number) : Repeating
  • setSubPage(subPage : SubPage) : this
  • filterByValue(filterValue : number) : this
  • filterByValueRange(from : number, to : number) : this
  • mapToValue(mapValue : number) : this
  • mapToValueRange(from : number, to : number) : this

ActionBinding​

Inherits From: HostBinding

Referenced by: FactoryMappingPage

Properties

  • mOnValueChange : function (activeDevice : ActiveDevice, activeMapping : ActiveMapping, currValue : number, valueDiff : number)

Methods

  • makeRepeating(delaySeconds : number, rateHz : number) : Repeating
  • setSubPage(subPage : SubPage) : this
  • filterByValue(filterValue : number) : this
  • filterByValueRange(from : number, to : number) : this
  • mapToValue(mapValue : number) : this
  • mapToValueRange(from : number, to : number) : this

SubPageArea​

Referenced by: FactoryMappingPage

Properties

Methods

  • makeSubPage(name : string) : SubPage

SubPageAreaActions​

Referenced by: SubPageArea

Properties

SubPage​

Referenced by: SubPageArea, ValueBinding, CommandBinding, ActionBinding

Properties

SubPageActions​

Referenced by: SubPage

Properties

Repeating​

Referenced by: CommandBinding, ActionBinding

MappingPageActions​

Referenced by: FactoryMappingPage

Properties

DeviceDetectionUnit​

Define device auto detection.

Referenced by: DeviceDriver

Methods

Example

// create objects representing the hardware's MIDI ports
var midiInput = deviceDriver.mPorts.makeMidiInput()
var midiOutput = deviceDriver.mPorts.makeMidiOutput()

// define all possible namings the devices MIDI ports could have
// NOTE: Windows and MacOS handle port naming differently
deviceDriver.makeDetectionUnit().detectPortPair(midiInput, midiOutput)
    .expectInputNameEquals('SimpleDevice IN')
    .expectOutputNameEquals('SimpleDevice OUT')
    
deviceDriver.makeDetectionUnit().detectPortPair(midiInput, midiOutput)
    .expectInputNameEquals('SimpleDevice (MIDI IN)')
    .expectOutputNameEquals('SimpleDevice (MIDI OUT)')

(abstract) DetectionEntry​

Inherited by: DetectionPortPair, DetectionSingleInput

Referenced by: DeviceDetectionUnit

DetectionPortPair​

Define port naming pair.

Inherits From: DetectionEntry

Referenced by: DeviceDetectionUnit

Methods

  • expectInputNameContains(filterValue : string) : this
  • expectInputNameEquals(filterValue : string) : this
  • expectInputNameStartsWith(filterValue : string) : this
  • expectInputNameEndsWith(filterValue : string) : this
  • expectOutputNameContains(filterValue : string) : this
  • expectOutputNameEquals(filterValue : string) : this
  • expectOutputNameStartsWith(filterValue : string) : this
  • expectOutputNameEndsWith(filterValue : string) : this
  • expectSysexIdentityResponse(manufacturerID : string, deviceFamily : string, modelNumber : string) : this

Example

deviceDriver.makeDetectionUnit().detectPortPair(midiInput, midiOutput)
    .expectInputNameEquals('SimpleDevice IN')
    .expectOutputNameEquals('SimpleDevice OUT')

DetectionSingleInput​

Inherits From: DetectionEntry

Referenced by: DeviceDetectionUnit

Methods

  • expectInputNameContains(filterValue : string) : this
  • expectInputNameEquals(filterValue : string) : this
  • expectInputNameStartsWith(filterValue : string) : this
  • expectInputNameEndsWith(filterValue : string) : this

DeviceDriverActions​

Referenced by: DeviceDriver

Properties

InitialSysexFile​

Referenced by: DeviceDriver

UserGuide​

Referenced by: DeviceDriver

(abstract) HostAction​

Inherited by: HostPluginParameterBankZoneAction, HostInsertEffectViewerAction, MixerBankZoneAction, TrackSelectionAction, SubPageActionActivate, SubPageAreaAction, MappingPageActionActivate, DeviceDriverAction

Referenced by: ActionBinding

HostPluginParameterBankZoneAction​

Inherits From: HostAction

Referenced by: HostPluginParameterBankZoneActions, ActionBinding

Methods

HostInsertEffectViewerAction​

Inherits From: HostAction

Referenced by: HostInsertEffectViewerActions, ActionBinding

Methods

MixerBankZoneAction​

Inherits From: HostAction

Referenced by: MixerBankZoneActions, ActionBinding

Methods

TrackSelectionAction​

Inherits From: HostAction

Referenced by: TrackSelectionActions, ActionBinding

Methods

SubPageActionActivate​

Inherits From: HostAction

Referenced by: SubPageActions, ActionBinding

Methods

SubPageAreaAction​

Inherits From: HostAction

Referenced by: SubPageAreaActions, ActionBinding

Methods

MappingPageActionActivate​

Inherits From: HostAction

Referenced by: MappingPageActions, ActionBinding

Methods

DeviceDriverAction​

Inherits From: HostAction

Referenced by: DeviceDriverActions, ActionBinding

Methods

ActiveDevice​

Represents a detected and activated device of a specific DeviceDriver.

Methods

  • setState(key : string, val : string)
  • getState(key : string) : string

ActiveMapping​