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

Public Member Functions

void play ()
 
void continuePlayback ()
 
HardwareActionBindable playAction ()
 
HardwareActionBindable continuePlaybackAction ()
 
void stop ()
 
HardwareActionBindable stopAction ()
 
void togglePlay ()
 
void restart ()
 
HardwareActionBindable restartAction ()
 
void record ()
 
HardwareActionBindable recordAction ()
 
void rewind ()
 
HardwareActionBindable rewindAction ()
 
void fastForward ()
 
HardwareActionBindable fastForwardAction ()
 
void tapTempo ()
 
HardwareActionBindable tapTempoAction ()
 
SettableBooleanValue isPlaying ()
 
void addIsPlayingObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isArrangerRecordEnabled ()
 
void addIsRecordingObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isArrangerOverdubEnabled ()
 
void addOverdubObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isClipLauncherOverdubEnabled ()
 
void addLauncherOverdubObserver (BooleanValueChangedCallback callback)
 
SettableEnumValue automationWriteMode ()
 
void addAutomationWriteModeObserver (EnumValueChangedCallback callback)
 
SettableBooleanValue isArrangerAutomationWriteEnabled ()
 
void addIsWritingArrangerAutomationObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isClipLauncherAutomationWriteEnabled ()
 
void addIsWritingClipLauncherAutomationObserver (BooleanValueChangedCallback callback)
 
BooleanValue isAutomationOverrideActive ()
 
void addAutomationOverrideObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isArrangerLoopEnabled ()
 
SettableBeatTimeValue arrangerLoopStart ()
 
SettableBeatTimeValue arrangerLoopDuration ()
 
void addIsLoopActiveObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isPunchInEnabled ()
 
void addPunchInObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isPunchOutEnabled ()
 
void addPunchOutObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isMetronomeEnabled ()
 
void addClickObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue isMetronomeTickPlaybackEnabled ()
 
void addMetronomeTicksObserver (BooleanValueChangedCallback callback)
 
SettableRangedValue metronomeVolume ()
 
void addMetronomeVolumeObserver (DoubleValueChangedCallback callback)
 
SettableBooleanValue isMetronomeAudibleDuringPreRoll ()
 
void addPreRollClickObserver (BooleanValueChangedCallback callback)
 
SettableEnumValue preRoll ()
 
void addPreRollObserver (EnumValueChangedCallback callback)
 
void toggleLoop ()
 
void setLoop (boolean isEnabled)
 
void togglePunchIn ()
 
void togglePunchOut ()
 
void toggleClick ()
 
void setClick (boolean isEnabled)
 
void toggleMetronomeTicks ()
 
void toggleMetronomeDuringPreRoll ()
 
void setPreRoll (String value)
 
void setMetronomeValue (Number amount, Number range)
 
void toggleOverdub ()
 
void setOverdub (boolean isEnabled)
 
void toggleLauncherOverdub ()
 
void setLauncherOverdub (boolean isEnabled)
 
void setAutomationWriteMode (String mode)
 
void toggleLatchAutomationWriteMode ()
 
void toggleWriteArrangerAutomation ()
 
void toggleWriteClipLauncherAutomation ()
 
void resetAutomationOverrides ()
 
void returnToArrangement ()
 
Parameter getTempo ()
 
Parameter tempo ()
 
void increaseTempo (Number amount, Number range)
 
SettableBeatTimeValue getPosition ()
 
BeatTimeValue playPosition ()
 
DoubleValue playPositionInSeconds ()
 
SettableBeatTimeValue playStartPosition ()
 
SettableDoubleValue playStartPositionInSeconds ()
 
void launchFromPlayStartPosition ()
 
HardwareActionBindable launchFromPlayStartPositionAction ()
 
void jumpToPlayStartPosition ()
 
HardwareActionBindable jumpToPlayStartPositionAction ()
 
void jumpToPreviousCueMarker ()
 
HardwareActionBindable jumpToPreviousCueMarkerAction ()
 
void jumpToNextCueMarker ()
 
HardwareActionBindable jumpToNextCueMarkerAction ()
 
void setPosition (double beats)
 
void incPosition (double beats, boolean snap)
 
SettableBeatTimeValue getInPosition ()
 
