Bitwig Studio Control Surface API  5.0.11
SoloValue Interface Reference
+ Inheritance diagram for SoloValue:

Public Member Functions

void toggle (boolean exclusive)
 
void toggleUsingPreferences (boolean negatePreferences)
 
- Public Member Functions inherited from SettableBooleanValue
void set (boolean value)
 
void toggle ()
 
HardwareActionBindable toggleAction ()
 
HardwareActionBindable setToTrueAction ()
 
HardwareActionBindable setToFalseAction ()
 
- Public Member Functions inherited from BooleanValue
boolean get ()
 
default boolean getAsBoolean ()
 
- Public Member Functions inherited from Value< BooleanValueChangedCallback >
void markInterested ()
 
void addValueObserver (ObserverType callback)
 
- Public Member Functions inherited from HardwareActionBindable
HardwareActionBinding addBinding (HardwareAction action)
 
void invoke ()
 

Detailed Description

Instances of this interface represent the state of a solo button.

Since
API version 1

Member Function Documentation

◆ toggle()

void toggle ( boolean  exclusive)

Toggles the current solo state.

Parameters
exclusivespecifies if solo on other channels should be disabled automatically ('true') or not ('false').
Since
API version 1

◆ toggleUsingPreferences()

void toggleUsingPreferences ( boolean  negatePreferences)

Toggles the current solo state, using the exclusive setting from the user preferences.

Parameters
negatePreferencesIf false, then toggles the solo using the exclusive behavior specified in the user preferences, ortherwise negate the preference setting.
Since
API version 18

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