Bitwig Studio Control Surface API
5.0.11
|
An interface representing the transport section in Bitwig Studio.
void addAutomationOverrideObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if automation is overridden in Bitwig Studio.
callback | a callback function that receives a single boolean argument (true if overridden, false otherwise). |
void addAutomationWriteModeObserver | ( | EnumValueChangedCallback | callback | ) |
Registers an observer that reports the current automation write mode.
callback | a callback function that receives a single string argument. Possible values are "latch" , "touch" or "write" . |
void addClickObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the metronome is enabled in Bitwig Studio.
callback | a callback function that receives a single boolean argument (true when the metronome is enabled, false otherwise). |
void addClipLauncherPostRecordingActionObserver | ( | EnumValueChangedCallback | callback | ) |
Registers an observer that reports the current clip launcher post recording action.
callback | a callback function that receives a single string argument. Possible values are "off" , "play_recorded" , "record_next_free_slot" , "stop" , "return_to_arrangement" , "return_to_previous_clip" or "play_random" . |
void addCueMarkerAtPlaybackPosition | ( | ) |
Adds a cue marker at the current position
void addIsLoopActiveObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if arranger looping is enabled in Bitwig Studio.
callback | a callback function that receives a single boolean argument (true when enabled, false otherwise). |
void addIsPlayingObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the Bitwig Studio transport is playing.
callback | a callback function that receives a single boolean argument (true if playing, false otherwise). |
void addIsRecordingObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the Bitwig Studio transport is recording.
callback | a callback function that receives a single boolean argument (true if recording, false otherwise). |
void addIsWritingArrangerAutomationObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if Bitwig Studio is currently writing arranger automation.
callback | a callback function that receives a single boolean argument (true when arranger automation write is enabled, false otherwise). |
void addIsWritingClipLauncherAutomationObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if Bitwig Studio is currently writing clip launcher automation.
callback | a callback function that receives a single boolean argument (true when clip launcher automation write is enabled, false otherwise). |
void addLauncherOverdubObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if clip launcher over-dubbing is enabled in Bitwig Studio.
callback | a callback function that receives a single boolean argument (true if clip launcher over-dubbing is enabled, false otherwise). |
void addMetronomeTicksObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the metronome has tick playback enabled.
callback | a callback function that receives a single boolean argument (true if metronome ticks, are enabled, false otherwise). |
void addMetronomeVolumeObserver | ( | DoubleValueChangedCallback | callback | ) |
Registers an observer that reports the metronome volume.
callback | a callback function that receives a single numeric argument. |
void addOverdubObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if over-dubbing is enabled in Bitwig Studio.
callback | a callback function that receives a single boolean argument (true if over-dubbing is enabled, false otherwise). |
void addPreRollClickObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the metronome is audible during pre-roll.
callback | a callback function that receives a single boolean argument. |
void addPreRollObserver | ( | EnumValueChangedCallback | callback | ) |
Registers an observer that reports the current pre-roll setting.
callback | a callback function that receives a single string argument. Possible values are "none" , "one_bar" , "two_bars" , or "four_bars" . |
void addPunchInObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if punch-in is enabled in the Bitwig Studio transport.
callback | a callback function that receives a single boolean argument (true when punch-in is enabled, false otherwise). |
void addPunchOutObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if punch-out is enabled in the Bitwig Studio transport.
callback | a callback function that receives a single boolean argument (true when punch-out is enabled, false otherwise). |
SettableBeatTimeValue arrangerLoopDuration | ( | ) |
Value that corresponds to the duration of the arranger loop
SettableBeatTimeValue arrangerLoopStart | ( | ) |
Value that corresponds to the start time of the arranger loop
SettableEnumValue automationWriteMode | ( | ) |
Value that reports the current automation write mode. Possible values are "latch"
, "touch"
or "write"
.
SettableEnumValue clipLauncherPostRecordingAction | ( | ) |
Value that reports the current clip launcher post recording action. Possible values are "off"
, "play_recorded"
, "record_next_free_slot"
, "stop"
, "return_to_arrangement"
, "return_to_previous_clip"
or "play_random"
.
void continuePlayback | ( | ) |
Continues the playback in the Bitwig Studio transport.
HardwareActionBindable continuePlaybackAction | ( | ) |
Parameter crossfade | ( | ) |
Returns an object that provides access to the cross-fader, used for mixing between A/B-channels as specified on the Bitwig Studio tracks.
SettableEnumValue defaultLaunchQuantization | ( | ) |
Setting for the default launch quantization.
Possible values are "none"
, "8"
, "4"
, "2"
, "1"
, "1/2"
, "1/4"
, "1/8"
, "1/16"
.
void fastForward | ( | ) |
Calling this function is equivalent to pressing the fast forward button in the Bitwig Studio transport.
HardwareActionBindable fastForwardAction | ( | ) |
SettableBeatTimeValue getClipLauncherPostRecordingTimeOffset | ( | ) |
Returns an object that provides access to the clip launcher post recording time offset.
Parameter getCrossfade | ( | ) |
Returns an object that provides access to the cross-fader, used for mixing between A/B-channels as specified on the Bitwig Studio tracks.
SettableBeatTimeValue getInPosition | ( | ) |
Returns an object that provides access to the punch-in position in the Bitwig Studio transport.
SettableBeatTimeValue getOutPosition | ( | ) |
Returns an object that provides access to the punch-out position in the Bitwig Studio transport.
SettableBeatTimeValue getPosition | ( | ) |
Returns an object that provides access to the transport position in Bitwig Studio.
Parameter getTempo | ( | ) |
Returns an object that provides access to the project tempo.
TimeSignatureValue getTimeSignature | ( | ) |
Returns an object that provides access to the transport time signature.
void incPosition | ( | double | beats, |
boolean | snap | ||
) |
Increases the transport position value by the given number of beats, which is specified relative to the given range.
beats | the beat time value that gets added to the current transport position. Values have double precision and can be positive or negative. |
snap | when true the actual new transport position will be quantized to the beat grid, when false the position will be increased exactly by the specified beat time |
void increaseTempo | ( | Number | amount, |
Number | range | ||
) |
Increases the project tempo value by the given amount, which is specified relative to the given range.
amount | the new tempo value relative to the specified range. Values should be in the range [0..range-1]. |
range | the range of the provided amount value |
SettableBooleanValue isArrangerAutomationWriteEnabled | ( | ) |
Value that reports if automation write is currently enabled for the arranger.
SettableBooleanValue isArrangerLoopEnabled | ( | ) |
Value that indicates if the loop is currently active or not.
SettableBooleanValue isArrangerOverdubEnabled | ( | ) |
Value that reports if overdubbing is enabled in Bitwig Studio.
SettableBooleanValue isArrangerRecordEnabled | ( | ) |
Value that reports if the Bitwig Studio transport is recording.
BooleanValue isAutomationOverrideActive | ( | ) |
Value that indicates if automation override is currently on.
SettableBooleanValue isClipLauncherAutomationWriteEnabled | ( | ) |
Value that reports if automation write is currently enabled on the clip launcher.
SettableBooleanValue isClipLauncherOverdubEnabled | ( | ) |
Value reports if clip launcher overdubbing is enabled in Bitwig Studio.
SettableBooleanValue isFillModeActive | ( | ) |
Value that indicates if the project's fill mode is active or not.
SettableBooleanValue isMetronomeAudibleDuringPreRoll | ( | ) |
Value that reports if the metronome is audible during pre-roll.
SettableBooleanValue isMetronomeEnabled | ( | ) |
Value that reports if the metronome is enabled in Bitwig Studio.
SettableBooleanValue isMetronomeTickPlaybackEnabled | ( | ) |
Value that reports if the metronome has tick playback enabled.
SettableBooleanValue isPlaying | ( | ) |
Value that reports if the Bitwig Studio transport is playing.
SettableBooleanValue isPunchInEnabled | ( | ) |
Value that reports if punch-in is enabled in the Bitwig Studio transport.
SettableBooleanValue isPunchOutEnabled | ( | ) |
Value that reports if punch-in is enabled in the Bitwig Studio transport.
void jumpToNextCueMarker | ( | ) |
Make the transport jump to the previous cue marker.
void jumpToPlayStartPosition | ( | ) |
Make the transport jump to the play-start position.
void jumpToPreviousCueMarker | ( | ) |
Make the transport jump to the previous cue marker.
void launchFromPlayStartPosition | ( | ) |
Make the transport jump to the play-start position.
SettableRangedValue metronomeVolume | ( | ) |
Value that reports the metronome volume.
void play | ( | ) |
Starts playback in the Bitwig Studio transport.
HardwareActionBindable playAction | ( | ) |
BeatTimeValue playPosition | ( | ) |
Returns an object that provides access to the current transport position.
DoubleValue playPositionInSeconds | ( | ) |
Returns an object that provides access to the current transport position in seconds.
SettableBeatTimeValue playStartPosition | ( | ) |
Returns an object that provides access to the transport's play-start position. (blue triangle)
SettableDoubleValue playStartPositionInSeconds | ( | ) |
Returns an object that provides access to the transport's play-start position in seconds. (blue triangle)
SettableEnumValue preRoll | ( | ) |
Value that reports the current pre-roll setting. Possible values are "none"
, "one_bar"
, "two_bars"
, or "four_bars"
.
void record | ( | ) |
Starts recording in the Bitwig Studio transport.
HardwareActionBindable recordAction | ( | ) |
void resetAutomationOverrides | ( | ) |
Resets any automation overrides in Bitwig Studio.
void restart | ( | ) |
When the transport is stopped, calling this function starts transport playback, otherwise the transport is first stopped and the playback is restarted from the last play-start position.
HardwareActionBindable restartAction | ( | ) |
void returnToArrangement | ( | ) |
Switches playback to the arrangement sequencer on all tracks.
void rewind | ( | ) |
Rewinds the Bitwig Studio transport to the beginning of the arrangement.
HardwareActionBindable rewindAction | ( | ) |
void setAutomationWriteMode | ( | String | mode | ) |
Sets the automation write mode.
mode | the string that identifies the new automation write mode. Possible values are "latch" , "touch" or "write" . |
void setClick | ( | boolean | isEnabled | ) |
Enables of disables the metronome according to the given parameter.
isEnabled | true to enable the metronome, false otherwise |
void setClipLauncherPostRecordingAction | ( | String | action | ) |
Sets the automation write mode.
action | the string that identifies the new automation write mode. Possible values are "off" , "play_recorded" , "record_next_free_slot" , "stop" , "return_to_arrangement" , "return_to_previous_clip" or "play_random" . |
void setLauncherOverdub | ( | boolean | isEnabled | ) |
Enables of disables clip launcher over-dubbing according to the given parameter.
isEnabled | true to enable the over-dubbing, false otherwise |
void setLoop | ( | boolean | isEnabled | ) |
Enables of disables the arranger loop according to the given parameter.
isEnabled | true to enable the arranger loop, false otherwise |
void setMetronomeValue | ( | Number | amount, |
Number | range | ||
) |
Sets the metronome volume.
amount | the new metronome volume relative to the specified range. Values should be in the range [0..range-1]. |
range | the range of the provided amount value |
void setOverdub | ( | boolean | isEnabled | ) |
Enables of disables arranger over-dubbing according to the given parameter.
isEnabled | true to enable over-dubbing, false otherwise |
void setPosition | ( | double | beats | ) |
Sets the transport playback position to the given beat time value.
beats | the new playback position in beats |
void setPreRoll | ( | String | value | ) |
Updates the transport pre-roll setting according to the given parameter.
value | the new pre-roll setting, either "none" , "one_bar" , "two_bars" , or "four_bars" . |
void stop | ( | ) |
Stops playback in the Bitwig Studio transport.
HardwareActionBindable stopAction | ( | ) |
void tapTempo | ( | ) |
When calling this function multiple times, the timing of those calls gets evaluated and causes adjustments to the project tempo.
HardwareActionBindable tapTempoAction | ( | ) |
Parameter tempo | ( | ) |
Returns an object that provides access to the project tempo.
TimeSignatureValue timeSignature | ( | ) |
Returns an object that provides access to the transport time signature.
void toggleClick | ( | ) |
Toggles the metronome enabled state of the Bitwig Studio transport.
void toggleLatchAutomationWriteMode | ( | ) |
Toggles the latch automation write mode in the Bitwig Studio transport.
void toggleLauncherOverdub | ( | ) |
Toggles clip launcher overdubbing in Bitwig Studio.
void toggleLoop | ( | ) |
Toggles the enabled state of the arranger loop in Bitwig Studio.
void toggleMetronomeDuringPreRoll | ( | ) |
Toggles the enabled state of the metronome during pre-roll.
void toggleMetronomeTicks | ( | ) |
Toggles the enabled state of the metronome ticks.
void toggleOverdub | ( | ) |
Toggles the over-dubbing enabled state of the Bitwig Studio transport.
void togglePlay | ( | ) |
Toggles the transport playback state between playing and stopped.
void togglePunchIn | ( | ) |
Toggles the punch-in enabled state of the Bitwig Studio transport.
void togglePunchOut | ( | ) |
Toggles the punch-out enabled state of the Bitwig Studio transport.
void toggleWriteArrangerAutomation | ( | ) |
Toggles the arranger automation write enabled state of the Bitwig Studio transport.
void toggleWriteClipLauncherAutomation | ( | ) |
Toggles the clip launcher automation write enabled state of the Bitwig Studio transport.