SettableBeatTimeValue getOutPosition ()
 
void addCueMarkerAtPlaybackPosition ()
 
HardwareActionBindable addCueMarkerAtPlaybackPositionAction ()
 
Parameter getCrossfade ()
 
Parameter crossfade ()
 
TimeSignatureValue getTimeSignature ()
 
TimeSignatureValue timeSignature ()
 
SettableEnumValue clipLauncherPostRecordingAction ()
 
void addClipLauncherPostRecordingActionObserver (EnumValueChangedCallback callback)
 
void setClipLauncherPostRecordingAction (String action)
 
SettableBeatTimeValue getClipLauncherPostRecordingTimeOffset ()
 
SettableEnumValue defaultLaunchQuantization ()
 
SettableBooleanValue isFillModeActive ()
 
- 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 ()
 

Detailed Description

An interface representing the transport section in Bitwig Studio.

Since
API version 1

Member Function Documentation

◆ addAutomationOverrideObserver()

void addAutomationOverrideObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if automation is overridden in Bitwig Studio.

Parameters
callbacka callback function that receives a single boolean argument (true if overridden, false otherwise).
Since
API version 1
Deprecated:
Use isAutomationOverrideActive().addValueObserver(callback)

◆ addAutomationWriteModeObserver()

void addAutomationWriteModeObserver ( EnumValueChangedCallback  callback)

Registers an observer that reports the current automation write mode.

Parameters
callbacka callback function that receives a single string argument. Possible values are "latch", "touch" or "write".
Since
API version 1
Deprecated:
Use automationWriteMode() instead.

◆ addClickObserver()

void addClickObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the metronome is enabled in Bitwig Studio.

Parameters
callbacka callback function that receives a single boolean argument (true when the metronome is enabled, false otherwise).
Since
API version 1
Deprecated:
Use isMetronomeEnabled() instead.

◆ addClipLauncherPostRecordingActionObserver()

void addClipLauncherPostRecordingActionObserver ( EnumValueChangedCallback  callback)

Registers an observer that reports the current clip launcher post recording action.

Parameters
callbacka 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".
Since
API version 1
Deprecated:
Use clipLauncherPostRecordingAction() instead.

◆ addCueMarkerAtPlaybackPosition()

void addCueMarkerAtPlaybackPosition ( )

Adds a cue marker at the current position

Since
API version 15

◆ addIsLoopActiveObserver()

void addIsLoopActiveObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if arranger looping is enabled in Bitwig Studio.

Parameters
callbacka callback function that receives a single boolean argument (true when enabled, false otherwise).
Since
API version 1
Deprecated:
Use isArrangerLoopEnabled().addValueObserver(callback)

◆ addIsPlayingObserver()

void addIsPlayingObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the Bitwig Studio transport is playing.

Parameters
callbacka callback function that receives a single boolean argument (true if playing, false otherwise).
Since
API version 1
Deprecated:
Use isPlaying() instead.

◆ addIsRecordingObserver()

void addIsRecordingObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the Bitwig Studio transport is recording.

Parameters
callbacka callback function that receives a single boolean argument (true if recording, false otherwise).
Since
API version 1
Deprecated:
Use isArrangerRecordEnabled() instead.

◆ addIsWritingArrangerAutomationObserver()

void addIsWritingArrangerAutomationObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if Bitwig Studio is currently writing arranger automation.

Parameters
callbacka callback function that receives a single boolean argument (true when arranger automation write is enabled, false otherwise).
Since
API version 1
Deprecated:
Use isArrangerAutomationWriteEnabled() instead.

◆ addIsWritingClipLauncherAutomationObserver()

void addIsWritingClipLauncherAutomationObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if Bitwig Studio is currently writing clip launcher automation.

Parameters
callbacka callback function that receives a single boolean argument (true when clip launcher automation write is enabled, false otherwise).
Since
API version 1
Deprecated:
Use isClipLauncherAutomationWriteEnabled() instead.

◆ addLauncherOverdubObserver()

void addLauncherOverdubObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if clip launcher over-dubbing is enabled in Bitwig Studio.

Parameters
callbacka callback function that receives a single boolean argument (true if clip launcher over-dubbing is enabled, false otherwise).
Since
API version 1
Deprecated:
Use isClipLauncherOverdubEnabled() instead.

