Bitwig Studio Control Surface API
5.0.11
|
Instances of this interface represent a scrollable fixed-size window that is connected to a section of the clip launcher slots for a specific track.
void addColorObserver | ( | IndexedColorValueChangedCallback | callback | ) |
Registers an observer that reports the colors of clip in the current slot window.
callback | a callback function that receives four parameters: 1. the slot index (integer), 2. the red coordinate of the RBG color value, 3. the green coordinate of the RBG color value, and 4. the blue coordinate of the RBG color value |
void addHasContentObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
Registers an observer that reports which slots contain clips.
callback | a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index contains a clip (true ) or not (false ) |
void addIsPlaybackQueuedObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
Add an observer if clip playback is queued on the slot.
callback | a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently queued for playback (true ) or not (false ) |
void addIsPlayingObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
Registers an observer that reports which slots have clips that are currently playing.
callback | a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently playing (true ) or not (false ) |
void addIsQueuedObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
void addIsRecordingObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
Registers an observer that reports which slots have clips that are currently recording.
callback | a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently recording (true ) or not (false ) |
void addIsRecordingQueuedObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
Add an observer if clip recording is queued on the slot.
callback | a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently queued for recording (true ) or not (false ) |
void addIsSelectedObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
Registers an observer that reports selection changes for the slots inside the window.
callback | a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index is selected (true ) or not (false ) |
void addIsStopQueuedObserver | ( | IndexedBooleanValueChangedCallback | callback | ) |
Add an observer if clip playback is queued to stop on the slot.
callback | a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently queued for stop (true ) or not (false ) |
void addPlaybackStateObserver | ( | ClipLauncherSlotBankPlaybackStateChangedCallback | callback | ) |
Registers an observer that reports the playback state of clips / slots. The reported states include stopped
, playing
, recording
, but also queued for stop
, queued for playback
, queued for recording
.
callback | a callback function that receives three parameters: 1. the slot index (integer), 2. the queued or playback state: 0 when stopped, 1 when playing, or 2 when recording, and 3. a boolean parameter indicating if the second argument is referring to the queued state (true ) or the actual playback state (false ) |
void createEmptyClip | ( | int | slot, |
int | lengthInBeats | ||
) |
Creates an new clip in the slot with the given index.
slot | the index of the slot within the slot window. |
void deleteClip | ( | int | slot | ) |
Deletes the clip in the slot with the given index.
slot | the index of the slot within the slot window. |
void duplicateClip | ( | int | slot | ) |
Duplicates the clip in the slot with the given index.
slot | the index of the slot within the slot window. |
SettableBooleanValue isMasterTrackContentShownOnTrackGroups | ( | ) |
Returns an object that can be used to observe and toggle if the slots on a connected track group show either scenes launch buttons (for launching the content of the track group) or the clips of the group master track.
void record | ( | int | slot | ) |
Starts recording into the slot with the given index.
slot | the index of the slot within the slot window. |
void select | ( | int | slot | ) |
Selects the slot with the given index.
slot | the index of the slot within the slot window. |
void setIndication | ( | boolean | shouldIndicate | ) |
Specifies if the Bitwig Studio clip launcher should indicate which slots are part of the window. By default indications are disabled.
shouldIndicate | true if visual indications should be enabled, false otherwise |
void showInEditor | ( | int | slot | ) |
Makes the clip content of the slot with the given index visible in the note or audio editor.
slot | the index of the slot within the slot window. |