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

Public Member Functions

Track getTrack (int indexInBank)
 
Track getChannel (int indexInBank)
 
void setTrackScrollStepSize (int stepSize)
 
void scrollTracksPageUp ()
 
void scrollTracksPageDown ()
 
void scrollTracksUp ()
 
void scrollTracksDown ()
 
void scrollToTrack (int position)
 
void addTrackScrollPositionObserver (IntegerValueChangedCallback callback, int valueWhenUnassigned)
 
SceneBank sceneBank ()
 
void scrollScenesPageUp ()
 
void scrollScenesPageDown ()
 
void scrollScenesUp ()
 
void scrollScenesDown ()
 
void scrollToScene (int position)
 
void addSceneScrollPositionObserver (IntegerValueChangedCallback callback, int valueWhenUnassigned)
 
void addCanScrollTracksUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollTracksDownObserver (BooleanValueChangedCallback callback)
 
void addCanScrollScenesUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollScenesDownObserver (BooleanValueChangedCallback callback)
 
void addSceneCountObserver (IntegerValueChangedCallback callback)
 
ClipLauncherSlotOrSceneBank getClipLauncherScenes ()
 
void launchScene (int indexInWindow)
 
void followCursorTrack (CursorTrack cursorTrack)
 
void setShouldShowClipLauncherFeedback (boolean value)
 
- Public Member Functions inherited from ChannelBank< Track >
Channel getChannel (int indexInBank)
 
void setChannelScrollStepSize (int stepSize)
 
void scrollChannelsPageUp ()
 
void scrollChannelsPageDown ()
 
void scrollChannelsUp ()
 
void scrollChannelsDown ()
 
void scrollToChannel (int position)
 
IntegerValue channelScrollPosition ()
 
void addChannelScrollPositionObserver (IntegerValueChangedCallback callback, int valueWhenUnassigned)
 
BooleanValue canScrollChannelsUp ()
 
void addCanScrollChannelsUpObserver (BooleanValueChangedCallback callback)
 
BooleanValue canScrollChannelsDown ()
 
void addCanScrollChannelsDownObserver (BooleanValueChangedCallback callback)
 
IntegerValue channelCount ()
 
void addChannelCountObserver (IntegerValueChangedCallback callback)
 
void scrollSendsPageUp ()
 
void scrollSendsPageDown ()
 
void scrollSendsUp ()
 
void scrollSendsDown ()
 
void scrollToSend (int position)
 
void addCanScrollSendsUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollSendsDownObserver (BooleanValueChangedCallback callback)
 
void addSendCountObserver (IntegerValueChangedCallback callback)
 

Detailed Description

A track bank provides access to a range of tracks and their scenes (clip launcher slots) in Bitwig Studio. Instances of track bank are configured with a fixed number of tracks and scenes and represent an excerpt of a larger list of tracks and scenes. Various methods are provided for scrolling to different sections of the track/scene list. It basically acts like a 2-dimensional window moving over the grid of tracks and scenes.

To receive an instance of track bank that supports all kinds of tracks call ControllerHost#createTrackBank. Additional methods are provided in the ControllerHost interface to create track banks that include only main tracks (ControllerHost#createMainTrackBank) or only effect tracks (ControllerHost#createEffectTrackBank).

See also
ControllerHost#createTrackBank
ControllerHost#createMainTrackBank
ControllerHost#createEffectTrackBank
Since
API version 1

Member Function Documentation

◆ addCanScrollScenesDownObserver()

void addCanScrollScenesDownObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the scene window can be scrolled further down.

Parameters
callbacka callback function that takes a single boolean parameter
Since
API version 1
Deprecated:
use canScrollScenesDown() instead.

◆ addCanScrollScenesUpObserver()

void addCanScrollScenesUpObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the scene window can be scrolled further up.

Parameters
callbacka callback function that takes a single boolean parameter
Since
API version 1
Deprecated:
use canScrollScenesUp() instead.