◆ addMetronomeTicksObserver()

void addMetronomeTicksObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the metronome has tick playback enabled.

Parameters
callbacka callback function that receives a single boolean argument (true if metronome ticks, are enabled, false otherwise).
Since
API version 1
Deprecated:
Use isMetronomeTickPlaybackEnabled() instead.

◆ addMetronomeVolumeObserver()

void addMetronomeVolumeObserver ( DoubleValueChangedCallback  callback)

Registers an observer that reports the metronome volume.

Parameters
callbacka callback function that receives a single numeric argument.
Since
API version 1
Deprecated:
Use metronomeVolume() instead.

◆ addOverdubObserver()

void addOverdubObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if over-dubbing is enabled in Bitwig Studio.

Parameters
callbacka callback function that receives a single boolean argument (true if over-dubbing is enabled, false otherwise).
Since
API version 1
Deprecated:
Use isArrangerOverdubEnabled() instead.

◆ addPreRollClickObserver()

void addPreRollClickObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the metronome is audible during pre-roll.

Parameters
callbacka callback function that receives a single boolean argument.
Since
API version 1
Deprecated:
Use isMetronomeAudibleDuringPreRoll() instead.

◆ addPreRollObserver()

void addPreRollObserver ( EnumValueChangedCallback  callback)

Registers an observer that reports the current pre-roll setting.

Parameters
callbacka callback function that receives a single string argument. Possible values are "none", "one_bar", "two_bars", or "four_bars".
Since
API version 1
Deprecated:
Use preRoll() instead.

◆ addPunchInObserver()

void addPunchInObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if punch-in is enabled in the Bitwig Studio transport.

Parameters
callbacka callback function that receives a single boolean argument (true when punch-in is enabled, false otherwise).
Since
API version 1
Deprecated:
Use isPunchInEnabled() instead.

◆ addPunchOutObserver()

void addPunchOutObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if punch-out is enabled in the Bitwig Studio transport.

Parameters
callbacka callback function that receives a single boolean argument (true when punch-out is enabled, false otherwise).
Since
API version 1
Deprecated:
Use isPunchOutEnabled() instead.

◆ arrangerLoopDuration()

SettableBeatTimeValue arrangerLoopDuration ( )

Value that corresponds to the duration of the arranger loop

Since
API version 15

◆ arrangerLoopStart()

SettableBeatTimeValue arrangerLoopStart ( )

Value that corresponds to the start time of the arranger loop

Since
API version 15

◆ automationWriteMode()

SettableEnumValue automationWriteMode ( )

Value that reports the current automation write mode. Possible values are "latch", "touch" or "write".

Since
API version 2

◆ clipLauncherPostRecordingAction()

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".

Since
API version 2

◆ continuePlayback()

void continuePlayback ( )

Continues the playback in the Bitwig Studio transport.

Since
API version 10

◆ continuePlaybackAction()

HardwareActionBindable continuePlaybackAction ( )

Action that can be used to continue the transport.

See also
continuePlayback()
Since
API version 10

◆ crossfade()

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.

See also
Track::getCrossFadeMode()
Since
API version 5

◆ defaultLaunchQuantization()

SettableEnumValue defaultLaunchQuantization ( )

Setting for the default launch quantization.

Possible values are "none", "8", "4", "2", "1", "1/2", "1/4", "1/8", "1/16".

Since
API version 8

◆ fastForward()

void fastForward ( )

Calling this function is equivalent to pressing the fast forward button in the Bitwig Studio transport.

Since
API version 1

◆ fastForwardAction()

HardwareActionBindable fastForwardAction ( )

Action that can be used to fast forward the transport.

See also
fastForward()
Since
API version 10

◆ getClipLauncherPostRecordingTimeOffset()

SettableBeatTimeValue getClipLauncherPostRecordingTimeOffset ( )

Returns an object that provides access to the clip launcher post recording time offset.

Returns
a beat time object that represents the post recording time offset
Since
API version 1

◆ getCrossfade()

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.

See also
Track::getCrossFadeMode()
Since
API version 1
Deprecated:
Use crossfade() instead.

◆ getInPosition()

SettableBeatTimeValue getInPosition ( )

Returns an object that provides access to the punch-in position in the Bitwig Studio transport.

