All Classes and Interfaces
Class
Description
Something that can be bound to an
AbsoluteHardwareControl and can respond to the user input (such
as user moving a slider up or down) in a meaningful way.Represents a hardware control that can input and absolute value (for example, a slider, knob or foot
pedal).
Represents a binding from an
AbsoluteHardwareControl to some target.Represents a physical hardware knob that inputs an absolute value.
Defines a means of recognizing when an absolute value is input by the user (for example, when moving a
slider or turning a knob based on some MIDI message).
Instances of this interface represent actions in Bitwig Studio, such as commands that can be launched from
the main menu or via keyboard shortcuts.
Instances of this interface are used to categorize actions in Bitwig Studio.
An interface that provides methods for accessing the most common global application commands.
Proxy to an arpeggiator component.
An interface representing various commands which can be performed on the Bitwig Studio arranger.
Callback that is notified when an asynchronous transfer has completed.
Opaque type used to match audio I/O devices.
A bank provides access to a range of items in Bitwig Studio.
Defines a formatter for a beat time that can convert a beat time to a string for display to the user.
Instances of this interface represent beat time values.
Represents a bitmap image which can be painted via
Bitmap.render(Renderer).Deprecated.
Represents an output value shown on some hardware (for example, if an LED is on or off).
Deprecated.
Use
PopupBrowser instead.Instances of this interface are used to navigate a column in the Bitwig Studio browser.
Instances of this interface are used to navigate a filter column in the Bitwig Studio browser.
Deprecated.
Use
PopupBrowser instead.Instances of this interface represent entries in a browser filter column.
Instances of this interface are used to navigate a filter column in the Bitwig Studio browser.
Instances of this interface represent entries in a browser filter column.
Instances of this interface are used to navigate a column in the Bitwig Studio browser.
Instances of this interface are used to navigate a results column in the Bitwig Studio browser.
Instances of this interface represent entries in a browser results column.
Instances of this interface are used to navigate the results column in the Bitwig Studio browser.
Deprecated.
Use
PopupBrowser instead.Instances of this interface are used to navigate the available sessions in Bitwig Studio's contextual
browser.
This interface represents a chain selector device which can be:
- instrument selector
- effect selector
This interface defines access to the common attributes and operations of channels, such as tracks or nested
device channels.
A channel bank provides access to a range of channels in Bitwig Studio, such as tracks or device layers.
An interface that provides access to the contents of a clip in Bitwig Studio.
Deprecated.
Use
PopupBrowser instead.Instances of this interface represent a scrollable fixed-size window that is connected to a section of the
clip launcher slots for a specific track.
An abstract interface that represents the clip launcher scenes or slots of a single track.
This class represents an RGBA color with each component being stored as double.
Represents an output value shown on some hardware (for example, the color of a light).
Represents a hardware control that can input a relative or absolute value (for example, a slider, knob,
relative encoder...).
Defines a means of recognizing when a continuous value is input by the user (for example, when moving a
slider or turning a knob based on some MIDI message).
Defines an extension that enabled a controller to work with Bitwig Studio.
Defines an extension that enabled a controller to work with Bitwig Studio.
An interface representing the host application to the script.
This interface defines access to the common attributes and operations of cue markers.
A cue marker bank provides access to a range of cue markers in Bitwig Studio.
A generic interface that provides the foundation for working with selections.
Instances of this interface are used to navigate the filter columns of a Bitwig Studio browsing session.
Instances of this interface represent entries in a browser filter column.
Instances of this interface represent entries in a browser filter column.
Instances of this interface represent entries in a browser column.
Instances of this interface are used for navigating the various browsing sessions of Bitwig Studio's
contextual browser.
A special kind of channel that follows a channel selection cursor in Bitwig Studio.
Represents a cursor clip.
A special kind of selection cursor used for devices.
Mode that defines how a
CursorDevice follows a device within the CursorTrack it is created
for by default.Instances of this interface represent the cursor item in device layer selections.
Instances of this interface represent the selected device slot as shown in the Bitwig Studio user
interface.
Instances of this interface represent the cursor item of track selections.
Represents a cursor that looks at a
RemoteControlsPage.Instances of this interface represent the cursor item of track selections.
Interface implemented by objects that can be deleted from the project.
An interface representing various commands which can be performed on the Bitwig Studio detail editor.
To receive an instance of the application interface call
To receive an instance of the application interface call
ControllerHost.createDetailEditor().This interface represents a device in Bitwig Studio, both internal devices and plugins.
This interface is used for navigation of device chains in Bitwig Studio.
Deprecated.
Use
PopupBrowser instead.The foundation of all interfaces that contain devices, such as tracks, device layers, drum pads or FX
slots.
Instances of this interface represent device layers in Bitwig Studio.
Devices layers are features of special Bitwig Studio devices, more specifically the Layer Instrument and
Layer FX devices, and are also shown as sub-channels in the mixer panel.
Something that can be used to match a certain device.
Instances of this interface represent nested FX slots in devices.
This interface is used to configure observation of pretty-printed device parameter values.
This interface is used to save custom script settings inside Bitwig Studio documents.
Instances of this interface represent double values.
Instances of this interface are special kind of channel objects that represent the pads of a drum machine
instrument.
Drum pads are features of special Bitwig Studio devices (currently only the Bitwig Drum Machine
instrument), and are also shown as sub-channels in the mixer panel.
Defines an enumeration.
Defines a single value from an enum.
Base class for defining any kind of extension for Bitwig Studio.
Information about the dimensions of a font.
Represents a Font.
Configure the font rendering options.
Deprecated.
Use
PopupBrowser instead.This class represents a linear gradient.
Provides 2D vector drawing API very similar to cairo graphics.
An interface representing the global groove settings of the project.
An action that can happen on a hardware control.
Something that can be bound to a hardware action (such as user pressing a button).
Represents a binding from a hardware action (such as user pressing a button) to some target action.
Defines a means of recognizing when a
HardwareAction happens based on some hardware input.An object that can be a target in a
HardwareBinding.Represents a binding from some hardware input to a target.
Represents the source of a
HardwareBinding.Represents a binding from some hardware input to a ranged value.
A
HardwareBinding that has some sensitivity setting.Represents a physical hardware button on a controller
Some kind of physical control on a piece of hardware (such as a knob, button, slider etc).
Represents a hardware device that the user has chosen to communicate with.
Matcher that can match a particular hardware device that is connected to the user's machine.
Defines a list of all the hardware devices that a controller needs.
Represents some physical hardware element.
Defines a means of recognizing when some kind of hardware input happens.
Defines a hardware light.
Defines the visual state of a hardware light so that it can be visualized in Bitwig Studio's user
interface.
Represents a physical hardware element that displays some output to the user.
Defines a physical pixel display on the controller.
Represents a value that needs to be displayed somehow on the hardware.
Represents a physical hardware button on a controller
Represents a surface that can contain
HardwareElements such as HardwareButtons,
HardwareSliders, MultiStateHardwareLights etcRepresents a display on some hardware that shows one or more lines of text.
Represents a line of text on a
HardwareTextDisplay.Defines the interface through which an extension can talk to the host application.
Represents an abstract image type.
A pipe that can be used to read data.
Defines an insertion point where various objects can be inserted as if the user had dragged and dropped
them to this insertion point (e.g with the mouse).
Represents an output value shown on some hardware.
Defines the current state of a
MultiStateHardwareLight.Deprecated.
Macros no longer exist as built in features of all devices.
Controls the project's master recording.
A special kind of track that represents the master track in Bitwig Studio.
Defines a block of memory.
This represents a 2D gradient.
Creates useful MIDI expressions that can be used to match MIDI events.
Instances of this interface are used to setup handler functions for incoming MIDI messages from a specific
MIDI hardware.
Instances of this interface are used to send MIDI messages to a specific MIDI hardware.
An interface used to access various commands that can be performed on the Bitwig Studio mixer panel.
To get an instance of the mixer interface call
To get an instance of the mixer interface call
ControllerHost.createMixer().This interface represents a modulation source in Bitwig Studio.
Deprecated.
Use
PopupBrowser instead.Represents a physical hardware light on a controller.
Deprecated.
Use
PopupBrowser instead.Instances of this interface implement note input functionality used for recording notes in Bitwig Studio
and for playing the instruments in tracks on hardware keyboards.
An enum defining the note expressions available in Bitwig Studio, used for the expression parameter of
NoteInput.assignPolyphonicAftertouchToExpression(int, com.bitwig.extension.controller.api.NoteInput.NoteExpression, int).Creates a proxy object to the NoteInput's NoteLatch component.
Note Operator Condition
Object that describes the content of a step at a given position: x for the time, and y for the key.
Bitwig Studio supports automatic visual feedback from controllers that shows up as popup notifications.
Represents an output value shown on some hardware.
Interface for an object that acts as a proxy for the actual object in Bitwig Studio (for example a track, a
device etc).
Defines a simple hardware light that only has an on and off state.
An OSC address space.
An OSC Bundle.
This interface lets you send OscMessage through an connection which can be via Tcp, Udp, or whatever.
An OSC message.
Interface to create Osc related object.
Base class for OscPackets.
A pipe that can be used to write data.
Instances of this interface represent ranged parameters that can be controlled with automation in Bitwig
Studio.
Defines a bank of parameters.
Represents a Path
Abstract class for patterns (gradient, mesh gradient, ...)
Represents a physical piano keyboard on a
HardwareSurface.Interface that defines a cursor that can be "pinned".
Cursor clip that can act independently from the user's clip selection if desired by being pinned in the
controller settings panel.
Cursor that can be pinned to the current device or follow the selection.
A pipe represents a communication channel with some other hardware device or network service.
Object that represents the popup browser in Bitwig Studio.
This interface is used to store custom controller settings into the Bitwig Studio preferences.
Deprecated.
Use
PopupBrowser instead.Deprecated.
This is now replaced by creating a named
CursorDevice.Deprecated.
Deprecated.
An interface for representing the current project.
Instances of this interface represent numeric values that have an upper and lower limit.
Something that can be bound to an
RelativeHardwareControl and can respond to the user input (such
as user turning an encoder left or right) in a meaningful way.Represents a hardware control that can input a relative value (for example, a relative encoder knob).
Represents a binding from a
RelativeHardwareControl to some target.Represents a binding from an
RelativeHardwareControl to a SettableRangedValueRepresents a physical hardware knob that inputs a relative value.
Defines a means of recognizing when a relative value is input by the user (for example, when turning a continuous knob).
Defines a relative position of something to something else.
Instances of this interface are reported to the supplied script callback when connecting to a remote TCP
socket via
ControllerHost.connectToRemoteHost(java.lang.String, int, com.bitwig.extension.callback.ConnectionEstablishedCallback).Represents a remote control in Bitwig Studio.
Represents a page of remote controls in a device.
Instances of this interface represent a TCP socket that other network clients can connect to, typically
created by calling
ControllerHost.createRemoteConnection(java.lang.String, int).This class is a renderer.
Deprecated.
Use
PopupBrowser instead.Instances of this interface represent scenes in Bitwig Studio.
A scene bank provides access to a range of scenes in Bitwig Studio.
Interface for something that can be scrolled.
Interface providing detailed access to a specific scrollbar.
Instances of this interface represent boolean values.
Instances of this interface represent enumeration values.
Instances of this interface represent integer values.
Instances of this interface represent numeric values that have an upper and lower limit.
Instances of this interface implement the
Value interface for string values.A common base interface for labeled and categorized settings.
This interface builds the foundation for storing custom settings in Bitwig Studio documents or in the
Bitwig Studio preferences.
A generic interface used to implement actions or events that are not associated with a value.
Instances of this interface represent the state of a solo button.
Instance of this class represent sources selectors in Bitwig Studio, which are shown as choosers in the
user interface and contain entries for either note inputs or audio inputs or both.
Interface that can be used to access the parameter and output value of a specific Bitwig native device.
Interface that can be used to directly access a specific device (Bitwig native device or plug-in).
Interface that can be used to access the parameters of a specific plug-in device.
Represents an output value shown on some hardware (for example, the title of a track).
Interface for an object that can be 'subscribed' or not.
Represent the size required to display some text.
Shared functions between `Arranger` and `DetailEditor`
Instances of this interface represent time signature values.
Instances of this interface represent tracks in Bitwig Studio.
A track bank provides access to a range of tracks and their scenes (clip launcher slots) in Bitwig Studio.
An interface representing the transport section in Bitwig Studio.
Defines a USB device that is available for communication.
Defines information needed to identify suitable USB devices for use by an extension.
Defines a pipe for talking to an endpoint on a USB device.
Status of an USB transfer.
Instances of this interface represent a bank of custom controls that can be manually learned to device
parameters by the user.
The common interface that is shared by all value objects in the controller API.
PopupBrowserinstead.