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

Public Member Functions

StringValue name ()
 
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 ()
 

Member Function Documentation

◆ color()

SettableColorValue color ( )

Value that reports the color of this slot.

Since
API version 7

Implemented in ClipLauncherSlot.

◆ copyFrom()

void copyFrom ( ClipLauncherSlotOrScene  source)

Copies the current slot or scene into the dest slot or scene.

Since
API version 4
Deprecated:
Use replaceInsertionPoint() instead.

◆ launch()

void launch ( )

Launches the clip or scene.

Since
API version 1

◆ launchAlt()

void launchAlt ( )

Launches with alternative settings.

Since
API version 18

◆ launchAltAction()

HardwareActionBindable launchAltAction ( )
Since
API version 18

◆ launchLastClipWithOptions()

void launchLastClipWithOptions ( final String  quantization,
final String  launchMode 
)

Launches the last clip with the given options:

Parameters
quantizationpossible values are "default", "none", "8", "4", "2", "1", "1/2", "1/4", "1/8", "1/16"
launchModepossible values are: "default", "from_start", "continue_or_from_start", "continue_or_synced", "synced"
Since
API version 16

◆ launchRelease()

void launchRelease ( )

Call it when the pad is released.

Since
API version 18

◆ launchReleaseAction()

HardwareActionBindable launchReleaseAction ( )
Since
API version 18

◆ launchReleaseAlt()

void launchReleaseAlt ( )

Call it when the pad is released with alternative settings.

Since
API version 18

◆ launchReleaseAltAction()

HardwareActionBindable launchReleaseAltAction ( )
Since
API version 18

◆ launchWithOptions()

void launchWithOptions ( final String  quantization,
final String  launchMode 
)

Launches with the given options:

Parameters
quantizationpossible values are "default", "none", "8", "4", "2", "1", "1/2", "1/4", "1/8", "1/16"
launchModepossible values are: "default", "from_start", "continue_or_from_start", "continue_or_synced", "synced"
Since
API version 16

◆ moveTo()

void moveTo ( ClipLauncherSlotOrScene  dest)

Moves the current slot or scene into the destination slot or scene.

Since
API version 4
Deprecated:
Use replaceInsertionPoint() instead.

◆ name()

StringValue 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

Implemented in Scene.

◆ nextSceneInsertionPoint()

InsertionPoint nextSceneInsertionPoint ( )

An InsertionPoint that can be used to insert content in the next scene.

Since
API version 7

◆ previousSceneInsertionPoint()

InsertionPoint previousSceneInsertionPoint ( )

An InsertionPoint that can be used to insert content after this slot or scene.

Since
API version 7

◆ replaceInsertionPoint()

InsertionPoint replaceInsertionPoint ( )

An InsertionPoint that is used to replace the contents of this slot or scene.

Since
API version 7

◆ sceneIndex()

IntegerValue sceneIndex ( )

Value that reports the position of the scene within the list of Bitwig Studio scenes.

Since
API version 2

◆ setIndication()

void setIndication ( boolean  shouldIndicate)

Specifies if the Bitwig Studio clip launcher should indicate which slots and 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
Deprecated:
Clip launcher indication is now not per slot or scene but instead as a framed rectangle in the user interface. Use SceneBank#setIndication(boolean) or TrackBank#setShouldShowClipLauncherFeedback()

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