Package com.bitwig.extension.controller.api

Interface Scene

All Superinterfaces:

ClipLauncherSlotOrScene, DeleteableObject, DuplicableObject, ObjectProxy, Subscribable

public interface Scene
extends ClipLauncherSlotOrScene

Instances of this interface represent scenes in Bitwig Studio.

Since:

API version 1

Method Summary

Modifier and Type	Method	Description
void	addClipCountObserver(IntegerValueChangedCallback callback)	Deprecated. Use clipCount().addValueObserver(callback).
void	addIsSelectedInEditorObserver(BooleanValueChangedCallback callback)	Registers an observer that reports if the scene is selected in Bitwig Studio.
void	addPositionObserver(IntegerValueChangedCallback callback)	Deprecated. Use ClipLauncherSlotOrScene.sceneIndex() instead.
IntegerValue	clipCount()	Value that reports the number of clips in the scene.
SettableStringValue	getName()	Deprecated. Use name() instead.
SettableStringValue	name()	Returns an object that provides access to the name of the scene.
void	selectInEditor()	Selects the scene in Bitwig Studio.
void	showInEditor()	Makes the scene visible in the Bitwig Studio user interface.

Methods inherited from interface com.bitwig.extension.controller.api.ClipLauncherSlotOrScene

color, copyFrom, launch, launchAction, launchAlt, launchAltAction, launchLastClipWithOptions, launchLastClipWithOptionsAction, launchRelease, launchReleaseAction, launchReleaseAlt, launchReleaseAltAction, launchWithOptions, launchWithOptionsAction, moveTo, nextSceneInsertionPoint, previousSceneInsertionPoint, replaceInsertionPoint, sceneIndex, setIndication

Methods inherited from interface com.bitwig.extension.controller.api.DeleteableObject

deleteObject, deleteObjectAction

Methods inherited from interface com.bitwig.extension.controller.api.DuplicableObject

duplicateObject, duplicateObjectAction

Methods inherited from interface com.bitwig.extension.controller.api.ObjectProxy

createEqualsValue, exists

Methods inherited from interface com.bitwig.extension.controller.api.Subscribable

isSubscribed, setIsSubscribed, subscribe, unsubscribe

Method Details

getName

@Deprecated
SettableStringValue getName()

Deprecated.

Use name() instead.

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

name

SettableStringValue name()

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

Specified by:

name in interface ClipLauncherSlotOrScene

Returns:

a string value object that represents the scene name.

Since:

API version 2

clipCount

IntegerValue clipCount()

Value that reports the number of clips in the scene.

Since:

API version 2

addClipCountObserver

@Deprecated
void addClipCountObserver(IntegerValueChangedCallback callback)

Deprecated.

Use clipCount().addValueObserver(callback).

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

Parameters:

callback - a callback function that receives a single integer parameter

Since:

API version 1

addPositionObserver

@Deprecated
void addPositionObserver(IntegerValueChangedCallback callback)

Deprecated.

Use ClipLauncherSlotOrScene.sceneIndex() instead.

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

Parameters:

callback - a callback function that receives a single integer parameter

Since:

API version 1

addIsSelectedInEditorObserver

void addIsSelectedInEditorObserver(BooleanValueChangedCallback callback)

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

Parameters:

callback - a callback function that takes a single boolean parameter.

Since:

API version 1

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