Returns
a beat time object that represents the punch-in position
Since
API version 1

◆ getOutPosition()

SettableBeatTimeValue getOutPosition ( )

Returns an object that provides access to the punch-out position in the Bitwig Studio transport.

Returns
a beat time object that represents the punch-out position
Since
API version 1

◆ getPosition()

SettableBeatTimeValue getPosition ( )

Returns an object that provides access to the transport position in Bitwig Studio.

Returns
a beat time object that represents the transport position
Since
API version 1

◆ getTempo()

Parameter getTempo ( )

Returns an object that provides access to the project tempo.

Returns
the requested tempo value object
Since
API version 1
Deprecated:
Use tempo() instead.

◆ getTimeSignature()

TimeSignatureValue getTimeSignature ( )

Returns an object that provides access to the transport time signature.

Returns
the time signature value object that represents the transport time signature.
Since
API version 1
Deprecated:
Use timeSignature() instead.

◆ incPosition()

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.

Parameters
beatsthe beat time value that gets added to the current transport position. Values have double precision and can be positive or negative.
snapwhen 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
Since
API version 1

◆ increaseTempo()

void increaseTempo ( Number  amount,
Number  range 
)

Increases the project tempo value by the given amount, which is specified relative to the given range.

Parameters
amountthe new tempo value relative to the specified range. Values should be in the range [0..range-1].
rangethe range of the provided amount value
Since
API version 1

◆ isArrangerAutomationWriteEnabled()

SettableBooleanValue isArrangerAutomationWriteEnabled ( )

Value that reports if automation write is currently enabled for the arranger.

Since
API version 2

◆ isArrangerLoopEnabled()

SettableBooleanValue isArrangerLoopEnabled ( )

Value that indicates if the loop is currently active or not.

Since
API version 2

◆ isArrangerOverdubEnabled()

SettableBooleanValue isArrangerOverdubEnabled ( )

Value that reports if overdubbing is enabled in Bitwig Studio.

Since
API version 2

◆ isArrangerRecordEnabled()

SettableBooleanValue isArrangerRecordEnabled ( )

Value that reports if the Bitwig Studio transport is recording.

Since
API version 2

◆ isAutomationOverrideActive()

BooleanValue isAutomationOverrideActive ( )

Value that indicates if automation override is currently on.

Since
API version 2

◆ isClipLauncherAutomationWriteEnabled()

SettableBooleanValue isClipLauncherAutomationWriteEnabled ( )

Value that reports if automation write is currently enabled on the clip launcher.

Since
API version 2

◆ isClipLauncherOverdubEnabled()

SettableBooleanValue isClipLauncherOverdubEnabled ( )

Value reports if clip launcher overdubbing is enabled in Bitwig Studio.

Since
API version 2

◆ isFillModeActive()

SettableBooleanValue isFillModeActive ( )

Value that indicates if the project's fill mode is active or not.

Since
API version 14

◆ isMetronomeAudibleDuringPreRoll()

SettableBooleanValue isMetronomeAudibleDuringPreRoll ( )

Value that reports if the metronome is audible during pre-roll.

Since
API version 2

◆ isMetronomeEnabled()

SettableBooleanValue isMetronomeEnabled ( )

Value that reports if the metronome is enabled in Bitwig Studio.

Since
API version 2

◆ isMetronomeTickPlaybackEnabled()

SettableBooleanValue isMetronomeTickPlaybackEnabled ( )

Value that reports if the metronome has tick playback enabled.

Since
API version 2

◆ isPlaying()

SettableBooleanValue isPlaying ( )

Value that reports if the Bitwig Studio transport is playing.

Since
API version 2

◆ isPunchInEnabled()

SettableBooleanValue isPunchInEnabled ( )

Value that reports if punch-in is enabled in the Bitwig Studio transport.

Since
API version 2

◆ isPunchOutEnabled()

SettableBooleanValue isPunchOutEnabled ( )

Value that reports if punch-in is enabled in the Bitwig Studio transport.

Since
API version 2

◆ jumpToNextCueMarker()

void jumpToNextCueMarker ( )

Make the transport jump to the previous cue marker.

Since
API version 10

◆ jumpToPlayStartPosition()

void jumpToPlayStartPosition ( )