◆ addCanScrollTracksDownObserver()

void addCanScrollTracksDownObserver ( BooleanValueChangedCallback  callback)

◆ addCanScrollTracksUpObserver()

void addCanScrollTracksUpObserver ( BooleanValueChangedCallback  callback)

◆ addSceneCountObserver()

void addSceneCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the underlying total scene count (not the number of scenes available in the bank window).

Parameters
callbacka callback function that receives a single integer parameter
Since
API version 1
Deprecated:
Use sceneBank().itemCount().addValueObserver()

◆ addSceneScrollPositionObserver()

void addSceneScrollPositionObserver ( IntegerValueChangedCallback  callback,
int  valueWhenUnassigned 
)

Registers an observer that reports the current scene scroll position.

Parameters
callbacka callback function that takes a single integer parameter
valueWhenUnassignedthe default value that gets reports when the track bank is not yet connected to a Bitwig Studio document
Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ addTrackScrollPositionObserver()

void addTrackScrollPositionObserver ( IntegerValueChangedCallback  callback,
int  valueWhenUnassigned 
)

◆ followCursorTrack()

void followCursorTrack ( CursorTrack  cursorTrack)

Causes this bank to follow the supplied cursor. When the cursor moves to a new item the bank will be scrolled so that the cursor is within the bank, if possible.

Parameters
cursorTrackThe CursorTrack that this bank should follow.
Since
API version 2

◆ getChannel()

Track getChannel ( int  indexInBank)

Returns the track at the given index within the bank.

Parameters
indexInBankthe track index within this bank, not the index within the list of all Bitwig Studio tracks. Must be in the range [0..sizeOfBank-1].
Returns
the requested track object
Since
API version 1
Deprecated:
Use getItemAt(int) instead.

◆ getClipLauncherScenes()

ClipLauncherSlotOrSceneBank getClipLauncherScenes ( )

Returns an object that provides access to the clip launcher scenes of the track bank.

Returns
an object that provides access to the clip launcher scenes of the track bank.
Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ getTrack()

Track getTrack ( int  indexInBank)
Deprecated:
use getChannel(int) instead.
Since
API version 1

◆ launchScene()

void launchScene ( int  indexInWindow)

Launches the scene with the given bank index.

Parameters
indexInWindowthe scene index within the bank, not the position of the scene withing the underlying full list of scenes.
Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ sceneBank()

SceneBank sceneBank ( )

SceneBank that represents a view on the scenes in this TrackBank.

Since
API version 2

◆ scrollScenesDown()

void scrollScenesDown ( )

Scrolls the scenes one step down.

Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ scrollScenesPageDown()

void scrollScenesPageDown ( )

Scrolls the scenes one page down.

Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ scrollScenesPageUp()

void scrollScenesPageUp ( )

Scrolls the scenes one page up.

Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ scrollScenesUp()

void scrollScenesUp ( )

Scrolls the scenes one step up.

Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ scrollToScene()

void scrollToScene ( int  position)

Makes the scene with the given position visible in the track bank.

Parameters
positionthe position of the scene within the underlying full list of scenes
Since
API version 1
Deprecated:
Use sceneBank() instead.

◆ scrollToTrack()

void scrollToTrack ( int  position)

◆ scrollTracksDown()

void scrollTracksDown ( )

◆ scrollTracksPageDown()

void scrollTracksPageDown ( )

◆ scrollTracksPageUp()

void scrollTracksPageUp ( )

◆ scrollTracksUp()

void scrollTracksUp ( )

◆ setShouldShowClipLauncherFeedback()

void setShouldShowClipLauncherFeedback ( boolean  value)

Decides if Bitwig Studio's clip launcher should indicate the area being controlled by this controller or not.

Since
API versian 17

◆ setTrackScrollStepSize()

void setTrackScrollStepSize ( int  stepSize)

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