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

Public Member Functions

SettableIntegerValue activeChainIndex ()
 
IntegerValue chainCount ()
 
DeviceLayer activeChain ()
 
void cycleNext ()
 
void cyclePrevious ()
 
- Public Member Functions inherited from ObjectProxy
BooleanValue exists ()
 
BooleanValue createEqualsValue (ObjectProxy other)
 
- Public Member Functions inherited from Subscribable
boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 
- Public Member Functions inherited from Cursor
void selectPrevious ()
 
HardwareActionBindable selectPreviousAction ()
 
void selectNext ()
 
HardwareActionBindable selectNextAction ()
 
void selectFirst ()
 
void selectLast ()
 
BooleanValue hasNext ()
 
BooleanValue hasPrevious ()
 
void addCanSelectPreviousObserver (BooleanValueChangedCallback callback)
 
void addCanSelectNextObserver (BooleanValueChangedCallback callback)
 
- Public Member Functions inherited from RelativeHardwarControlBindable
default RelativeHardwareControlBinding addBinding (RelativeHardwareControl hardwareControl)
 
RelativeHardwareControlBinding addBindingWithSensitivity (RelativeHardwareControl hardwareControl, double sensitivity)
 

Detailed Description

This interface represents a chain selector device which can be:

  • instrument selector
  • effect selector
Since
API version 6

Member Function Documentation

◆ activeChain()

DeviceLayer activeChain ( )

The active device layer.

Since
API version 6

◆ activeChainIndex()

SettableIntegerValue activeChainIndex ( )

The index of the active chain in the chain selector. In case the chain selector has no chains or the value is not connected to the chain selector, then the value will be 0.

Since
API version 6

◆ chainCount()

IntegerValue chainCount ( )

The number of chains in the chain selector.

Since
API version 6

◆ cycleNext()

void cycleNext ( )

Cycle to the next chain. If the current active chain is the last one, then moves to the first one.

Since
API version 6

◆ cyclePrevious()

void cyclePrevious ( )

Cycle to the previous chain. If the current active chain the first one, then moves to the last one.

Since
API version 6

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