Bitwig Studio Control Surface API  5.0.11
ModulationSource Interface Reference

Public Member Functions

BooleanValue isMapping ()
 
void addIsMappingObserver (BooleanValueChangedCallback callback)
 
void toggleIsMapping ()
 
StringValue name ()
 
void addNameObserver (int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
 
BooleanValue isMapped ()
 
void addIsMappedObserver (BooleanValueChangedCallback callback)
 

Detailed Description

This interface represents a modulation source in Bitwig Studio.

Since
API version 1

Member Function Documentation

◆ addIsMappedObserver()

void addIsMappedObserver ( BooleanValueChangedCallback  callback)

Registers an observer which reports if the modulation source is mapped to any destination(s).

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1
Deprecated:
Use isMapped() instead.

◆ addIsMappingObserver()

void addIsMappingObserver ( BooleanValueChangedCallback  callback)

Registers an observer which reports when the modulation source is in mapping mode.

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1
Deprecated:
Use isMapping() instead.

◆ addNameObserver()

void addNameObserver ( int  numChars,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer the reports the name of the modulation source.

Parameters
numCharsthe maximum number of character the reported name should be long
textWhenUnassignedthe default text that gets reported if the modulation source is not connected to to a modulation source in Bitwig Studio yet
callbacka callback function that receives a single string parameter
Since
API version 1
Deprecated:
Use name() instead.

◆ isMapped()

BooleanValue isMapped ( )

Value which reports if the modulation source is mapped to any destination(s).

Since
API version 2

◆ isMapping()

BooleanValue isMapping ( )

Value which reports when the modulation source is in mapping mode.

Since
API version 2

◆ name()

StringValue name ( )

Value the reports the name of the modulation source.

Since
API version 2

◆ toggleIsMapping()

void toggleIsMapping ( )

Toggles the modulation source between mapping mode and normal control functionality.

Since
API version 1

The documentation for this interface was generated from the following file: