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

Public Member Functions

SettableStringValue getName ()
 
SettableStringValue name ()
 
IntegerValue clipCount ()
 
void addClipCountObserver (IntegerValueChangedCallback callback)
 
void addPositionObserver (IntegerValueChangedCallback callback)
 
void addIsSelectedInEditorObserver (BooleanValueChangedCallback callback)
 
void selectInEditor ()
 
void showInEditor ()
 
- Public Member Functions inherited from ClipLauncherSlotOrScene
void launch ()
 
HardwareActionBindable launchAction ()
 
void launchAlt ()
 
HardwareActionBindable launchAltAction ()
 
void launchRelease ()
 
HardwareActionBindable launchReleaseAction ()
 
void launchReleaseAlt ()
 
HardwareActionBindable launchReleaseAltAction ()
 
void launchWithOptions (final String quantization, final String launchMode)
 
HardwareActionBindable launchWithOptionsAction (final String quantization, final String launchMode)
 
void launchLastClipWithOptions (final String quantization, final String launchMode)
 
HardwareActionBindable launchLastClipWithOptionsAction (final String quantization, final String launchMode)
 
IntegerValue sceneIndex ()
 
void copyFrom (ClipLauncherSlotOrScene source)
 
void moveTo (ClipLauncherSlotOrScene dest)
 
SettableColorValue color ()
 
void setIndication (boolean shouldIndicate)
 
InsertionPoint replaceInsertionPoint ()
 
InsertionPoint nextSceneInsertionPoint ()
 
InsertionPoint previousSceneInsertionPoint ()
 
- 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

Instances of this interface represent scenes in Bitwig Studio.

Since
API version 1

Member Function Documentation

◆ addClipCountObserver()

void addClipCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the number of clips in the scene.

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

◆ addIsSelectedInEditorObserver()

void addIsSelectedInEditorObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the scene is selected in Bitwig Studio.

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

◆ addPositionObserver()

void addPositionObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the position of the scene within the list of Bitwig Studio scenes.

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

◆ clipCount()

IntegerValue clipCount ( )

Value that reports the number of clips in the scene.

Since
API version 2

◆ getName()

SettableStringValue getName ( )

Returns an object that provides access to the name of the scene.

Returns
a string value object that represents the scene name.
Since
API version 1
Deprecated:
Use name() instead.

◆ name()

Returns an object that provides access to the name of the scene.

Returns
a string value object that represents the scene name.
Since
API version 2

Implements ClipLauncherSlotOrScene.

◆ selectInEditor()

void selectInEditor ( )

Selects the scene in Bitwig Studio.

Since
API version 1

◆ showInEditor()

void showInEditor ( )

Makes the scene visible in the Bitwig Studio user interface.

Since
API version 1

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