Make the transport jump to the play-start position.

Since
API version 10

◆ jumpToPreviousCueMarker()

void jumpToPreviousCueMarker ( )

Make the transport jump to the previous cue marker.

Since
API version 10

◆ launchFromPlayStartPosition()

void launchFromPlayStartPosition ( )

Make the transport jump to the play-start position.

Since
API version 10

◆ metronomeVolume()

SettableRangedValue metronomeVolume ( )

Value that reports the metronome volume.

Since
API version 2

◆ play()

void play ( )

Starts playback in the Bitwig Studio transport.

Since
API version 1

◆ playAction()

HardwareActionBindable playAction ( )

Action that can be used to play the transport.

See also
play()
Since
API version 10

◆ playPosition()

BeatTimeValue playPosition ( )

Returns an object that provides access to the current transport position.

Returns
beat-time value
Since
API version 10

◆ playPositionInSeconds()

DoubleValue playPositionInSeconds ( )

Returns an object that provides access to the current transport position in seconds.

Returns
value (seconds)
Since
API version 10

◆ playStartPosition()

SettableBeatTimeValue playStartPosition ( )

Returns an object that provides access to the transport's play-start position. (blue triangle)

Returns
beat-time value
Since
API version 10

◆ playStartPositionInSeconds()

SettableDoubleValue playStartPositionInSeconds ( )

Returns an object that provides access to the transport's play-start position in seconds. (blue triangle)

Returns
value (seconds)
Since
API version 10

◆ preRoll()

SettableEnumValue preRoll ( )

Value that reports the current pre-roll setting. Possible values are "none", "one_bar", "two_bars", or "four_bars".

Since
API version 2

◆ record()

void record ( )

Starts recording in the Bitwig Studio transport.

Since
API version 1

◆ recordAction()

HardwareActionBindable recordAction ( )

Action that can be used to start recording

See also
record()
Since
API version 10

◆ resetAutomationOverrides()

void resetAutomationOverrides ( )

Resets any automation overrides in Bitwig Studio.

Since
API version 1

◆ restart()

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.

Since
API version 1

◆ restartAction()

HardwareActionBindable restartAction ( )

Action that can be used to restart the transport.

See also
restart()
Since
API version 10

◆ returnToArrangement()

void returnToArrangement ( )

Switches playback to the arrangement sequencer on all tracks.

Since
API version 1

◆ rewind()

void rewind ( )

Rewinds the Bitwig Studio transport to the beginning of the arrangement.

Since
API version 1

◆ rewindAction()

HardwareActionBindable rewindAction ( )

Action that can be used to rewind the transport.

See also
rewind()
Since
API version 10

◆ setAutomationWriteMode()

void setAutomationWriteMode ( String  mode)

Sets the automation write mode.

Parameters
modethe string that identifies the new automation write mode. Possible values are "latch", "touch" or "write".
Since
API version 1
Deprecated:
Use automationWriteMode() instead.

◆ setClick()

void setClick ( boolean  isEnabled)

Enables of disables the metronome according to the given parameter.

Parameters
isEnabledtrue to enable the metronome, false otherwise
Since
API version 1
Deprecated:
Use isMetronomeEnabled() instead.

◆ setClipLauncherPostRecordingAction()

void setClipLauncherPostRecordingAction ( String  action)

Sets the automation write mode.

Parameters
actionthe 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".
Since
API version 1
Deprecated:
Use clipLauncherPostRecordingAction() instead.

◆ setLauncherOverdub()

void setLauncherOverdub ( boolean  isEnabled)

Enables of disables clip launcher over-dubbing according to the given parameter.

Parameters
isEnabledtrue to enable the over-dubbing, false otherwise
Since
API version 1
Deprecated:
Use isClipLauncherOverdubEnabled() instead.

◆ setLoop()

void setLoop ( boolean  isEnabled)

Enables of disables the arranger loop according to the given parameter.

Parameters
isEnabledtrue to enable the arranger loop, false otherwise
Since
API version 1
Deprecated:
Use isArrangerLoopEnabled() instead.

◆ setMetronomeValue()

void setMetronomeValue ( Number  amount,
Number  range 
)

Sets the metronome volume.

