History

Table of Contents

• API version 14
  • Application
  • Arranger
  • ControllerHost
  • DetailEditor
  • Mixer
  • NoteStep
  • TimelineEditor
  • Track
  • Transport
• API version 13
  • ExtensionDefinition
  • Project
• API version 12
  • Device
  • DeviceBank
• API version 11
  • Arpeggiator
  • Bank
  • ContinuousHardwareControl
  • EnumDefinition
  • EnumValue
  • EnumValueDefinition
  • HardwareAction
  • HardwareControl
  • MidiExpressions
  • MidiIn
  • SettableColorValue
  • Settings
• API version 10
  • Channel
  • Clip
  • ClipLauncherSlot
  • ClipLauncherSlotOrScene
  • ClipLauncherSlotOrSceneBank
  • CueMarker
  • CursorClip
  • CursorTrack
  • DeleteableObject
  • DrumPadBank
  • HardwareSurface
  • NoteInput
  • NoteLatch
  • OscModule
  • OscServer
  • SceneBank
  • Send
  • SettableBeatTimeValue
• API version 9
• API version 8
• API version 7
  • Bitmap
  • ControllerExtensionDefinition
  • CursorRemoteControlsPage
  • DeviceChain
  • DrumPad
  • Host
  • ObjectArrayValue
  • ParameterBank
  • Scrollable
  • UsbPipe
• API version 6
  • ChainSelector
• API version 5
  • ColorValue
  • CursorDevice
  • SourceSelector
  • TimeSignatureValue
• API version 4
  • Color
  • SettableRangedValue
• API version 3
  • ObjectProxy
• API version 2
  • BeatTimeFormatter
  • BeatTimeValue
  • BooleanValue
  • BrowserColumn
  • BrowserFilterColumn
  • BrowserFilterItem
  • BrowserItem
  • BrowsingSession
  • ChannelBank
  • CueMarkerBank
  • Cursor
  • DoubleValue
  • GenericBrowsingSession
  • IntegerValue
  • MidiOut
  • ModulationSource
  • Parameter
  • PinnableCursor
  • PlayingNote
  • PopupBrowser
  • RangedValue
  • Scene
  • SettableStringArrayValue
  • StringArrayValue
  • StringValue
  • TrackBank
  • Value

This document lists the API changes introduced by the different versions of Bitwig Studio.
Thanks to TeotiGraphix for contributing the code to generate this list.

API version 14

The following classes have been updated or added in API version 14.

Application

The following methods have been added to the Application class in API version 14.

• zoomLevel (): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Same as zoomIn/zoomOut, but as a stepper

Arranger

The following methods have been added to the Arranger class in API version 14.

• zoomInLaneHeightsAllAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms in all arranger lanes, if it the arranger is visible.
• zoomInLaneHeightsSelectedAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms in selected arranger lanes, if it the arranger is visible.
• zoomLaneHeightsAllStepper (): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Same as zoomInLaneHeightsAllAction/zoomOutLaneHeightsAllAction, but as a stepper
• zoomLaneHeightsSelectedStepper (): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Same as zoomInLaneHeightsSelectedAction/zoomOutLaneHeightsSelectedAction, but as a stepper
• zoomOutLaneHeightsAllAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms out all arranger lanes, if it the arranger is visible.
• zoomOutLaneHeightsSelectedAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms out selected arranger lanes, if it the arranger is visible.

ControllerHost

The following methods have been added to the ControllerHost class in API version 14.

• createDetailEditor (): com.bitwig.extension.controller.api.DetailEditor
  Returns an object which provides access to the DetailEditor panel of Bitwig Studio.
• createDetailEditor (window:int): com.bitwig.extension.controller.api.DetailEditor
  Returns an object which provides access to the DetailEditor panel inside the specified window.

DetailEditor

The following methods have been added to the DetailEditor class in API version 14.

• zoomInLaneHeightsAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms in all detail editor lanes, if it the detail editor is visible.
• zoomLaneHeightsStepper (): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Same as zoomInLaneHeightsAction/zoomOutLaneHeightsAction, but as a stepper
• zoomOutLaneHeightsAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms out all detail editor lanes, if it the detail editor is visible.

Mixer

The following methods have been added to the Mixer class in API version 14.

• zoomInTrackWidthsAllAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms in all mixer tracks, if it the mixer is visible.
• zoomInTrackWidthsSelectedAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms in selected mixer tracks, if it the mixer is visible.
• zoomOutTrackWidthsAllAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms out all mixer tracks, if it the mixer is visible.
• zoomOutTrackWidthsSelectedAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms out selected mixer tracks, if it the mixer is visible.
• zoomTrackWidthsAllStepper (): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Same as zoomInTrackWidthsAllAction/zoomOutTrackWidthsAllAction, but as a stepper
• zoomTrackWidthsSelectedStepper (): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Same as zoomInTrackWidthsSelectedAction/zoomOutTrackWidthsSelectedAction, but as a stepper

NoteStep

The following methods have been added to the NoteStep class in API version 14.

• chance (): double
  Gets the note chance.
• isChanceEnabled (): boolean
  
• isMuted (): boolean
  
• isOccurrenceEnabled (): boolean
  
• isRecurrenceEnabled (): boolean
  
• isRepeatEnabled (): boolean
  
• occurrence (): com.bitwig.extension.controller.api.NoteOccurrence
  
• recurrenceLength (): int
  
• recurrenceMask (): int
  
• repeatCount (): int
  
• repeatCurve (): double
  
• repeatVelocityCurve (): double
  
• repeatVelocityEnd (): double
  
• setChance (chance:double): void
  Sets the note chance.
• setIsChanceEnabled (isEnabled:boolean): void
  
• setIsMuted (value:boolean): void
  Mutes the note if values is true.
• setIsOccurrenceEnabled (isEnabled:boolean): void
  
• setIsRecurrenceEnabled (isEnabled:boolean): void
  
• setIsRepeatEnabled (isEnabled:boolean): void
  
• setOccurrence (condition:com.bitwig.extension.controller.api.NoteOccurrence): void
  
• setRecurrence (length:int, mask:int): void
  
• setRepeatCount (count:int): void
  
• setRepeatCurve (curve:double): void
  
• setRepeatVelocityCurve (curve:double): void
  
• setRepeatVelocityEnd (velocityEnd:double): void
  
• setVelocitySpread (amount:double): void
  
• velocitySpread (): double
  

TimelineEditor

The following methods have been added to the TimelineEditor class in API version 14.

• zoomInAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms in the timeline, if the timeline editor is visible.
• zoomOutAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Zooms out the timeline, if the timeline editor is visible.
• zoomToFitAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Adjusts the zoom level of the timeline so that all content becomes visible, if the timeline editor is visible.
• zoomToFitSelectionOrAllAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Toggles the timeline between zoomToSelection and zoomToFit, if it is visible.
• zoomToFitSelectionOrPreviousAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Toggles the timeline between zoomToSelection and the last śet zoom level, if it is visible.
• zoomToSelectionAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Adjusts the zoom level of the timeline so that it matches the active selection, if the timeline editor is visible.

Track

The following methods have been added to the Track class in API version 14.

• isMonitoring (): com.bitwig.extension.controller.api.BooleanValue
  Returns an object that provides a readout of the monitoring state of the track.
• monitorMode (): com.bitwig.extension.controller.api.SettableEnumValue
  Returns an object that provides access to the auto-monitoring mode of the track.

Transport

The following methods have been added to the Transport class in API version 14.

