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

Public Member Functions

Scene getScene (int indexInBank)
 
void scrollPageUp ()
 
void scrollPageDown ()
 
void scrollUp ()
 
void scrollDown ()
 
void scrollTo (int position)
 
void addScrollPositionObserver (IntegerValueChangedCallback callback, int valueWhenUnassigned)
 
void addCanScrollUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollDownObserver (BooleanValueChangedCallback callback)
 
void addSceneCountObserver (IntegerValueChangedCallback callback)
 
void launchScene (int indexInWindow)
 
void setIndication (boolean shouldIndicate)
 
- Public Member Functions inherited from ClipLauncherSlotOrSceneBank< Scene >
void launch (int slot)
 
void launchAlt (int slot)
 
void stop ()
 
void stopAlt ()
 
HardwareActionBindable stopAction ()
 
HardwareActionBindable stopAltAction ()
 
void returnToArrangement ()
 
void addNameObserver (IndexedStringValueChangedCallback callback)
 

Detailed Description

A scene bank provides access to a range of scenes in Bitwig Studio. Instances of scene bank are configured with a fixed number of scenes and represent an excerpt of a larger list of scenes. Various methods are provided for scrolling to different sections of the scene list. It basically acts like a window moving over the list of underlying scenes.

To receive an instance of scene bank call com.bitwig.extension.controller.api.ControllerHost#createSceneBank.

See also
com.bitwig.extension.controller.api.ControllerHost#createSceneBank
Since
API version 1

Member Function Documentation

◆ addCanScrollDownObserver()

void addCanScrollDownObserver ( 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 canScrollForwards() instead.

◆ addCanScrollUpObserver()

void addCanScrollUpObserver ( 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 canScrollBackwards() instead.

◆ 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 itemCount() instead.

◆ addScrollPositionObserver()

void addScrollPositionObserver ( 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 scrollPosition() instead

◆ getScene()

Scene getScene ( int  indexInBank)

Returns the scene at the given index within the bank.

Parameters
indexInBankthe scene index within this bank, not the index within the list of all Bitwig Studio scenes. Must be in the range [0..sizeOfBank-1].
Returns
the requested scene object
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

◆ scrollDown()

void scrollDown ( )

Scrolls the scenes one scene down.

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

◆ scrollPageDown()

void scrollPageDown ( )

Scrolls the scenes one page down.

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

◆ scrollPageUp()

void scrollPageUp ( )

Scrolls the scenes one page up.

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

◆ scrollTo()

void scrollTo ( 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 scrollIntoView(int) instead.

◆ scrollUp()

void scrollUp ( )

Scrolls the scenes one scene up.

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

◆ setIndication()

void setIndication ( boolean  shouldIndicate)

Specifies if the Bitwig Studio clip launcher should indicate which scenes are part of the window. By default indications are disabled.

Parameters
shouldIndicatetrue if visual indications should be enabled, false otherwise
Since
API version 10

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