Package com.bitwig.extension.controller.api

Interface Transport

All Superinterfaces:
ObjectProxy, Subscribable
public interface Transport extends ObjectProxy
An interface representing the transport section in Bitwig Studio.
Since:
API version 1

  • Method Details

    • play

      void play()
      Starts playback in the Bitwig Studio transport.
      Since:
      API version 1

    • continuePlayback

      void continuePlayback()
      Continues the playback in the Bitwig Studio transport.
      Since:
      API version 10

    • playAction

      HardwareActionBindable playAction()
      Action that can be used to play the transport.
      Since:
      API version 10
      See Also:

    • continuePlaybackAction

      HardwareActionBindable continuePlaybackAction()
      Action that can be used to continue the transport.
      Since:
      API version 10
      See Also:

    • 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.
      Since:
      API version 10
      See Also:

    • togglePlay

      void togglePlay()
      Toggles the transport playback state between playing and stopped.
      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.
      Since:
      API version 10
      See Also:

    • 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
      Since:
      API version 10
      See Also:

    • 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.
      Since:
      API version 10
      See Also:

    • 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.
      Since:
      API version 10
      See Also:

    • 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.
      Since:
      API version 10
      See Also:

    • isPlaying

      SettableBooleanValue isPlaying()
      Value that reports if the Bitwig Studio transport is playing.
      Since:
      API version 2

    • addIsPlayingObserver

      @Deprecated void addIsPlayingObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isPlaying() instead.
      Registers an observer that reports if the Bitwig Studio transport is playing.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` if playing, `false` otherwise).
      Since:
      API version 1

    • isArrangerRecordEnabled

      SettableBooleanValue isArrangerRecordEnabled()
      Value that reports if the Bitwig Studio transport is recording.
      Since:
      API version 2

    • addIsRecordingObserver

      @Deprecated void addIsRecordingObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isArrangerRecordEnabled() instead.
      Registers an observer that reports if the Bitwig Studio transport is recording.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` if recording, `false` otherwise).
      Since:
      API version 1

    • isArrangerOverdubEnabled

      SettableBooleanValue isArrangerOverdubEnabled()
      Value that reports if overdubbing is enabled in Bitwig Studio.
      Since:
      API version 2

    • addOverdubObserver

      @Deprecated void addOverdubObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isArrangerOverdubEnabled() instead.
      Registers an observer that reports if over-dubbing is enabled in Bitwig Studio.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` if over-dubbing is enabled, `false` otherwise).
      Since:
      API version 1

    • isClipLauncherOverdubEnabled

      SettableBooleanValue isClipLauncherOverdubEnabled()
      Value reports if clip launcher overdubbing is enabled in Bitwig Studio.
      Since:
      API version 2

    • addLauncherOverdubObserver

      @Deprecated void addLauncherOverdubObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isClipLauncherOverdubEnabled() instead.
      Registers an observer that reports if clip launcher over-dubbing is enabled in Bitwig Studio.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` if clip launcher over-dubbing is enabled, `false` otherwise).
      Since:
      API version 1

    • automationWriteMode

      SettableEnumValue automationWriteMode()
      Value that reports the current automation write mode. Possible values are `"latch"`, `"touch"` or `"write"`.
      Since:
      API version 2

    • addAutomationWriteModeObserver

      @Deprecated void addAutomationWriteModeObserver(EnumValueChangedCallback callback)
      Deprecated.
      Use automationWriteMode() instead.
      Registers an observer that reports the current automation write mode.
      Parameters:
      callback - a callback function that receives a single string argument. Possible values are `"latch"`, `"touch"` or `"write"`.
      Since:
      API version 1

    • isArrangerAutomationWriteEnabled

      SettableBooleanValue isArrangerAutomationWriteEnabled()
      Value that reports if automation write is currently enabled for the arranger.
      Since:
      API version 2

    • addIsWritingArrangerAutomationObserver

      @Deprecated void addIsWritingArrangerAutomationObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isArrangerAutomationWriteEnabled() instead.
      Registers an observer that reports if Bitwig Studio is currently writing arranger automation.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` when arranger automation write is enabled, `false` otherwise).
      Since:
      API version 1

    • isClipLauncherAutomationWriteEnabled

      SettableBooleanValue isClipLauncherAutomationWriteEnabled()
      Value that reports if automation write is currently enabled on the clip launcher.
      Since:
      API version 2

    • addIsWritingClipLauncherAutomationObserver

      @Deprecated void addIsWritingClipLauncherAutomationObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isClipLauncherAutomationWriteEnabled() instead.
      Registers an observer that reports if Bitwig Studio is currently writing clip launcher automation.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` when clip launcher automation write is enabled, `false` otherwise).
      Since:
      API version 1

    • isAutomationOverrideActive

      BooleanValue isAutomationOverrideActive()
      Value that indicates if automation override is currently on.
      Since:
      API version 2

    • addAutomationOverrideObserver

      @Deprecated void addAutomationOverrideObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isAutomationOverrideActive().addValueObserver(callback)
      Registers an observer that reports if automation is overridden in Bitwig Studio.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` if overridden, `false` otherwise).
      Since:
      API version 1

    • isArrangerLoopEnabled

      SettableBooleanValue isArrangerLoopEnabled()
      Value that indicates if the loop is currently active or not.
      Since:
      API version 2

    • arrangerLoopStart

      SettableBeatTimeValue arrangerLoopStart()
      Value that corresponds to the start time of the arranger loop
      Since:
      API version 15

    • arrangerLoopDuration

      SettableBeatTimeValue arrangerLoopDuration()
      Value that corresponds to the duration of the arranger loop
      Since:
      API version 15

    • addIsLoopActiveObserver

      @Deprecated void addIsLoopActiveObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isArrangerLoopEnabled().addValueObserver(callback)
      Registers an observer that reports if arranger looping is enabled in Bitwig Studio.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` when enabled, `false` otherwise).
      Since:
      API version 1

    • isPunchInEnabled

      SettableBooleanValue isPunchInEnabled()
      Value that reports if punch-in is enabled in the Bitwig Studio transport.
      Since:
      API version 2

    • addPunchInObserver

      @Deprecated void addPunchInObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isPunchInEnabled() instead.
      Registers an observer that reports if punch-in is enabled in the Bitwig Studio transport.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` when punch-in is enabled, `false` otherwise).
      Since:
      API version 1

    • isPunchOutEnabled

      SettableBooleanValue isPunchOutEnabled()
      Value that reports if punch-in is enabled in the Bitwig Studio transport.
      Since:
      API version 2

    • addPunchOutObserver

      @Deprecated void addPunchOutObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isPunchOutEnabled() instead.
      Registers an observer that reports if punch-out is enabled in the Bitwig Studio transport.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` when punch-out is enabled, `false` otherwise).
      Since:
      API version 1

    • isMetronomeEnabled

      SettableBooleanValue isMetronomeEnabled()
      Value that reports if the metronome is enabled in Bitwig Studio.
      Since:
      API version 2

    • addClickObserver

      @Deprecated void addClickObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isMetronomeEnabled() instead.
      Registers an observer that reports if the metronome is enabled in Bitwig Studio.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` when the metronome is enabled, `false` otherwise).
      Since:
      API version 1

    • isMetronomeTickPlaybackEnabled

      SettableBooleanValue isMetronomeTickPlaybackEnabled()
      Value that reports if the metronome has tick playback enabled.
      Since:
      API version 2

    • addMetronomeTicksObserver

      @Deprecated void addMetronomeTicksObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isMetronomeTickPlaybackEnabled() instead.
      Registers an observer that reports if the metronome has tick playback enabled.
      Parameters:
      callback - a callback function that receives a single boolean argument (`true` if metronome ticks, are enabled, `false` otherwise).
      Since:
      API version 1

    • metronomeVolume

      SettableRangedValue metronomeVolume()
      Value that reports the metronome volume.
      Since:
      API version 2

    • addMetronomeVolumeObserver

      @Deprecated void addMetronomeVolumeObserver(DoubleValueChangedCallback callback)
      Deprecated.
      Use metronomeVolume() instead.
      Registers an observer that reports the metronome volume.
      Parameters:
      callback - a callback function that receives a single numeric argument.
      Since:
      API version 1

    • isMetronomeAudibleDuringPreRoll

      SettableBooleanValue isMetronomeAudibleDuringPreRoll()
      Value that reports if the metronome is audible during pre-roll.
      Since:
      API version 2

    • addPreRollClickObserver

      @Deprecated void addPreRollClickObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use isMetronomeAudibleDuringPreRoll() instead.
      Registers an observer that reports if the metronome is audible during pre-roll.
      Parameters:
      callback - a callback function that receives a single boolean argument.
      Since:
      API version 1

    • 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

    • addPreRollObserver

      @Deprecated void addPreRollObserver(EnumValueChangedCallback callback)
      Deprecated.
      Use preRoll() instead.
      Registers an observer that reports the current pre-roll setting.
      Parameters:
      callback - a callback function that receives a single string argument. Possible values are `"none"`, `"one_bar"`, `"two_bars"`, or `"four_bars"`.
      Since:
      API version 1

    • toggleLoop

      @Deprecated void toggleLoop()
      Deprecated.
      Use isArrangerLoopEnabled() instead.
      Toggles the enabled state of the arranger loop in Bitwig Studio.
      Since:
      API version 1

    • setLoop

      @Deprecated void setLoop(boolean isEnabled)
      Deprecated.
      Use isArrangerLoopEnabled() instead.
      Enables of disables the arranger loop according to the given parameter.
      Parameters:
      isEnabled - `true` to enable the arranger loop, `false` otherwise
      Since:
      API version 1

    • togglePunchIn

      @Deprecated void togglePunchIn()
      Deprecated.
      Use isPunchInEnabled() instead.
      Toggles the punch-in enabled state of the Bitwig Studio transport.
      Since:
      API version 1

    • togglePunchOut

      @Deprecated void togglePunchOut()
      Deprecated.
      Use isPunchOutEnabled() instead.
      Toggles the punch-out enabled state of the Bitwig Studio transport.
      Since:
      API version 1

    • toggleClick

      @Deprecated void toggleClick()
      Deprecated.
      Use isMetronomeEnabled() instead.
      Toggles the metronome enabled state of the Bitwig Studio transport.
      Since:
      API version 1

    • setClick

      @Deprecated void setClick(boolean isEnabled)
      Deprecated.
      Use isMetronomeEnabled() instead.
      Enables of disables the metronome according to the given parameter.
      Parameters:
      isEnabled - `true` to enable the metronome, `false` otherwise
      Since:
      API version 1

    • toggleMetronomeTicks

      @Deprecated void toggleMetronomeTicks()
      Deprecated.
      Use isMetronomeTickPlaybackEnabled() instead.
      Toggles the enabled state of the metronome ticks.
      Since:
      API version 1

    • toggleMetronomeDuringPreRoll

      @Deprecated void toggleMetronomeDuringPreRoll()
      Deprecated.
      Use isMetronomeAudibleDuringPreRoll() instead.
      Toggles the enabled state of the metronome during pre-roll.
      Since:
      API version 1

    • setPreRoll

      @Deprecated void setPreRoll(String value)
      Deprecated.
      Use preRoll() instead.
      Updates the transport pre-roll setting according to the given parameter.
      Parameters:
      value - the new pre-roll setting, either `"none"`, `"one_bar"`, `"two_bars"`, or `"four_bars"`.
      Since:
      API version 1

    • setMetronomeValue

      @Deprecated void setMetronomeValue(Number amount, Number range)
      Deprecated.
      Use metronomeVolume() instead.
      Sets the metronome volume.
      Parameters:
      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
      Since:
      API version 1

    • toggleOverdub

      @Deprecated void toggleOverdub()
      Deprecated.
      Use isArrangerOverdubEnabled() instead.
      Toggles the over-dubbing enabled state of the Bitwig Studio transport.
      Since:
      API version 1

    • setOverdub

      @Deprecated void setOverdub(boolean isEnabled)
      Deprecated.
      Use isArrangerOverdubEnabled() instead.
      Enables of disables arranger over-dubbing according to the given parameter.
      Parameters:
      isEnabled - `true` to enable over-dubbing, `false` otherwise
      Since:
      API version 1

    • toggleLauncherOverdub

      @Deprecated void toggleLauncherOverdub()
      Deprecated.
      Use isClipLauncherOverdubEnabled() instead.
      Toggles clip launcher overdubbing in Bitwig Studio.
      Since:
      API version 1

    • setLauncherOverdub

      @Deprecated void setLauncherOverdub(boolean isEnabled)
      Deprecated.
      Use isClipLauncherOverdubEnabled() instead.
      Enables of disables clip launcher over-dubbing according to the given parameter.
      Parameters:
      isEnabled - `true` to enable the over-dubbing, `false` otherwise
      Since:
      API version 1

    • setAutomationWriteMode

      @Deprecated void setAutomationWriteMode(String mode)
      Deprecated.
      Use automationWriteMode() instead.
      Sets the automation write mode.
      Parameters:
      mode - the string that identifies the new automation write mode. Possible values are `"latch"`, `"touch"` or `"write"`.
      Since:
      API version 1

    • toggleLatchAutomationWriteMode

      void toggleLatchAutomationWriteMode()
      Toggles the latch automation write mode in the Bitwig Studio transport.
      Since:
      API version 1

    • 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

    • resetAutomationOverrides

      void resetAutomationOverrides()
      Resets any automation overrides in Bitwig Studio.
      Since:
      API version 1

    • returnToArrangement

      void returnToArrangement()
      Switches playback to the arrangement sequencer on all tracks.
      Since:
      API version 1

    • getTempo

      @Deprecated Parameter getTempo()
      Deprecated.
      Use tempo() instead.
      Returns an object that provides access to the project tempo.
      Returns:
      the requested tempo value object
      Since:
      API version 1

    • tempo

      Parameter tempo()
      Returns an object that provides access to the project tempo.
      Returns:
      the requested tempo value object
      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:
      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
      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

    • 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

    • launchFromPlayStartPosition

      void launchFromPlayStartPosition()
      Make the transport jump to the play-start position.
      Since:
      API version 10

    • launchFromPlayStartPositionAction

      HardwareActionBindable launchFromPlayStartPositionAction()

    • jumpToPlayStartPosition

      void jumpToPlayStartPosition()
      Make the transport jump to the play-start position.
      Since:
      API version 10

    • jumpToPlayStartPositionAction

      HardwareActionBindable jumpToPlayStartPositionAction()

    • jumpToPreviousCueMarker

      void jumpToPreviousCueMarker()
      Make the transport jump to the previous cue marker.
      Since:
      API version 10

    • jumpToPreviousCueMarkerAction

      HardwareActionBindable jumpToPreviousCueMarkerAction()

    • jumpToNextCueMarker

      void jumpToNextCueMarker()
      Make the transport jump to the previous cue marker.
      Since:
      API version 10

    • jumpToNextCueMarkerAction

      HardwareActionBindable jumpToNextCueMarkerAction()

    • setPosition

      void setPosition(double beats)
      Sets the transport playback position to the given beat time value.
      Parameters:
      beats - the new playback position in beats
      Since:
      API version 1

    • 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:
      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
      Since:
      API version 1

    • 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

    • addCueMarkerAtPlaybackPosition

      void addCueMarkerAtPlaybackPosition()
      Adds a cue marker at the current position
      Since:
      API version 15

    • addCueMarkerAtPlaybackPositionAction

      HardwareActionBindable addCueMarkerAtPlaybackPositionAction()

    • getCrossfade

      @Deprecated Parameter getCrossfade()
      Deprecated.
      Use crossfade() instead.
      Returns an object that provides access to the cross-fader, used for mixing between A/B-channels as specified on the Bitwig Studio tracks.
      Since:
      API version 1
      See Also:

    • 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.
      Since:
      API version 5
      See Also:

    • getTimeSignature

      @Deprecated TimeSignatureValue getTimeSignature()
      Deprecated.
      Use timeSignature() instead.
      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

    • 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

    • 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

    • addClipLauncherPostRecordingActionObserver

      @Deprecated void addClipLauncherPostRecordingActionObserver(EnumValueChangedCallback callback)
      Deprecated.
      Use clipLauncherPostRecordingAction() instead.
      Registers an observer that reports the current clip launcher post recording action.
      Parameters:
      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"`.
      Since:
      API version 1

    • setClipLauncherPostRecordingAction

      @Deprecated void setClipLauncherPostRecordingAction(String action)
      Deprecated.
      Use clipLauncherPostRecordingAction() instead.
      Sets the automation write mode.
      Parameters:
      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"`.
      Since:
      API version 1

    • 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

    • 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

    • isFillModeActive

      SettableBooleanValue isFillModeActive()
      Value that indicates if the project's fill mode is active or not.
      Since:
      API version 14