• isFillModeActive (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that indicates if the project's fill mode is active or not.

API version 13

The following classes have been updated or added in API version 13.

ExtensionDefinition

The following methods have been added to the ExtensionDefinition class in API version 13.

• getSupportFolderPath (): string
  Gets a remote URI or a path within the extension's jar file where support files for this extension can be found or null if there is none.

Project

The following methods have been added to the Project class in API version 13.

• createScene (): void
  Creates a new empty scene as the last scene in the project.

API version 12

The following classes have been updated or added in API version 12.

ControllerHost

The following methods have been added to the ControllerHost class in API version 12.

• createActiveDeviceMatcher (): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will only match devices that are currently active.
• createAndDeviceMatcher (deviceMatchers:com.bitwig.extension.controller.api.DeviceMatcher...): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that matches a device if all of the supplied matchers match the device.
• createAudioEffectMatcher (): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will match any audio effect.
• createBitwigDeviceMatcher (id:java.util.UUID): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will match any Bitwig native device with the supplied id.
• createFirstDeviceInChainMatcher (): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will only match devices if it is the last device in the chain.
• createInstrumentMatcher (): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will match any instrument.
• createLastDeviceInChainMatcher (): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will only match devices if it is the last device in the chain.
• createNotDeviceMatcher (deviceMatcher:com.bitwig.extension.controller.api.DeviceMatcher): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that matches a device if the supplied matcher does not match the device.
• createNoteEffectMatcher (): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will match any note effect.
• createOrDeviceMatcher (deviceMatchers:com.bitwig.extension.controller.api.DeviceMatcher...): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that matches a device if any of the supplied matchers match the device.
• createVST2DeviceMatcher (id:int): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will match any VST2 plug-in with the supplied id.
• createVST3DeviceMatcher (id:string): com.bitwig.extension.controller.api.DeviceMatcher
  Creates a DeviceMatcher that will match any VST3 plug-in with the supplied id.

Device

The following methods have been added to the Device class in API version 12.

• createSpecificBitwigDevice (deviceId:java.util.UUID): com.bitwig.extension.controller.api.SpecificBitwigDevice
  Creates an interface for accessing the features of a specific Bitwig device.
• createSpecificVst2Device (deviceId:int): com.bitwig.extension.controller.api.SpecificPluginDevice
  Creates an interface for accessing the features of a specific VST2 device.
• createSpecificVst2Device (deviceIds:int...): com.bitwig.extension.controller.api.SpecificPluginDevice
  Creates an interface for accessing the features of a specific VST2 device.
• createSpecificVst3Device (deviceId:string): com.bitwig.extension.controller.api.SpecificPluginDevice
  Creates an interface for accessing the features of a specific VST2 device.
• createSpecificVst3Device (deviceIds:string...): com.bitwig.extension.controller.api.SpecificPluginDevice
  Creates an interface for accessing the features of a specific VST2 device.
• deviceType (): com.bitwig.extension.controller.api.EnumValue
  The type of this device.

DeviceBank

The following methods have been added to the DeviceBank class in API version 12.

• setDeviceMatcher (matcher:com.bitwig.extension.controller.api.DeviceMatcher): void
  Sets a DeviceMatcher that can be used to filter devices in this bank to show only those matching the supplied matcher.

API version 11

The following classes have been updated or added in API version 11.

Arpeggiator

The following methods have been added to the Arpeggiator class in API version 11.

• enableOverlappingNotes (): com.bitwig.extension.controller.api.SettableBooleanValue
  Let the arpeggiator play overlapping notes.
• humanize (): com.bitwig.extension.controller.api.SettableDoubleValue
  Will introduce human-like errors.
• terminateNotesImmediately (): com.bitwig.extension.controller.api.SettableBooleanValue
  If set to true, it will terminate the playing note as soon as it is released, otherwise it will be held until its computed note-off time.

Bank

The following methods have been added to the Bank class in API version 11.

• setSkipDisabledItems (shouldSkip:boolean): void
  Disabled items will not be accessible via the bank if set to true.

ContinuousHardwareControl

The following methods have been added to the ContinuousHardwareControl class in API version 11.

• modulatedTargetDisplayedValue (): com.bitwig.extension.controller.api.StringValue
  Value that represents a formatted text representation of the target's modulated value whenever the value changes.
• modulatedTargetValue (): com.bitwig.extension.controller.api.DoubleValue
  The value of the target that this hardware control has been bound to (0.
• targetDisplayedValue (): com.bitwig.extension.controller.api.StringValue
  Value that represents a formatted text representation of the target value whenever the value changes.
• targetName (): com.bitwig.extension.controller.api.StringValue
  The name of the target that this hardware control has been bound to.

EnumDefinition

The following methods have been added to the EnumDefinition class in API version 11.

• getValueCount (): int
  Gets the number of entries in the enum, must be greater than 0.
• valueDefinitionAt (valueIndex:int): com.bitwig.extension.controller.api.EnumValueDefinition
  Gets the { EnumValueDefinition} for the given index.
• valueDefinitionFor (id:string): com.bitwig.extension.controller.api.EnumValueDefinition
  Gets the { EnumValueDefinition} for the given enum id.

EnumValue

The following methods have been added to the EnumValue class in API version 11.

• enumDefinition (): com.bitwig.extension.controller.api.EnumDefinition
  Gets the enum definition.

EnumValueDefinition

The following methods have been added to the EnumValueDefinition class in API version 11.

• enumDefinition (): com.bitwig.extension.controller.api.EnumDefinition
  Gets the enum definition to which belongs this value.
• getDisplayName (): string
  This is a string that is suitable for display.
• getId (): string
  Identifier for this enum value.
• getLimitedDisplayName (maxLength:int): string
  This is a shorter version of getDisplayName().
• getValueIndex (): int
  Index of this value in the enum definition.

HardwareAction

The following methods have been added to the HardwareAction class in API version 11.

• setShouldFireEvenWhenUsedAsNoteInput (value:boolean): void
  Decides if this action should fire even if the hardware input that matched it was also used as note input.

HardwareControl

The following methods have been added to the HardwareControl class in API version 11.

• getName (): string
  The name of this hardware control.
• setIndexInGroup (index:int): void
  If this control is part of group of related controls then this specifies the index in that group.
• setName (name:string): void
  The name of this hardware control.

MidiExpressions

The following methods have been added to the MidiExpressions class in API version 11.

• createIsCCExpression (controlNumber:int): string
  Creates an expression that recognizes a MIDI CC event regardless of its channel.

MidiIn

The following methods have been added to the MidiIn class in API version 11.

• createAbsoluteCCValueMatcher (controlNumber:int): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates a matcher that matches the absolute value of a MIDI CC message regardless of its channel.

SettableColorValue

The following methods have been added to the SettableColorValue class in API version 11.

• set (color:com.bitwig.extension.api.Color): void
  Sets the color.

Settings

The following methods have been added to the Settings class in API version 11.

• getBooleanSettingForValue (label:string, category:string, value:com.bitwig.extension.controller.api.SettableBooleanValue): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an boolean setting.
• getEnumSetting (label:string, category:string, initialValue:com.bitwig.extension.controller.api.EnumValueDefinition): com.bitwig.extension.controller.api.SettableEnumValue
  Returns an enumeration setting that is shown either as a chooser or as a button group in Bitwig Studio, depending on the number of provided options.
• getEnumSettingForValue (label:string, category:string, value:com.bitwig.extension.controller.api.SettableEnumValue): com.bitwig.extension.controller.api.SettableEnumValue
  Returns an enumeration setting that is shown either as a chooser or as a button group in Bitwig Studio, depending on the number of provided options.

API version 10

The following classes have been updated or added in API version 10.

Application

The following methods have been added to the Application class in API version 10.

• duplicateAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  
• recordQuantizationGrid (): com.bitwig.extension.controller.api.SettableEnumValue
  Returns the record quantization grid setting from the preferences.
• recordQuantizeNoteLength (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns a settable value to choose if the record quantization should quantize note length.
• selectFirst (): void
  Selects the first item in the current selection.
• selectLast (): void
  Selects the last item in the current selection.
• selectNext (): void
  Selects the next item in the current selection.
• selectPrevious (): void
  Selects the previous item in the current selection.
• zoomToSelectionOrAll (): void
  Toggles between zoomToSelection and zoomToFit.
• zoomToSelectionOrPrevious (): void
  Toggles between zoomToSelection and the last śet zoom level.

Arpeggiator

The following methods have been added to the Arpeggiator class in API version 10.

• gateLength (): com.bitwig.extension.controller.api.SettableDoubleValue
  Returns an object to configure the note length, expressed as a ratio of the period.
• isEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object to enable or disable the note repeat component.
• isFreeRunning (): com.bitwig.extension.controller.api.SettableBooleanValue
  If true the arpeggiator will not try to sync to the transport.
• mode (): com.bitwig.extension.controller.api.SettableEnumValue
  Returns an object to configure the arpeggiator mode.
• octaves (): com.bitwig.extension.controller.api.SettableIntegerValue
  Returns an object to configure the range in octaves.
• rate (): com.bitwig.extension.controller.api.SettableDoubleValue
  Returns an object to configure the note repeat rate in beats.
• releaseNotes (): void
  Release all notes being played.
• shuffle (): com.bitwig.extension.controller.api.SettableBooleanValue
  Return an object to configure the note repeat to use shuffle or not.
• usePressureToVelocity (): com.bitwig.extension.controller.api.SettableBooleanValue
  Will use the note pressure to determine the velocity of arpeggiated notes.

Channel

The following methods have been added to the Channel class in API version 10.

• isMutedBySolo (): com.bitwig.extension.controller.api.BooleanValue
  True if the current channel is being muted by an other channel with solo on.

Clip

The following methods have been added to the Clip class in API version 10.

• addNoteStepObserver (callback:com.bitwig.extension.callback.NoteStepChangedCallback): void
  Registers an observer that reports which note grid steps/keys contain notes.
• clearStep (channel:int, x:int, y:int): void
  Removes the note in the grid cell specified by the given x and y arguments.
• clearStepsAtX (channel:int, x:int): void
  Removes all notes in the grid started on the step x.
• clearStepsAtY (channel:int, y:int): void
  Removes all notes in the grid row specified by the given y argument.
• clipLauncherSlot (): com.bitwig.extension.controller.api.ClipLauncherSlot
  Get the clip launcher slot containing the clip.
• getStep (channel:int, x:int, y:int): com.bitwig.extension.controller.api.NoteStep
  Get step info
• launch (): void
  Launches the clip.
• selectStepContents (channel:int, x:int, y:int, clearCurrentSelection:boolean): void
  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.
• toggleStep (channel:int, x:int, y:int, insertVelocity:int): void
  Toggles the existence of a note in the note grid cell specified by the given x and y arguments.

ClipLauncherSlot

The following methods have been added to the ClipLauncherSlot class in API version 10.

• createEmptyClip (lengthInBeats:int): void
  Creates an new clip.
• duplicateClip (): void
  Duplicates the clip.
• record (): void
  Start recording a clip.
• recordAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  
• select (): void
  Selects the slot.
• selectAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  
• showInEditor (): void
  Makes the clip content of the slot visible in the note or audio editor.

ClipLauncherSlotOrScene

The following methods have been added to the ClipLauncherSlotOrScene class in API version 10.

• setIndication (shouldIndicate:boolean): void
  Specifies if the Bitwig Studio clip launcher should indicate which slots and scenes are part of the window.

ClipLauncherSlotOrSceneBank

The following methods have been added to the ClipLauncherSlotOrSceneBank class in API version 10.

• stopAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action to call stop().

ControllerHost

The following methods have been added to the ControllerHost class in API version 10.

• createAbsoluteHardwareControlAdjustmentTarget (adjustmentConsumer:java.util.function.DoubleConsumer): com.bitwig.extension.controller.api.AbsoluteHardwarControlBindable
  Creates a AbsoluteHardwarControlBindable that can be used to adjust some value in an arbitrary way.
• createAction (runnable:java.lang.Runnable, descriptionProvider:java.util.function.Supplier<java.lang.String>): com.bitwig.extension.controller.api.HardwareActionBindable
  Creates a HardwareActionBindable that can be bound to some HardwareAction (such as a button press) and when that action occurs the supplied Runnable will be run
• createAction (actionPressureConsumer:java.util.function.DoubleConsumer, descriptionProvider:java.util.function.Supplier<java.lang.String>): com.bitwig.extension.controller.api.HardwareActionBindable
  Creates a HardwareActionBindable that can be bound to some HardwareAction (such as a button press) and when that action occurs the supplied Runnable will be run
• createHardwareSurface (): com.bitwig.extension.controller.api.HardwareSurface
  Creates a HardwareSurface that can contain hardware controls.
• createOrAbsoluteHardwareValueMatcher (matcher1:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher, matcher2:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates a AbsoluteHardwareValueMatcher that is matched by either of the 2 supplied action matchers.
• createOrHardwareActionMatcher (matcher1:com.bitwig.extension.controller.api.HardwareActionMatcher, matcher2:com.bitwig.extension.controller.api.HardwareActionMatcher): com.bitwig.extension.controller.api.HardwareActionMatcher
  Creates a HardwareActionMatcher that is matched by either of the 2 supplied action matchers.
• createOrRelativeHardwareValueMatcher (matcher1:com.bitwig.extension.controller.api.RelativeHardwareValueMatcher, matcher2:com.bitwig.extension.controller.api.RelativeHardwareValueMatcher): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a RelativeHardwareValueMatcher that is matched by either of the 2 supplied action matchers.
• createRelativeHardwareControlAdjustmentTarget (adjustmentConsumer:java.util.function.DoubleConsumer): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Creates a RelativeHardwarControlBindable that can be used to adjust some value in an arbitrary way.
• createRelativeHardwareControlStepTarget (stepForwardsAction:com.bitwig.extension.controller.api.HardwareActionBindable, stepBackwardsAction:com.bitwig.extension.controller.api.HardwareActionBindable): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Creates a RelativeHardwarControlBindable that can be used to step forwards or backwards when a RelativeHardwareControl is adjusted.
• deleteObjects (objects:com.bitwig.extension.controller.api.DeleteableObject...): void
  It will delete multiple object within one undo step.
• midiExpressions (): com.bitwig.extension.controller.api.MidiExpressions
  An object that can be used to generate useful MIDI expression strings which can be used in MidiIn#createActionMatcher(String) and other related methods.

CueMarker

The following methods have been added to the CueMarker class in API version 10.

• position (): com.bitwig.extension.controller.api.SettableBeatTimeValue
  Gets a representation of the markers beat-time position in quarter-notes.

CursorClip

The following methods have been added to the CursorClip class in API version 10.

• selectClip (clip:com.bitwig.extension.controller.api.Clip): void
  Requests that the supplied clip be selected in this cursor.

CursorTrack

The following methods have been added to the CursorTrack class in API version 10.

• createLauncherCursorClip (gridWidth:int, gridHeight:int): com.bitwig.extension.controller.api.PinnableCursorClip
  Creates a PinnableCursorClip for this track that follows a clip within the track on the clip launcher.
• createLauncherCursorClip (id:string, name:string, gridWidth:int, gridHeight:int): com.bitwig.extension.controller.api.PinnableCursorClip
  Creates a PinnableCursorClip for this track that follows a clip within the track on the clip launcher.

DeleteableObject

The following methods have been added to the DeleteableObject class in API version 10.

• deleteObject (): void
  Deletes this object from the document.

DrumPadBank

The following methods have been added to the DrumPadBank class in API version 10.

• clearMutedPads (): void
  Clears mute on all drum pads.
• clearSoloedPads (): void
  Clears solo on all drum pads.
• hasMutedPads (): com.bitwig.extension.controller.api.BooleanValue
  True if there is one or many muted pads.
• hasSoloedPads (): com.bitwig.extension.controller.api.BooleanValue
  True if there is one or many soloed pads.

HardwareSurface

The following methods have been added to the HardwareSurface class in API version 10.

• createAbsoluteHardwareKnob (id:string): com.bitwig.extension.controller.api.AbsoluteHardwareKnob
  Creates an AbsoluteHardwareKnob that represents a physical knob on a controller that can be used to input an absolute value.
• createHardwareButton (id:string): com.bitwig.extension.controller.api.HardwareButton
  Creates a HardwareButton that represents a physical button on a controller
• createHardwarePixelDisplay (id:string, bitmap:com.bitwig.extension.api.graphics.Bitmap): com.bitwig.extension.controller.api.HardwarePixelDisplay
  Creates a HardwarePixelDisplay that displays the provided Bitmap that is rendered by the controller.
• createHardwareSlider (id:string): com.bitwig.extension.controller.api.HardwareSlider
  Creates a HardwareSlider that represents a physical slider on a controller.
• createHardwareTextDisplay (id:string, numLines:int): com.bitwig.extension.controller.api.HardwareTextDisplay
  Creates a HardwareTextDisplay that represents a physical text display on a controller
• createMultiStateHardwareLight (id:string): com.bitwig.extension.controller.api.MultiStateHardwareLight
  Creates a MultiStateHardwareLight that represents a physical light on a controller
• createOnOffHardwareLight (id:string): com.bitwig.extension.controller.api.OnOffHardwareLight
  Creates a OnOffHardwareLight that represents a physical light on a controller
• createRelativeHardwareKnob (id:string): com.bitwig.extension.controller.api.RelativeHardwareKnob
  Creates an RelativeHardwareKnob that represents a physical knob on a controller that can be used to input a relative value change.
• setPhysicalSize (widthInMM:double, heightInMM:double): void
  Sets the physical size of this controller in mm.
• updateHardware (): void
  Updates the state of all HardwareOutputElements that have changed since the last time this method was called.

MidiExpressions

The following methods have been added to the MidiExpressions class in API version 10.

• createIsCCValueExpression (channel:int, control:int, value:int): string
  Creates an expression that recognizes a MIDI CC event with a specific value.
• createIsNoteOffExpression (channel:int, note:int): string
  Creates an expression that recognizes a note off event.
• createIsNoteOnExpression (channel:int, note:int): string
  Creates an expression that recognizes a note on event.
• createIsPitchBendExpression (channel:int): string
  Creates an expression that recognizes a pitch bend event.
• createIsPolyAftertouch (channel:int, note:int): string
  Creates an expression that recognizes a polyphonic aftertouch event.

MidiIn

The following methods have been added to the MidiIn class in API version 10.

• createAbsoluteCCValueMatcher (channel:int, controlNumber:int): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates a matcher that matches the absolute value of a MIDI CC message.
• createAbsolutePitchBendValueMatcher (channel:int): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Create a matcher that matches the absolute value of a MIDI pitch bend message.
• createAbsoluteValueMatcher (eventExpression:string, valueExpression:string, valueBitCount:int): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates a matcher that matches the absolute value of a MIDI CC message by using expressions to filter and extract a value out of the MIDI event.
• createCCActionMatcher (channel:int, controlNumber:int, value:int): com.bitwig.extension.controller.api.HardwareActionMatcher
  Creates a matcher that recognizes an action when getting a MIDI CC event with a specific value.
• createCCActionMatcher (channel:int, controlNumber:int): com.bitwig.extension.controller.api.HardwareActionMatcher
  Creates a matcher that recognizes an action when getting a MIDI CC event regardless of the value.
• createNoteOffActionMatcher (channel:int, note:int): com.bitwig.extension.controller.api.HardwareActionMatcher
  Creates a matcher that recognizes an action when a MIDI note off event occurs.
• createNoteOffVelocityValueMatcher (channel:int, note:int): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates a matcher that recognizes a note's off velocity when a MIDI note off event occurs.
• createNoteOnActionMatcher (channel:int, note:int): com.bitwig.extension.controller.api.HardwareActionMatcher
  Creates a matcher that recognizes an action when a MIDI note on event occurs.
• createNoteOnVelocityValueMatcher (channel:int, note:int): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates a matcher that recognizes a note's on velocity when a MIDI note on event occurs.
• createPolyAftertouchValueMatcher (channel:int, note:int): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates a matcher that matches the absolute value of a Poly AT message.
• createRelative2sComplementCCValueMatcher (channel:int, controlNumber:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value of a MIDI CC message encoded using 2s complement.
• createRelative2sComplementValueMatcher (eventExpression:string, valueExpression:string, valueBitCount:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value (encoded as 2s complement) of a MIDI CC message by using expressions to filter and extract a value out of the MIDI event.
• createRelative2sComplementValueMatcher (valueMatcher:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that converts a value matched by an AbsoluteHardwareValueMatcher to a relative value using 2s complement.
• createRelativeBinOffsetCCValueMatcher (channel:int, controlNumber:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value of a MIDI CC message encoded using bin offset.
• createRelativeBinOffsetValueMatcher (eventExpression:string, valueExpression:string, valueBitCount:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value (encoded as bin offset) of a MIDI CC message by using expressions to filter and extract a value out of the MIDI event.
• createRelativeBinOffsetValueMatcher (valueMatcher:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that converts a value matched by an AbsoluteHardwareValueMatcher to a relative value using bin offset.
• createRelativeSignedBit2CCValueMatcher (channel:int, controlNumber:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value of a MIDI CC message encoded using signed bit 2.
• createRelativeSignedBit2ValueMatcher (eventExpression:string, valueExpression:string, valueBitCount:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value (encoded as signed bit 2) of a MIDI CC message by using expressions to filter and extract a value out of the MIDI event.
• createRelativeSignedBit2ValueMatcher (valueMatcher:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that converts a value matched by an AbsoluteHardwareValueMatcher to a relative value using signed bit 2.
• createRelativeSignedBitCCValueMatcher (channel:int, controlNumber:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value of a MIDI CC message encoded using signed bit.
• createRelativeSignedBitValueMatcher (eventExpression:string, valueExpression:string, valueBitCount:int, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that matches the relative value (encoded as signed bit) of a MIDI CC message by using expressions to filter and extract a value out of the MIDI event.
• createRelativeSignedBitValueMatcher (valueMatcher:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher, valueAmountForOneFullRotation:int): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that converts a value matched by an AbsoluteHardwareValueMatcher to a relative value using signed bit.
• createRelativeValueMatcher (eventExpression:string, relativeAdjustment:double): com.bitwig.extension.controller.api.RelativeHardwareValueMatcher
  Creates a matcher that applies a relative adjustment when a MIDI event occurs matching an expression.
• createSequencedValueMatcher (firstValueMatcher:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher, secondValueMatcher:com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher, areMostSignificantBitsInSecondEvent:boolean): com.bitwig.extension.controller.api.AbsoluteHardwareValueMatcher
  Creates an absolute value matcher that is defined by 2 separate MIDI events that have to occur in sequence.

NoteInput

The following methods have been added to the NoteInput class in API version 10.

• arpeggiator (): com.bitwig.extension.controller.api.Arpeggiator
  Creates a proxy object to the NoteInput's Arpeggiator component.
• includeInAllInputs (): com.bitwig.extension.controller.api.SettableBooleanValue
  Should this note input be included in the "All Inputs" note source?
• noteLatch (): com.bitwig.extension.controller.api.NoteLatch
  Creates a proxy object to the NoteInput's NoteLatch component.

NoteLatch

The following methods have been added to the NoteLatch class in API version 10.

• activeNotes (): com.bitwig.extension.controller.api.IntegerValue
  How many notes are being latched.
• isEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object to enable or disable the note latch component.
• mode (): com.bitwig.extension.controller.api.SettableEnumValue
  Returns an object to configure the note latch mode.
• mono (): com.bitwig.extension.controller.api.SettableBooleanValue
  Only one note at a time.
• releaseNotes (): void
  Release all notes being latched.
• velocityThreshold (): com.bitwig.extension.controller.api.SettableIntegerValue
  The velocity threshold used by the velocity latch mode.

NoteStep

The following methods have been added to the NoteStep class in API version 10.

• channel (): int
  
• duration (): double
  
• gain (): double
  
• isIsSelected (): boolean
  
• pan (): double
  
• pressure (): double
  
• releaseVelocity (): double
  
• setDuration (duration:double): void
  If there is a note started at this position, it will update the duration of the note.
• setGain (gain:double): void
  If there is a note started at this position, it will update the gain of the note.
• setPan (pan:double): void
  If there is a note started at this position, it will update the panning of the note.
• setPressure (pressure:double): void
  If there is a note started at this position, it will update the pressure of the note.
• setReleaseVelocity (velocity:double): void
  If there is a note started at this position, it will update the release velocity of the note.
• setTimbre (timbre:double): void
  If there is a note started at this position, it will update the timbre of the note.
• setTranspose (transpose:double): void
  If there is a note started at this position, it will update the pitch offset of the note.
• state (): com.bitwig.extension.controller.api.NoteStep.State
  
• timbre (): double
  
• transpose (): double
  
• velocity (): double
  
• x (): int
  
• y (): int
  

OscModule

The following methods have been added to the OscModule class in API version 10.

• createUdpServer (addressSpace:com.bitwig.extension.api.opensoundcontrol.OscAddressSpace): com.bitwig.extension.api.opensoundcontrol.OscServer
  Creates a new OSC Server.

OscServer

The following methods have been added to the OscServer class in API version 10.

• start (port:int): void
  Starts or restarts the server and restarts it on the given port.

Project

The following methods have been added to the Project class in API version 10.

• cueMix (): com.bitwig.extension.controller.api.Parameter
  Mix between cue bus and the studio bus (master).
• cueVolume (): com.bitwig.extension.controller.api.Parameter
  The volume used for cue output.
• hasArmedTracks (): com.bitwig.extension.controller.api.BooleanValue
  Value that indicates if the project has armed tracks or not.
• hasMutedTracks (): com.bitwig.extension.controller.api.BooleanValue
  Value that indicates if the project has muted tracks or not.
• unarmAll (): void
  Sets the arm state of all tracks to off.
• unmuteAll (): void
  Sets the mute state of all tracks to off.
• unsoloAll (): void
  Sets the solo state of all tracks to off.

SceneBank

The following methods have been added to the SceneBank class in API version 10.

• setIndication (shouldIndicate:boolean): void
  Specifies if the Bitwig Studio clip launcher should indicate which scenes are part of the window.

Send

The following methods have been added to the Send class in API version 10.

• isPreFader (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the send happens before or after the fader.
• sendMode (): com.bitwig.extension.controller.api.SettableEnumValue
  Define how the send will happen.

SettableBeatTimeValue

The following methods have been added to the SettableBeatTimeValue class in API version 10.

• beatStepper (): com.bitwig.extension.controller.api.RelativeHardwarControlBindable
  Stepper that steps through beat values.

Track

The following methods have been added to the Track class in API version 10.

• createNewLauncherClip (slotIndex:int, lengthInBeats:int): void
  Will create a new empty clip at or after slot index.
• createNewLauncherClip (slotIndex:int): void
  Will create a new empty clip at or after slot index.
• createParentTrack (numSends:int, numScenes:int): com.bitwig.extension.controller.api.Track
  Creates an object that represent the parent track.
• getIsPreFader (): com.bitwig.extension.controller.api.SettableBooleanValue
  If the track is an effect track, returns an object that indicates if the effect track is configured as pre-fader.
• recordNewLauncherClip (slotIndex:int): void
  Will start recording a new clip at or after slot index.
• selectSlot (slotIndex:int): void
  Selects the slot at the given index.
• stopAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action to call stop().

Transport

The following methods have been added to the Transport class in API version 10.

• continuePlayback (): void
  Continues the playback in the Bitwig Studio transport.
• continuePlaybackAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to continue the transport.
• fastForwardAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to fast forward the transport.
• jumpToNextCueMarker (): void
  Make the transport jump to the previous cue marker.
• jumpToPlayStartPosition (): void
  Make the transport jump to the play-start position.
• jumpToPreviousCueMarker (): void
  Make the transport jump to the previous cue marker.
• launchFromPlayStartPosition (): void
  Make the transport jump to the play-start position.
• playAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to play the transport.
• playPosition (): com.bitwig.extension.controller.api.BeatTimeValue
  Returns an object that provides access to the current transport position.
• playPositionInSeconds (): com.bitwig.extension.controller.api.DoubleValue
  Returns an object that provides access to the current transport position in seconds.
• playStartPosition (): com.bitwig.extension.controller.api.SettableBeatTimeValue
  Returns an object that provides access to the transport's play-start position.
• playStartPositionInSeconds (): com.bitwig.extension.controller.api.SettableDoubleValue
  Returns an object that provides access to the transport's play-start position in seconds.
• recordAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to start recording
• restartAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to restart the transport.
• rewindAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to rewind the transport.
• stopAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to stop the transport.
• tapTempoAction (): com.bitwig.extension.controller.api.HardwareActionBindable
  Action that can be used to tap the tempo.

API version 9

The following classes have been updated or added in API version 9.

Clip

The following methods have been added to the Clip class in API version 9.

• launchMode (): com.bitwig.extension.controller.api.SettableEnumValue
  Setting "Launch Mode" from the inspector.

API version 8

The following classes have been updated or added in API version 8.

Clip

The following methods have been added to the Clip class in API version 8.

• launchLegato (): com.bitwig.extension.controller.api.SettableBooleanValue
  Setting "Legato" from the inspector.
• launchQuantization (): com.bitwig.extension.controller.api.SettableEnumValue
  Setting for the default launch quantization.
• useLoopStartAsQuantizationReference (): com.bitwig.extension.controller.api.SettableBooleanValue
  Setting "Q to loop" in the inspector.

Transport

The following methods have been added to the Transport class in API version 8.

• defaultLaunchQuantization (): com.bitwig.extension.controller.api.SettableEnumValue
  Setting for the default launch quantization.

API version 7

The following classes have been updated or added in API version 7.

Bank

The following methods have been added to the Bank class in API version 7.

• getCapacityOfBank (): int
  The maximum number of items in the bank which is defined when the bank is initially created.
• setSizeOfBank (size:int): void
  Sets the size of this bank

Bitmap

The following methods have been added to the Bitmap class in API version 7.

• render (renderer:com.bitwig.extension.api.graphics.Renderer): void
  Call this method to start painting the bitmap.
• saveToDiskAsPPM (path:string): void
  Saves the image as a PPM file.
• setDisplayWindowTitle (title:string): void
  Updates the display window title.
• showDisplayWindow (): void
  Call this method to show a window which displays the bitmap.

ClipLauncherSlotOrScene

The following methods have been added to the ClipLauncherSlotOrScene class in API version 7.

• color (): com.bitwig.extension.controller.api.SettableColorValue
  Value that reports the color of this slot.
• nextSceneInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  An InsertionPoint that can be used to insert content in the next scene.
• previousSceneInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  An InsertionPoint that can be used to insert content after this slot or scene.
• replaceInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  An InsertionPoint that is used to replace the contents of this slot or scene.

ControllerExtensionDefinition

The following methods have been added to the ControllerExtensionDefinition class in API version 7.

• listHardwareDevices (list:com.bitwig.extension.controller.HardwareDeviceMatcherList): void
  Lists the hardware devices that this controller needs to function.

ControllerHost

The following methods have been added to the ControllerHost class in API version 7.

• hardwareDevice (index:int): com.bitwig.extension.controller.api.HardwareDevice
  Gets the HardwareDevice at the specified index.
• restart (): void
  Restarts this controller.
• useBetaApi (): void
  Call this method to allow your script to use Beta APIs.

CursorRemoteControlsPage

The following methods have been added to the CursorRemoteControlsPage class in API version 7.

• pageCount (): com.bitwig.extension.controller.api.IntegerValue
  Value that represents the number of pages.

Device

The following methods have been added to the Device class in API version 7.

• afterDeviceInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used for inserting after this device.
• beforeDeviceInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used for inserting before this device.
• replaceDeviceInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used for replacing this device.

DeviceChain

The following methods have been added to the DeviceChain class in API version 7.

• endOfDeviceChainInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used to insert at the end of the device chain.
• startOfDeviceChainInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used to insert at the start of the device chain.

DrumPad

The following methods have been added to the DrumPad class in API version 7.

• insertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used to insert content in this drum pad.

Host

The following methods have been added to the Host class in API version 7.

• allocateMemoryBlock (size:int): com.bitwig.extension.api.MemoryBlock
  Allocates some memory that will be automatically freed once the extension exits.
• createBitmap (width:int, height:int, format:com.bitwig.extension.api.graphics.BitmapFormat): com.bitwig.extension.api.graphics.Bitmap
  Creates an offscreen bitmap that the extension can use to render into.
• createFontOptions (): com.bitwig.extension.api.graphics.FontOptions
  Creates a new FontOptions.
• loadFontFace (path:string): com.bitwig.extension.api.graphics.FontFace
  Loads a font.
• loadPNG (path:string): com.bitwig.extension.api.graphics.Image
  Loads a PNG image.
• loadSVG (path:string, scale:double): com.bitwig.extension.api.graphics.Image
  Loads a SVG image.

ObjectArrayValue

The following methods have been added to the ObjectArrayValue class in API version 7.

• isEmpty (): boolean
  

ParameterBank

The following methods have been added to the ParameterBank class in API version 7.

• setHardwareLayout (type:com.bitwig.extension.controller.api.HardwareControlType, columns:int): void
  Informs the application how to display the controls during the on screen notification.

Scrollable

The following methods have been added to the Scrollable class in API version 7.

• scrollIntoView (position:int): void
  Scrolls the supplied position into view if it isn't already.

Settings

The following methods have been added to the Settings class in API version 7.

• getBooleanSetting (label:string, category:string, initialValue:boolean): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns a boolean setting.

Track

The following methods have been added to the Track class in API version 7.

• afterTrackInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used to insert after this track.
• beforeTrackInsertionPoint (): com.bitwig.extension.controller.api.InsertionPoint
  InsertionPoint that can be used to insert after this track.

UsbPipe

The following methods have been added to the UsbPipe class in API version 7.

• device (): com.bitwig.extension.controller.api.UsbDevice
  The device this endpoint is on.
• endpointAddress (): byte
  The endpoint address on the device that this endpoint is for.

API version 6

The following classes have been updated or added in API version 6.

ChainSelector

The following methods have been added to the ChainSelector class in API version 6.

• activeChain (): com.bitwig.extension.controller.api.DeviceLayer
  The active device layer.
• activeChainIndex (): com.bitwig.extension.controller.api.SettableIntegerValue
  The index of the active chain in the chain selector.
• chainCount (): com.bitwig.extension.controller.api.IntegerValue
  The number of chains in the chain selector.
• cycleNext (): void
  Cycle to the next chain.
• cyclePrevious (): void
  Cycle to the previous chain.

Device

The following methods have been added to the Device class in API version 6.

• createChainSelector (): com.bitwig.extension.controller.api.ChainSelector
  Creates a ChainSelector object which will give you control over the current device if it is an Instrument Selector or an Effect Selector.

API version 5

The following classes have been updated or added in API version 5.

Channel

The following methods have been added to the Channel class in API version 5.

• mute (): com.bitwig.extension.controller.api.SettableBooleanValue
  Gets a representation of the channels mute control.
• pan (): com.bitwig.extension.controller.api.Parameter
  Gets a representation of the channels pan control.
• volume (): com.bitwig.extension.controller.api.Parameter
  Gets a representation of the channels volume control.

ColorValue

The following methods have been added to the ColorValue class in API version 5.

• alpha (): float
  Gets the alpha component of the current value.

CursorDevice

The following methods have been added to the CursorDevice class in API version 5.

• channel (): com.bitwig.extension.controller.api.Channel
  Returns the channel that this cursor device was created on.

Device

The following methods have been added to the Device class in API version 5.

• deviceChain (): com.bitwig.extension.controller.api.DeviceChain
  Returns a representation of the device chain that contains this device.

Host

The following methods have been added to the Host class in API version 5.

• getOscModule (): com.bitwig.extension.api.opensoundcontrol.OscModule
  Gets the OpenSoundControl module.

OscModule

The following methods have been added to the OscModule class in API version 5.

• connectToUdpServer (host:string, port:int, addressSpace:com.bitwig.extension.api.opensoundcontrol.OscAddressSpace): com.bitwig.extension.api.opensoundcontrol.OscConnection
  Tries to connect to an OscServer.
• createAddressSpace (): com.bitwig.extension.api.opensoundcontrol.OscAddressSpace
  Creates a new OscAddressSpace.
• createUdpServer (port:int, addressSpace:com.bitwig.extension.api.opensoundcontrol.OscAddressSpace): void
  Creates a new OSC Server.

SettableColorValue

The following methods have been added to the SettableColorValue class in API version 5.

• set (red:float, green:float, blue:float, alpha:float): void
  Sets the internal value.

Settings

The following methods have been added to the Settings class in API version 5.

• getColorSetting (label:string, category:string, initialColor:com.bitwig.extension.api.Color): com.bitwig.extension.controller.api.SettableColorValue
  Returns a color setting that is shown in the Bitwig Studio user interface.
• getColorSettingForValue (label:string, category:string, value:com.bitwig.extension.controller.api.SettableColorValue): com.bitwig.extension.controller.api.SettableColorValue
  Returns a color setting that is shown in the Bitwig Studio user interface.

SourceSelector

The following methods have been added to the SourceSelector class in API version 5.

• hasAudioInputSelected (): com.bitwig.extension.controller.api.BooleanValue
  Returns an object that indicates if the source selector has audio inputs enabled.
• hasNoteInputSelected (): com.bitwig.extension.controller.api.BooleanValue
  Returns an object that indicates if the source selector has note inputs enabled.

TimeSignatureValue

The following methods have been added to the TimeSignatureValue class in API version 5.

• denominator (): com.bitwig.extension.controller.api.SettableIntegerValue
  Returns an object that provides access to the time signature denominator.
• numerator (): com.bitwig.extension.controller.api.SettableIntegerValue
  Returns an object that provides access to the time signature numerator.
• ticks (): com.bitwig.extension.controller.api.SettableIntegerValue
  Returns an object that provides access to the time signature tick subdivisions.

Track

The following methods have been added to the Track class in API version 5.

• arm (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object that provides access to the arm state of the track.
• autoMonitor (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object that provides access to the auto-monitoring state of the track.
• canHoldAudioData (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object that indicates if the track may contain audio events.
• canHoldNoteData (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object that indicates if the track may contain notes.
• crossFadeMode (): com.bitwig.extension.controller.api.SettableEnumValue
  Returns an object that provides access to the cross-fade mode of the track.
• monitor (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object that provides access to the monitoring state of the track.
• sourceSelector (): com.bitwig.extension.controller.api.SourceSelector
  Returns the source selector for the track, which is shown in the IO section of the track in Bitwig Studio and lists either note or audio sources or both depending on the track type.

Transport

The following methods have been added to the Transport class in API version 5.

• crossfade (): com.bitwig.extension.controller.api.Parameter
  Returns an object that provides access to the cross-fader, used for mixing between A/B-channels as specified on the Bitwig Studio tracks.
• timeSignature (): com.bitwig.extension.controller.api.TimeSignatureValue
  Returns an object that provides access to the transport time signature.

API version 4

The following classes have been updated or added in API version 4.

ClipLauncherSlotOrScene

The following methods have been added to the ClipLauncherSlotOrScene class in API version 4.

• copyFrom (source:com.bitwig.extension.controller.api.ClipLauncherSlotOrScene): void
  Copies the current slot or scene into the dest slot or scene.
• moveTo (dest:com.bitwig.extension.controller.api.ClipLauncherSlotOrScene): void
  Moves the current slot or scene into the destination slot or scene.

Color

The following methods have been added to the Color class in API version 4.

• mix (c1:com.bitwig.extension.api.Color, c2:com.bitwig.extension.api.Color, blend:double): com.bitwig.extension.api.Color
  Mixes two colors.

SettableRangedValue

The following methods have been added to the SettableRangedValue class in API version 4.

• setImmediately (value:double): void
  Sets the value in an absolute fashion as a value between 0 .

API version 3

The following classes have been updated or added in API version 3.

ObjectProxy

The following methods have been added to the ObjectProxy class in API version 3.

• createEqualsValue (other:com.bitwig.extension.controller.api.ObjectProxy): com.bitwig.extension.controller.api.BooleanValue
  Creates a BooleanValue that determines this proxy is considered equal to another proxy.

API version 2

The following classes have been updated or added in API version 2.

Application

The following methods have been added to the Application class in API version 2.

• displayProfile (): com.bitwig.extension.controller.api.StringValue
  Value that reports the name of the active display profile.
• hasActiveEngine (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether an audio engine is active or not.
• navigateIntoTrackGroup (track:com.bitwig.extension.controller.api.Track): void
  Set BitwigStudio to navigate into the group.
• navigateToParentTrackGroup (): void
  Set BitwigStudio to navigate into the parent group.
• panelLayout (): com.bitwig.extension.controller.api.StringValue
  Value that reports the name of the active panel layout.
• projectName (): com.bitwig.extension.controller.api.StringValue
  Value that reports the name of the current project.

Bank

The following methods have been added to the Bank class in API version 2.

• cursorIndex (): com.bitwig.extension.controller.api.SettableIntegerValue
  An integer value that defines the location of the cursor that this bank is following.
• getItemAt (index:int): ItemType
  Gets the item in the bank at the supplied index.
• getSizeOfBank (): int
  The fixed size of this bank.
• itemCount (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the underlying total item count (not the number of items available in the bank window).

BeatTimeFormatter

The following methods have been added to the BeatTimeFormatter class in API version 2.

• formatBeatTime (beatTime:double, isAbsolute:boolean, timeSignatureNumerator:int, timeSignatureDenominator:int, timeSignatureTicks:int): string
  Formats the supplied beat time as a string in the supplied time signature.

BeatTimeValue

The following methods have been added to the BeatTimeValue class in API version 2.

• getFormatted (formatter:com.bitwig.extension.controller.api.BeatTimeFormatter): string
  Gets the current beat time formatted according to the supplied formatter.
• getFormatted (): string
  Gets the current beat time formatted according to the default beat time formatter.

BooleanValue

The following methods have been added to the BooleanValue class in API version 2.

• get (): boolean
  Gets the current value.

BrowserColumn

The following methods have been added to the BrowserColumn class in API version 2.

• entryCount (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the underlying total count of column entries (not the size of the column window).

BrowserFilterColumn

The following methods have been added to the BrowserFilterColumn class in API version 2.

• name (): com.bitwig.extension.controller.api.StringValue
  Value that reports the name of the filter column.

BrowserFilterItem

The following methods have been added to the BrowserFilterItem class in API version 2.

• hitCount (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the hit count of the filter item.

BrowserItem

The following methods have been added to the BrowserItem class in API version 2.

• name (): com.bitwig.extension.controller.api.StringValue
  Value that reports the name of the browser item.

BrowsingSession

The following methods have been added to the BrowsingSession class in API version 2.

• hitCount (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the number of results available for the current filter settings.

Channel

The following methods have been added to the Channel class in API version 2.

• color (): com.bitwig.extension.controller.api.SettableColorValue
  Get the color of the channel.
• playingNotes (): com.bitwig.extension.controller.api.PlayingNoteArrayValue
  Returns an array of the playing notes.
• sendBank (): com.bitwig.extension.controller.api.SendBank
  Gets a SendBank that can be used to navigate the sends of this channel.

ChannelBank

The following methods have been added to the ChannelBank class in API version 2.

• canScrollChannelsDown (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the channel bank can be scrolled further down.
• canScrollChannelsUp (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the channel bank can be scrolled further down.
• channelCount (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the underlying total channel count (not the number of channels available in the bank window).
• channelScrollPosition (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the current scroll position, more specifically the position of the first channel within the underlying list of channels, that is shown as channel zero within the bank.

Clip

The following methods have been added to the Clip class in API version 2.

• canScrollKeysDown (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the note grid keys can be scrolled further down.
• canScrollKeysUp (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the note grid keys can be scrolled further up.
• canScrollStepsBackwards (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the note grid if the note grid steps can be scrolled backwards.
• canScrollStepsForwards (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the note grid if the note grid steps can be scrolled forwards.
• color (): com.bitwig.extension.controller.api.SettableColorValue
  Get the color of the clip.
• playingStep (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports note grid cells as they get played by the sequencer.

ClipLauncherSlot

The following methods have been added to the ClipLauncherSlot class in API version 2.

• browseToInsertClip (): void
  Starts browsing for content that can be inserted in this slot in Bitwig Studio's popup browser.
• color (): com.bitwig.extension.controller.api.SettableColorValue
  Value that reports the color of this slot.
• hasContent (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether this slot has content or not.
• isPlaybackQueued (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether this slot is queued for playback or not.
• isPlaying (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether this slot is playing or not.
• isRecording (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether this slot is recording or not.
• isRecordingQueued (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether this slot is queued for recording or not.
• isSelected (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether this slot is selected or not.
• isStopQueued (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports whether this slot is queued for recording or not.

ClipLauncherSlotOrScene

The following methods have been added to the ClipLauncherSlotOrScene class in API version 2.

• name (): com.bitwig.extension.controller.api.StringValue
  Returns an object that provides access to the name of the scene.
• sceneIndex (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the position of the scene within the list of Bitwig Studio scenes.

ColorValue

The following methods have been added to the ColorValue class in API version 2.

• blue (): float
  Gets the blue component of the current value.
• green (): float
  Gets the green component of the current value.
• red (): float
  Gets the red component of the current value.

ControllerHost

The following methods have been added to the ControllerHost class in API version 2.

• createBeatTimeFormatter (separator:string, barsLen:int, beatsLen:int, subdivisionLen:int, ticksLen:int): com.bitwig.extension.controller.api.BeatTimeFormatter
  Creates a BeatTimeFormatter that can be used to format beat times.
• createPopupBrowser (): com.bitwig.extension.controller.api.PopupBrowser
  Creates a PopupBrowser that represents the pop-up browser in Bitwig Studio.
• defaultBeatTimeFormatter (): com.bitwig.extension.controller.api.BeatTimeFormatter
  BeatTimeFormatter used to format beat times by default.
• requestFlush (): void
  Requests that the driver's flush method gets called.
• scheduleTask (callback:java.lang.Runnable, delay:long): void
  Schedules the given callback function for execution after the given delay.
• setDefaultBeatTimeFormatter (formatter:com.bitwig.extension.controller.api.BeatTimeFormatter): void
  Sets the BeatTimeFormatter to use by default for formatting beat times.

CueMarker

The following methods have been added to the CueMarker class in API version 2.

• getColor (): com.bitwig.extension.controller.api.ColorValue
  Gets a representation of the marker color.
• getName (): com.bitwig.extension.controller.api.StringValue
  Gets a representation of the marker name.
• launch (quantized:boolean): void
  Launches playback at the marker position.

CueMarkerBank

The following methods have been added to the CueMarkerBank class in API version 2.

• scrollToMarker (position:int): void
  Scrolls the cue marker bank window so that the marker at the given position becomes visible.

Cursor

The following methods have been added to the Cursor class in API version 2.

• hasNext (): com.bitwig.extension.controller.api.BooleanValue
  Boolean value that reports whether there is an item after the current cursor position.
• hasPrevious (): com.bitwig.extension.controller.api.BooleanValue
  Boolean value that reports whether there is an item before the current cursor position.

CursorRemoteControlsPage

The following methods have been added to the CursorRemoteControlsPage class in API version 2.

• selectNextPage (shouldCycle:boolean): void
  Selects the next page.
• selectNextPageMatching (expression:string, shouldCycle:boolean): void
  Selects the next page that matches the given expression.
• selectPreviousPage (shouldCycle:boolean): void
  Selects the previous page.
• selectPreviousPageMatching (expression:string, shouldCycle:boolean): void
  Selects the previous page that matches the given expression.
• selectedPageIndex (): com.bitwig.extension.controller.api.SettableIntegerValue
  Value that reports the currently selected parameter page index.

CursorTrack

The following methods have been added to the CursorTrack class in API version 2.

• createCursorDevice (id:string, name:string, numSends:int, followMode:com.bitwig.extension.controller.api.CursorDeviceFollowMode): com.bitwig.extension.controller.api.PinnableCursorDevice
  Creates a CursorDevice for this cursor track that by default follows a device based on the supplied follow mode.
• selectFirstChild (): void
  Makes the cursor track point to the first child found with the track group that this cursor currently points to.

Device

The following methods have been added to the Device class in API version 2.

• browseToInsertAfterDevice (): void
  Starts browsing for content that can be inserted before this device in Bitwig Studio's popup browser.
• browseToInsertBeforeDevice (): void
  Starts browsing for content that can be inserted before this device in Bitwig Studio's popup browser.
• browseToReplaceDevice (): void
  Starts browsing for content that can replace this device in Bitwig Studio's popup browser.
• createCursorRemoteControlsPage (parameterCount:int): com.bitwig.extension.controller.api.CursorRemoteControlsPage
  Creates a cursor for the selected remote controls page in the device with the supplied number of parameters.
• createCursorRemoteControlsPage (name:string, parameterCount:int, filterExpression:string): com.bitwig.extension.controller.api.CursorRemoteControlsPage
  Creates a cursor for a remote controls page in the device with the supplied number of parameters.
• isEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if the device is enabled.
• isPlugin (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the device is a plugin.
• isRemoteControlsSectionVisible (): com.bitwig.extension.controller.api.SettableBooleanValue
  Returns an object that provides access to the visibility of the device remote controls section.
• name (): com.bitwig.extension.controller.api.StringValue
  Value that reports the name of the device.
• position (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the position of the device within the parent device chain.
• presetCategory (): com.bitwig.extension.controller.api.StringValue
  Value that reports the current preset category name.
• presetCreator (): com.bitwig.extension.controller.api.StringValue
  Value that reports the current preset creator name.
• presetName (): com.bitwig.extension.controller.api.StringValue
  Value that reports the last loaded preset name.
• sampleName (): com.bitwig.extension.controller.api.StringValue
  Value that reports the file name of the currently loaded sample, in case the device is a sample container device.
• slotNames (): com.bitwig.extension.controller.api.StringArrayValue
  Value of the list of available FX slots in this device.

DeviceBank

The following methods have been added to the DeviceBank class in API version 2.

• browseToInsertDevice (index:int): void
  Browses for content to insert a device at the given index inside this bank.

DeviceChain

The following methods have been added to the DeviceChain class in API version 2.

• browseToInsertAtEndOfChain (): void
  Starts browsing for content that can be inserted at the end of this device chain.
• browseToInsertAtStartOfChain (): void
  Starts browsing for content that can be inserted at the start of this device chain.
• name (): com.bitwig.extension.controller.api.SettableStringValue
  Value that reports the name of the device chain, such as the track name or the drum pad name.

DoubleValue

The following methods have been added to the DoubleValue class in API version 2.

• get (): double
  Gets the current value.

EnumValue

The following methods have been added to the EnumValue class in API version 2.

• get (): string
  Gets the current value.

GenericBrowsingSession

The following methods have been added to the GenericBrowsingSession class in API version 2.

• name (): com.bitwig.extension.controller.api.StringValue
  Value that reports the name of the browsing session.

Host

The following methods have been added to the Host class in API version 2.

• setErrorReportingEMail (address:string): void
  Sets an email address to use for reporting errors found in this script.

IntegerValue

The following methods have been added to the IntegerValue class in API version 2.

• get (): int
  Gets the current value.

MidiOut

The following methods have been added to the MidiOut class in API version 2.

• sendSysex (data:byte[]): void
  Sends a MIDI SysEx message to the hardware device.
• sendSysexBytes (data:byte[]): void
  Sends a MIDI SysEx message to the hardware device.

ModulationSource

The following methods have been added to the ModulationSource class in API version 2.

• isMapped (): com.bitwig.extension.controller.api.BooleanValue
  Value which reports if the modulation source is mapped to any destination(s).
• isMapping (): com.bitwig.extension.controller.api.BooleanValue
  Value which reports when the modulation source is in mapping mode.
• name (): com.bitwig.extension.controller.api.StringValue
  Value the reports the name of the modulation source.

ObjectArrayValue

The following methods have been added to the ObjectArrayValue class in API version 2.

• get (): ObjectType[]
  
• get (index:int): ObjectType
  

Parameter

The following methods have been added to the Parameter class in API version 2.

• modulatedValue (): com.bitwig.extension.controller.api.RangedValue
  Gets the modulated value of this parameter.
• name (): com.bitwig.extension.controller.api.StringValue
  The name of the parameter.
• value (): com.bitwig.extension.controller.api.SettableRangedValue
  Gets the current value of this parameter.

ParameterBank

The following methods have been added to the ParameterBank class in API version 2.

• getParameter (indexInBank:int): com.bitwig.extension.controller.api.Parameter
  Returns the parameter at the given index within the bank.
• getParameterCount (): int
  Gets the number of slots that these remote controls have.

PinnableCursor

The following methods have been added to the PinnableCursor class in API version 2.

• isPinned (): com.bitwig.extension.controller.api.SettableBooleanValue
  Determines if this cursor is currently pinned or not.

PlayingNote

The following methods have been added to the PlayingNote class in API version 2.

• pitch (): int
  
• velocity (): int
  

PopupBrowser

The following methods have been added to the PopupBrowser class in API version 2.

• canAudition (): com.bitwig.extension.controller.api.BooleanValue
  Value that indicates if the browser is able to audition material in place while browsing.
• cancel (): void
  Cancels the popup browser.
• categoryColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The category column of the browser.
• commit (): void
  Commits the selected item in the popup browser.
• contentTypeNames (): com.bitwig.extension.controller.api.StringArrayValue
  Value that reports the possible content types that can be inserted by the popup browser.
• creatorColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The creator column of the browser.
• deviceColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The device column of the browser.
• deviceTypeColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The device type column of the browser.
• fileTypeColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The file type column of the browser.
• locationColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The location column of the browser.
• resultsColumn (): com.bitwig.extension.controller.api.BrowserResultsColumn
  Column that represents the results of the search.
• selectFirstFile (): void
  Selects the first file.
• selectLastFile (): void
  Selects the last file.
• selectNextFile (): void
  Selects the next file.
• selectPreviousFile (): void
  Selects the previous file.
• selectedContentTypeIndex (): com.bitwig.extension.controller.api.SettableIntegerValue
  Value that represents the index of the selected content type within the content types supported.
• selectedContentTypeName (): com.bitwig.extension.controller.api.StringValue
  Value that represents the selected content type.
• shouldAudition (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that decides if the browser is currently auditioning material in place while browsing or not.
• smartCollectionColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The smart collections column of the browser.
• tagColumn (): com.bitwig.extension.controller.api.BrowserFilterColumn
  The tag column of the browser.
• title (): com.bitwig.extension.controller.api.StringValue
  The title of the popup browser.

RangedValue

The following methods have been added to the RangedValue class in API version 2.

• displayedValue (): com.bitwig.extension.controller.api.StringValue
  Value that represents a formatted text representation of the value whenever the value changes.
• get (): double
  The current value normalized between 0.
• getRaw (): double
  Gets the current value.

Scene

The following methods have been added to the Scene class in API version 2.

• clipCount (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the number of clips in the scene.
• name (): com.bitwig.extension.controller.api.SettableStringValue
  Returns an object that provides access to the name of the scene.

Scrollable

The following methods have been added to the Scrollable class in API version 2.

• canScrollBackwards (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if it is possible to scroll the bank backwards or not.
• canScrollForwards (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if it is possible to scroll the bank forwards or not.
• scrollBackwards (): void
  Scrolls forwards by one step.
• scrollForwards (): void
  Scrolls forwards by one step.
• scrollPageBackwards (): void
  Scrolls backwards by one page.
• scrollPageForwards (): void
  Scrolls forwards by one page.
• scrollPosition (): com.bitwig.extension.controller.api.SettableIntegerValue
  Value that reports the current scroll position.

Send

The following methods have been added to the Send class in API version 2.

• sendChannelColor (): com.bitwig.extension.controller.api.SettableColorValue
  Value that reports the color of the channel that this send sends to.

SettableColorValue

The following methods have been added to the SettableColorValue class in API version 2.

• set (red:float, green:float, blue:float): void
  Sets the internal value.

SettableRangedValue

The following methods have been added to the SettableRangedValue class in API version 2.

• inc (increment:double): void
  Increments or decrements the value by a normalized amount assuming the whole range of the value is 0 .
• set (value:double): void
  Sets the value in an absolute fashion as a value between 0 .

SettableStringArrayValue

The following methods have been added to the SettableStringArrayValue class in API version 2.

• set (value:String[]): void
  Sets the internal value.

StringArrayValue

The following methods have been added to the StringArrayValue class in API version 2.

• get (): String[]
  Gets the current value.

StringValue

The following methods have been added to the StringValue class in API version 2.

• get (): string
  Gets the current value.
• getLimited (maxLength:int): string
  Gets the current value and tries to intelligently limit it to the supplied length in the best way possible.

TimeSignatureValue

The following methods have been added to the TimeSignatureValue class in API version 2.

• get (): string
  Gets the current value.

Track

The following methods have been added to the Track class in API version 2.

• clipLauncherSlotBank (): com.bitwig.extension.controller.api.ClipLauncherSlotBank
  Returns an object that can be used to access the clip launcher slots of the track.
• isGroup (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the track may contain child tracks, which is the case for group tracks.
• isQueuedForStop (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if the clip launcher slots are queued for stop.
• isStopped (): com.bitwig.extension.controller.api.BooleanValue
  Value that reports if this track is currently stopped.
• position (): com.bitwig.extension.controller.api.IntegerValue
  Value that reports the position of the track within the list of Bitwig Studio tracks.
• trackType (): com.bitwig.extension.controller.api.StringValue
  Value that reports the track type.

TrackBank

The following methods have been added to the TrackBank class in API version 2.

• followCursorTrack (cursorTrack:com.bitwig.extension.controller.api.CursorTrack): void
  Causes this bank to follow the supplied cursor.
• sceneBank (): com.bitwig.extension.controller.api.SceneBank
  SceneBank that represents a view on the scenes in this TrackBank.

Transport

The following methods have been added to the Transport class in API version 2.

• automationWriteMode (): com.bitwig.extension.controller.api.SettableEnumValue
  Value that reports the current automation write mode.
• clipLauncherPostRecordingAction (): com.bitwig.extension.controller.api.SettableEnumValue
  Value that reports the current clip launcher post recording action.
• isArrangerAutomationWriteEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if automation write is currently enabled for the arranger.
• isArrangerLoopEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that indicates if the loop is currently active or not.
• isArrangerOverdubEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if overdubbing is enabled in Bitwig Studio.
• isArrangerRecordEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if the Bitwig Studio transport is recording.
• isAutomationOverrideActive (): com.bitwig.extension.controller.api.BooleanValue
  Value that indicates if automation override is currently on.
• isClipLauncherAutomationWriteEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if automation write is currently enabled on the clip launcher.
• isClipLauncherOverdubEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value reports if clip launcher overdubbing is enabled in Bitwig Studio.
• isMetronomeAudibleDuringPreRoll (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if the metronome is audible during pre-roll.
• isMetronomeEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if the metronome is enabled in Bitwig Studio.
• isMetronomeTickPlaybackEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if the metronome has tick playback enabled.
• isPlaying (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if the Bitwig Studio transport is playing.
• isPunchInEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if punch-in is enabled in the Bitwig Studio transport.
• isPunchOutEnabled (): com.bitwig.extension.controller.api.SettableBooleanValue
  Value that reports if punch-in is enabled in the Bitwig Studio transport.
• metronomeVolume (): com.bitwig.extension.controller.api.SettableRangedValue
  Value that reports the metronome volume.
• preRoll (): com.bitwig.extension.controller.api.SettableEnumValue
  Value that reports the current pre-roll setting.

Value

The following methods have been added to the Value class in API version 2.

• markInterested (): void
  Marks this value as being of interest to the driver.