Parameters
amountthe new metronome volume relative to the specified range. Values should be in the range [0..range-1].
rangethe range of the provided amount value
Since
API version 1
Deprecated:
Use metronomeVolume() instead.

◆ setOverdub()

void setOverdub ( boolean  isEnabled)

Enables of disables arranger over-dubbing according to the given parameter.

Parameters
isEnabledtrue to enable over-dubbing, false otherwise
Since
API version 1
Deprecated:
Use isArrangerOverdubEnabled() instead.

◆ setPosition()

void setPosition ( double  beats)

Sets the transport playback position to the given beat time value.

Parameters
beatsthe new playback position in beats
Since
API version 1

◆ setPreRoll()

void setPreRoll ( String  value)

Updates the transport pre-roll setting according to the given parameter.

Parameters
valuethe new pre-roll setting, either "none", "one_bar", "two_bars", or "four_bars".
Since
API version 1
Deprecated:
Use preRoll() instead.

◆ stop()

void stop ( )

Stops playback in the Bitwig Studio transport.

Since
API version 1

◆ stopAction()

HardwareActionBindable stopAction ( )

Action that can be used to stop the transport.

See also
stop()
Since
API version 10

◆ tapTempo()

void tapTempo ( )

When calling this function multiple times, the timing of those calls gets evaluated and causes adjustments to the project tempo.

Since
API version 1

◆ tapTempoAction()

HardwareActionBindable tapTempoAction ( )

Action that can be used to tap the tempo.

See also
tapTempo()
Since
API version 10

◆ tempo()

Parameter tempo ( )

Returns an object that provides access to the project tempo.

Returns
the requested tempo value object
Since
API version 1

◆ timeSignature()

TimeSignatureValue timeSignature ( )

Returns an object that provides access to the transport time signature.

Returns
the time signature value object that represents the transport time signature.
Since
API version 5

◆ toggleClick()

void toggleClick ( )

Toggles the metronome enabled state of the Bitwig Studio transport.

Since
API version 1
Deprecated:
Use isMetronomeEnabled() instead.

◆ toggleLatchAutomationWriteMode()

void toggleLatchAutomationWriteMode ( )

Toggles the latch automation write mode in the Bitwig Studio transport.

Since
API version 1

◆ toggleLauncherOverdub()

void toggleLauncherOverdub ( )

Toggles clip launcher overdubbing in Bitwig Studio.

Since
API version 1
Deprecated:
Use isClipLauncherOverdubEnabled() instead.

◆ toggleLoop()

void toggleLoop ( )

Toggles the enabled state of the arranger loop in Bitwig Studio.

Since
API version 1
Deprecated:
Use isArrangerLoopEnabled() instead.

◆ toggleMetronomeDuringPreRoll()

void toggleMetronomeDuringPreRoll ( )

Toggles the enabled state of the metronome during pre-roll.

Since
API version 1
Deprecated:
Use isMetronomeAudibleDuringPreRoll() instead.

◆ toggleMetronomeTicks()

void toggleMetronomeTicks ( )

Toggles the enabled state of the metronome ticks.

Since
API version 1
Deprecated:
Use isMetronomeTickPlaybackEnabled() instead.

◆ toggleOverdub()

void toggleOverdub ( )

Toggles the over-dubbing enabled state of the Bitwig Studio transport.

Since
API version 1
Deprecated:
Use isArrangerOverdubEnabled() instead.

◆ togglePlay()

void togglePlay ( )

Toggles the transport playback state between playing and stopped.

Since
API version 1

◆ togglePunchIn()

void togglePunchIn ( )

Toggles the punch-in enabled state of the Bitwig Studio transport.

Since
API version 1
Deprecated:
Use isPunchInEnabled() instead.

◆ togglePunchOut()

void togglePunchOut ( )

Toggles the punch-out enabled state of the Bitwig Studio transport.

Since
API version 1
Deprecated:
Use isPunchOutEnabled() instead.

◆ toggleWriteArrangerAutomation()

void toggleWriteArrangerAutomation ( )

Toggles the arranger automation write enabled state of the Bitwig Studio transport.

Since
API version 1

◆ toggleWriteClipLauncherAutomation()

void toggleWriteClipLauncherAutomation ( )

Toggles the clip launcher automation write enabled state of the Bitwig Studio transport.

Since
API version 1

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