|
Control Surface API
2.2.2
|
|
Control Surface API
2.2.2
|
An interface that provides access to the contents of a clip in Bitwig Studio.
The note content of the clip is exposed in terms of steps and keys, mainly targeted to x-y-grid applications such as step sequencers.
| void addCanScrollKeysDownObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the note grid keys can be scrolled further down.
| callback | a callback function that receives a single boolean parameter. |
| void addCanScrollKeysUpObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the note grid keys can be scrolled further up.
| callback | a callback function that receives a single boolean parameter. |
| void addCanScrollStepsBackwardsObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the note grid steps can be scrolled backwards.
| callback | a callback function that receives a single boolean parameter. |
| void addCanScrollStepsForwardObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the note grid keys can be scrolled forward.
| callback | a callback function that receives a single boolean parameter. |
| void addColorObserver | ( | ColorValueChangedCallback | callback | ) |
Registers an observer that reports the clip color.
| callback | a callback function that receives three parameters: 1. the red coordinate of the RBG color value, 2. the green coordinate of the RBG color value, and 3. the blue coordinate of the RBG color value |
| void addPlayingStepObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports note grid cells as they get played by the sequencer.
| callback | A callback function that receives a single integer parameter, which reflects the step coordinate that is played, or -1 if no step is associated with the current playback position. |
| void addStepDataObserver | ( | StepDataChangedCallback | callback | ) |
Registers an observer that reports which note grid steps/keys contain notes.
| callback | A callback function that receives three parameters: 1. the x (step) coordinate within the note grid (integer), 2. the y (key) coordinate within the note grid (integer), and 3. an integer value that indicates if the step is empty (0) or if a note continues playing (1) or starts playing (2). |
| BooleanValue canScrollKeysDown | ( | ) |
Value that reports if the note grid keys can be scrolled further down.
| BooleanValue canScrollKeysUp | ( | ) |
Value that reports if the note grid keys can be scrolled further up.
| BooleanValue canScrollStepsBackwards | ( | ) |
Value that reports if the note grid if the note grid steps can be scrolled backwards.
| BooleanValue canScrollStepsForwards | ( | ) |
Value that reports if the note grid if the note grid steps can be scrolled forwards.
| void clearStep | ( | int | x, |
| int | y | ||
| ) |
Removes the note in the grid cell specified by the given x and y arguments. Calling this method does nothing in case no note exists at the given x-y-coordinates.
| x | the x position within the note grid, defining the step/time of the target note |
| y | the y position within the note grid, defining the key of the target note |
| void clearSteps | ( | int | y | ) |
Removes all notes in the grid row specified by the given y argument.
| y | the y position within the note grid, defining the key of the target note |
| void clearSteps | ( | ) |
Removes all notes in the grid.
| SettableColorValue color | ( | ) |
Get the color of the clip.
| void duplicate | ( | ) |
Duplicates the clip.
| void duplicateContent | ( | ) |
Duplicates the content of the clip.
| SettableRangedValue getAccent | ( | ) |
Returns accent setting of the clip.
| SettableBeatTimeValue getLoopLength | ( | ) |
Returns the loop length of the clip in beat time.
| SettableBeatTimeValue getLoopStart | ( | ) |
Returns the loop start time of the clip in beat time.
| SettableBeatTimeValue getPlayStart | ( | ) |
Returns the start of the clip in beat time.
| SettableBeatTimeValue getPlayStop | ( | ) |
Returns the length of the clip in beat time.
| SettableBooleanValue getShuffle | ( | ) |
Returns shuffle settings of the clip.
| Track getTrack | ( | ) |
Gets the track that contains the clip.
| SettableBooleanValue isLoopEnabled | ( | ) |
Returns an object that provides access to the loop enabled state of the clip.
| IntegerValue playingStep | ( | ) |
Value that reports note grid cells as they get played by the sequencer.
| void quantize | ( | double | amount | ) |
Quantizes the start time of all notes in the clip according to the given amount. The note lengths remain the same as before.
| amount | a factor between 0 and 1 that allows to morph between the original note start and the quantized note start. |
| void scrollKeysPageDown | ( | ) |
Scrolls the note grid keys one page down. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [48..59].
| void scrollKeysPageUp | ( | ) |
Scrolls the note grid keys one page up. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [48..59].
| void scrollKeysStepDown | ( | ) |
Scrolls the note grid keys one key down. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [35..46].
| void scrollKeysStepUp | ( | ) |
Scrolls the note grid keys one key up. For example if the note grid is configured to show 12 keys and is currently showing keys [36..47], calling this method would scroll the note grid to key range [37..48].
| void scrollStepsPageBackwards | ( | ) |
Scrolls the note grid steps one page backwards. For example if the note grid is configured to show 16 steps and is currently showing keys [16..31], calling this method would scroll the note grid to key range [0..16].
| void scrollStepsPageForward | ( | ) |
Scrolls the note grid steps one page forward. For example if the note grid is configured to show 16 steps and is currently showing keys [0..15], calling this method would scroll the note grid to key range [16..31].
| void scrollStepsStepBackwards | ( | ) |
Scrolls the note grid steps one step backwards. For example if the note grid is configured to show 16 steps and is currently showing keys [1..16], calling this method would scroll the note grid to key range [0..15].
| void scrollStepsStepForward | ( | ) |
Scrolls the note grid steps one step forward. For example if the note grid is configured to show 16 steps and is currently showing keys [0..15], calling this method would scroll the note grid to key range [1..16].
| void scrollToKey | ( | int | key | ) |
Scroll the note grid so that the given key becomes visible.
| key | the key that should become visible |
| void scrollToStep | ( | int | step | ) |
Scroll the note grid so that the given step becomes visible.
| step | the step that should become visible |
| void selectStepContents | ( | int | x, |
| int | y, | ||
| boolean | clearCurrentSelection | ||
| ) |
Selects the note in the grid cell specified by the given x and y arguments, in case there actually is a note at the given x-y-coordinates.
| x | the x position within the note grid, defining the step/time of the target note |
| y | the y position within the note grid, defining the key of the target note |
| clearCurrentSelection | true if the existing selection should be cleared, {} if the note should be added to the current selection. |
| void setName | ( | String | name | ) |
Updates the name of the clip.
| name | the new clip name |
| void setStep | ( | int | x, |
| int | y, | ||
| int | insertVelocity, | ||
| double | insertDuration | ||
| ) |
Creates a note in the grid cell specified by the given x and y arguments. Existing notes are overwritten.
| x | the x position within the note grid, defining the step/time of the new note |
| y | the y position within the note grid, defining the key of the new note |
| insertVelocity | the velocity of the new note |
| insertDuration | the duration of the new note |
| void setStepSize | ( | double | lengthInBeatTime | ) |
Sets the beat time duration that is represented by one note grid step.
| lengthInBeatTime | the length of one note grid step in beat time. |
| void toggleStep | ( | int | x, |
| int | y, | ||
| int | insertVelocity | ||
| ) |
Toggles the existence of a note in the note grid cell specified by the given x and y arguments.
| x | the x position within the note grid, defining the step/time of the target note |
| y | the y position within the note grid, defining the key of the target note |
| insertVelocity | the velocity of the target note in case a new note gets inserted |
| void transpose | ( | int | semitones | ) |
Transposes all notes in the clip by the given number of semitones.
| semitones | the amount of semitones to transpose, can be a positive or negative integer value. |
Public Member Functions inherited from