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

Public Member Functions

SettableBooleanValue isActivated ()
 
Parameter getVolume ()
 
Parameter volume ()
 
Parameter getPan ()
 
Parameter pan ()
 
SettableBooleanValue getMute ()
 
SettableBooleanValue mute ()
 
SoloValue getSolo ()
 
SoloValue solo ()
 
BooleanValue isMutedBySolo ()
 
void addVuMeterObserver (int range, int channel, boolean peak, IntegerValueChangedCallback callback)
 
void addNoteObserver (NotePlaybackCallback callback)
 
PlayingNoteArrayValue playingNotes ()
 
void addColorObserver (ColorValueChangedCallback callback)
 
SettableColorValue color ()
 
SendBank sendBank ()
 
Send getSend (int index)
 
void duplicate ()
 
void selectInMixer ()
 
void addIsSelectedInMixerObserver (BooleanValueChangedCallback callback)
 
void makeVisibleInArranger ()
 
void makeVisibleInMixer ()
 
- Public Member Functions inherited from DeviceChain
void selectInEditor ()
 
SettableStringValue name ()
 
void addNameObserver (int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
 
void addIsSelectedInEditorObserver (BooleanValueChangedCallback callback)
 
void addIsSelectedObserver (BooleanValueChangedCallback callback)
 
DeviceBank createDeviceBank (int numDevices)
 
Browser createDeviceBrowser (final int numFilterColumnEntries, final int numResultsColumnEntries)
 
void select ()
 
void browseToInsertAtStartOfChain ()
 
void browseToInsertAtEndOfChain ()
 
InsertionPoint startOfDeviceChainInsertionPoint ()
 
InsertionPoint endOfDeviceChainInsertionPoint ()
 
- 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 DeleteableObject
void deleteObject ()
 
HardwareActionBindable deleteObjectAction ()
 

Detailed Description

This interface defines access to the common attributes and operations of channels, such as tracks or nested device channels.

Since
API version 1

Member Function Documentation

◆ addColorObserver()

void addColorObserver ( ColorValueChangedCallback  callback)

Registers an observer that receives notifications about the color of the channel. The callback gets called at least once immediately after this function call to report the current color. Additional calls are fired each time the color changes.

Parameters
callbacka callback function that receives three float parameters in the range [0..1]: 1. red, 2. green, and 3. blue.
Since
API version 1
Deprecated:
use color() instead.

◆ addIsSelectedInMixerObserver()

void addIsSelectedInMixerObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the device chain is selected in Bitwig Studio mixer.

Parameters
callbacka callback function that takes a single boolean parameter.
Since
API version 1

◆ addNoteObserver()

void addNoteObserver ( NotePlaybackCallback  callback)

Registers an observer that reports notes when they are played on the channel.

Parameters
callbacka callback function that receives three parameters: 1. on/off state (boolean), 2. key (int), and 3. velocity (float).
Since
API version 1
Deprecated:
use playingNotes() instead.

◆ addVuMeterObserver()

void addVuMeterObserver ( int  range,
int  channel,
boolean  peak,
IntegerValueChangedCallback  callback 
)

Registers an observer for the VU-meter of this track.

Parameters
rangethe number of steps to which the reported values should be scaled. For example a range of 128 would cause the callback to be called with values between 0 and 127.
channel0 for left channel, 1 for right channel, -1 for the sum of both
peakwhen true the peak value is reported, otherwise the RMS value
callbacka callback function that takes a single numeric argument. The value is in the range [0..range-1].
Exceptions
com.bitwig.base.control_surface.ControlSurfaceException
Since
API version 1

◆ color()

SettableColorValue color ( )

Get the color of the channel.

Since
API version 2

◆ duplicate()

void duplicate ( )

Duplicates the track.

Since
API version 1

◆ getMute()

SettableBooleanValue getMute ( )

Gets a representation of the channels mute control.

Returns
an object that provides access to the channels mute control.
Since
API version 1
Deprecated:
Use mute() instead.

◆ getPan()

Parameter getPan ( )

Gets a representation of the channels pan control.

Returns
an object that provides access to the channels pan control.
Since
API version 1
Deprecated:
Use pan() instead.

◆ getSend()

Send getSend ( int  index)

Gets a representation of the channels send control at the given index.

Parameters
indexthe index of the send, must be valid
Returns
an object that provides access to the requested send control.
Since
API version 1
Deprecated:
Use sendBank() instead.

◆ getSolo()

SoloValue getSolo ( )

Gets a representation of the channels solo control.

Returns
an object that provides access to the channels solo control.
Since
API version 1
Deprecated:
Use solo() instead.

◆ getVolume()

Parameter getVolume ( )

Gets a representation of the channels volume control.

Returns
an object that provides access to the channels volume control.
Since
API version 1
Deprecated:
Use volume() instead.

◆ isActivated()

SettableBooleanValue isActivated ( )

Returns an object that represents the activated state of the channel.

Returns
an object that provides access to the channels activated state.
Since
API version 1

◆ isMutedBySolo()

BooleanValue isMutedBySolo ( )

True if the current channel is being muted by an other channel with solo on.

Since
API version 10

◆ makeVisibleInArranger()

void makeVisibleInArranger ( )

Tries to scroll the contents of the arrangement editor so that the channel becomes visible.

Since
API version 1

◆ makeVisibleInMixer()

void makeVisibleInMixer ( )

Tries to scroll the contents of the mixer panel so that the channel becomes visible.

Since
API version 1

◆ mute()

Gets a representation of the channels mute control.

Returns
an object that provides access to the channels mute control.
Since
API version 5

◆ pan()

Parameter pan ( )

Gets a representation of the channels pan control.

Returns
an object that provides access to the channels pan control.
Since
API version 5

◆ playingNotes()

PlayingNoteArrayValue playingNotes ( )

Returns an array of the playing notes.

Since
API version 2

◆ selectInMixer()

void selectInMixer ( )

Selects the device chain in the Bitwig Studio mixer, in case it is a selectable object.

Since
API version 1

◆ sendBank()

SendBank sendBank ( )

Gets a SendBank that can be used to navigate the sends of this channel.

Since
API version 2

◆ solo()

SoloValue solo ( )

Gets a representation of the channels solo control.

Returns
an object that provides access to the channels solo control.
Since
API version 1

◆ volume()

Parameter volume ( )

Gets a representation of the channels volume control.

Returns
an object that provides access to the channels volume control.
Since
API version 5

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