Bitwig Studio Control Surface API
5.0.11
|
An interface representing the host application to the script. A singleton instance of this interface is available in the global scope of each script. The methods provided by this interface can be divided in different categories:
create...
3. functions for printing to the Control Surface Console, which can be opened from the View
menu of Bitwig Studio. 4. functions for determining the name of the host application, API version, the host operating system and such.The first group of methods should be called on the global scope of the script. The function in the second and third group are typically called from the init method of the script or other handler functions. The last group is probably only required in rare cases and can be called any time.
boolean addDatagramPacketObserver | ( | String | name, |
int | port, | ||
DataReceivedCallback | callback | ||
) |
Adds an observer for incoming UDP (User Datagram Protocol) packets on the selected port.
name | a meaningful name that describes the purpose of this observer. |
port | the port that should be used |
callback | the callback function that gets called when data arrives. The function receives a single parameter that contains the data byte array. |
void addDeviceNameBasedDiscoveryPair | ( | String[] | inputs, |
String[] | outputs | ||
) |
Registers patterns which are used to automatically detect hardware devices that can be used with the script.
When the user clicks on the detect
button in the Bitwig Studio controller preferences dialog, Bitwig Studio searches for connected controller hardware by comparing the parameters passed into this function are compared with the port names of the available MIDI drivers. Found controller scripts are automatically added with their input/output ports configured.
Calling this function is optional, but can also be called multiple times in the global script scope in order to support alternative driver names.
inputs | the array of strings used to detect MIDI input ports, must not be null . |
outputs | the array of strings used to detect MIDI output ports, must not be null . |
void connectToRemoteHost | ( | String | host, |
int | port, | ||
ConnectionEstablishedCallback | callback | ||
) |
Connects to a remote TCP (Transmission Control Protocol) socket.
host | the host name or IP address to connect to. |
port | the port to connect to |
callback | the callback function that gets called when the connection gets established. A single RemoteConnection parameter is passed into the callback function. |
AbsoluteHardwarControlBindable createAbsoluteHardwareControlAdjustmentTarget | ( | DoubleConsumer | adjustmentConsumer | ) |
Creates a AbsoluteHardwarControlBindable that can be used to adjust some value in an arbitrary way.
adjustmentConsumer | A consumer that will receive the absolute adjustment amount when bound to an AbsoluteHardwareControl. |
HardwareActionBindable createAction | ( | DoubleConsumer | actionPressureConsumer, |
Supplier< String > | descriptionProvider | ||
) |
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
actionPressureConsumer | Consumer that will be notified of the pressure of the action |
descriptionProvider | Provider that can provide a description of what the runnable does (used for showing onscreen feedback or help to the user). |
HardwareActionBindable createAction | ( | Runnable | runnable, |
Supplier< String > | descriptionProvider | ||
) |
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.
runnable | The runnable to be run |
descriptionProvider | Provider that can provide a description of what the runnable does (used for showing onscreen feedback or help to the user). |
DeviceMatcher createActiveDeviceMatcher | ( | ) |
Creates a DeviceMatcher that will only match devices that are currently active.
DeviceMatcher createAndDeviceMatcher | ( | DeviceMatcher... | deviceMatchers | ) |
Creates a DeviceMatcher that matches a device if all of the supplied matchers match the device.
Application createApplication | ( | ) |
Returns an object that provides access to general application functionality, including global view settings, the list of open projects, and other global settings that are not related to a certain document.
Application createApplicationSection | ( | ) |
Arranger createArranger | ( | ) |
Returns an object which provides access to the Arranger
panel of Bitwig Studio. Calling this function is equal to createArranger(-1)
.
Arranger createArranger | ( | final int | window | ) |
Returns an object which provides access to the Arranger
panel inside the specified window.
window | the index of the window where the arranger panel is shown, or -1 in case the first arranger panel found on any window should be taken |
Clip createArrangerCursorClip | ( | final int | gridWidth, |
final int | gridHeight | ||
) |
Returns a clip object that represents the cursor of the arranger clip selection. The gridWidth and gridHeight parameters specify the grid dimensions used to access the note content of the clip.
gridWidth | the number of steps spanned by one page of the note content grid. |
gridHeight | the number of keys spanned by one page of the note content grid. |
CursorTrack createArrangerCursorTrack | ( | final int | numSends, |
final int | numScenes | ||
) |
Returns an object that represents the cursor item of the arranger track selection.
numSends | the number of sends for bank-wise navigation of the sends that are associated with the track selection |
numScenes | the number of scenes for bank-wise navigation of the clip launcher slots that are associated with the track selection |
Arranger createArrangerSection | ( | final int | screenIndex | ) |
DeviceMatcher createAudioEffectMatcher | ( | ) |
Creates a DeviceMatcher that will match any audio effect.
BeatTimeFormatter createBeatTimeFormatter | ( | final String | separator, |
final int | barsLen, | ||
final int | beatsLen, | ||
final int | subdivisionLen, | ||
final int | ticksLen | ||
) |
Creates a BeatTimeFormatter that can be used to format beat times.
separator | the character used to separate the segments of the formatted beat time, typically ":", "." or "-" |
barsLen | the number of digits reserved for bars |
beatsLen | the number of digits reserved for beats |
subdivisionLen | the number of digits reserved for beat subdivisions |
ticksLen | the number of digits reserved for ticks |
DeviceMatcher createBitwigDeviceMatcher | ( | UUID | id | ) |
Creates a DeviceMatcher that will match any Bitwig native device with the supplied id.
default HardwareActionBindable createCallbackAction | ( | final Runnable | runnable, |
final Supplier< String > | descriptionProvider | ||
) |
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.
This is exactly the same as createAction(Runnable, Supplier) but does not use parameter overloading so can be used from non type safe languages like JavaScript.
runnable | The runnable to be run |
descriptionProvider | Provider that can provide a description of what the runnable does (used for showing onscreen feedback or help to the user). |
Clip createCursorClip | ( | final int | gridWidth, |
final int | gridHeight | ||
) |
Clip createCursorClipSection | ( | final int | gridWidth, |
final int | gridHeight | ||
) |
CursorDevice createCursorDevice | ( | ) |
CursorDevice createCursorDeviceSection | ( | final int | numControllers | ) |
CursorTrack createCursorTrack | ( | final int | numSends, |
final int | numScenes | ||
) |
CursorTrack createCursorTrack | ( | final String | id, |
String | name, | ||
final int | numSends, | ||
final int | numScenes, | ||
boolean | shouldFollowSelection | ||
) |
Returns an object that represents a named cursor track, that is independent from the arranger or mixer track selection in the user interface of Bitwig Studio.
name | the name of the track cursor |
numSends | the number of sends for bank-wise navigation of the sends that are associated with the track selection |
numScenes | the number of scenes for bank-wise navigation of the clip launcher slots that are associated with the track selection |
CursorTrack createCursorTrack | ( | final String | name, |
final int | numSends, | ||
final int | numScenes | ||
) |
Returns an object that represents a named cursor track, that is independent from the arranger or mixer track selection in the user interface of Bitwig Studio.
name | the name of the track cursor |
numSends | the number of sends for bank-wise navigation of the sends that are associated with the track selection |
numScenes | the number of scenes for bank-wise navigation of the clip launcher slots that are associated with the track selection |
CursorTrack createCursorTrackSection | ( | final int | numSends, |
final int | numScenes | ||
) |
DetailEditor createDetailEditor | ( | ) |
Returns an object which provides access to the DetailEditor
panel of Bitwig Studio. Calling this function is equal to createDetailEditor(-1)
.
DetailEditor createDetailEditor | ( | final int | window | ) |
Returns an object which provides access to the DetailEditor
panel inside the specified window.
window | the index of the window where the detail editor panel is shown, or -1 in case the first detail editor panel found on any window should be taken |
CursorDevice createEditorCursorDevice | ( | ) |
Returns an object that represents the cursor device in devices selections made by the user in Bitwig Studio. Calling this method is equal to the following code:
To create a custom device selection that is not connected to the main device selection in the user interface, call cursorTrack.createCursorDevice(String name).
CursorDevice createEditorCursorDevice | ( | int | numSends | ) |
Returns an object that represents the cursor device in devices selections made by the user in Bitwig Studio. Calling this method is equal to the following code:
To create a custom device selection that is not connected to the main device selection in the user interface, call cursorTrack.createCursorDevice(String name).
numSends | the number of sends that are simultaneously accessible in nested channels. |
TrackBank createEffectTrackBank | ( | final int | numTracks, |
final int | numScenes | ||
) |
Returns a track bank with the given number of effect tracks and scenes. Only effect tracks are considered. For more information about track banks and the bank pattern
in general, see the documentation for createTrackBank.
numTracks | the number of tracks spanned by the track bank |
numScenes | the number of scenes spanned by the track bank |
TrackBank createEffectTrackBank | ( | final int | numTracks, |
final int | numSends, | ||
final int | numScenes | ||
) |
Returns a track bank with the given number of effect tracks, sends and scenes. Only effect tracks are considered. For more information about track banks and the bank pattern
in general, see the documentation for createTrackBank.
numTracks | the number of tracks spanned by the track bank |
numSends | the number of sends spanned by the track bank |
numScenes | the number of scenes spanned by the track bank |
TrackBank createEffectTrackBankSection | ( | final int | numTracks, |
final int | numScenes | ||
) |
DeviceMatcher createFirstDeviceInChainMatcher | ( | ) |
Creates a DeviceMatcher that will only match devices if it is the last device in the chain.
Groove createGroove | ( | ) |
Groove createGrooveSection | ( | ) |
HardwareSurface createHardwareSurface | ( | ) |
Creates a HardwareSurface that can contain hardware controls.
DeviceMatcher createInstrumentMatcher | ( | ) |
Creates a DeviceMatcher that will match any instrument.
DeviceMatcher createLastDeviceInChainMatcher | ( | ) |
Creates a DeviceMatcher that will only match devices if it is the last device in the chain.
Clip createLauncherCursorClip | ( | final int | gridWidth, |
final int | gridHeight | ||
) |
Returns a clip object that represents the cursor of the launcher clip selection. The gridWidth and gridHeight parameters specify the grid dimensions used to access the note content of the clip.
gridWidth | the number of steps spanned by one page of the note content grid. |
gridHeight | the number of keys spanned by one page of the note content grid. |
TrackBank createMainTrackBank | ( | final int | numTracks, |
final int | numSends, | ||
final int | numScenes | ||
) |
Returns a track bank with the given number of tracks, sends and scenes. Only audio tracks, instrument tracks and hybrid tracks are considered. For more information about track banks and the bank pattern
in general, see the documentation for createTrackBank.
numTracks | the number of tracks spanned by the track bank |
numSends | the number of sends spanned by the track bank |
numScenes | the number of scenes spanned by the track bank |
TrackBank createMainTrackBankSection | ( | final int | numTracks, |
final int | numSends, | ||
final int | numScenes | ||
) |
MasterTrack createMasterTrack | ( | final int | numScenes | ) |
Returns an object that represents the master track of the document.
numScenes | the number of scenes for bank-wise navigation of the master tracks clip launcher slots. |
Track createMasterTrackSection | ( | final int | numScenes | ) |
Mixer createMixer | ( | ) |
Mixer createMixer | ( | final int | window | ) |
Returns an object which provides access to the Mixer
panel inside the specified window. Calling this function is equal to createMixer(window, null)
.
window | the index of the window where the mixer panel is shown, or -1 in case the first mixer panel found on any window should be taken |
Mixer
object Mixer createMixer | ( | final String | panelLayout | ) |
Returns an object which provides access to the Mixer
panel that belongs to the specified panel layout. Calling this function is equal to createMixer(-1, panelLayout)
.
panelLayout | the name of the panel layout that contains the mixer panel, or null in case the selected panel layout in Bitwig Studio should be followed. Empty strings or invalid names are treated the same way as null . To receive the list of available panel layouts see Application#addPanelLayoutObserver. |
Mixer
object Mixer createMixer | ( | final String | panelLayout, |
final int | window | ||
) |
Returns an object which provides access to the Mixer
panel that matches the specified parameters.
panelLayout | the name of the panel layout that contains the mixer panel, or null in case the selected panel layout in Bitwig Studio should be followed. Empty strings or invalid names are treated the same way as null . To receive the list of available panel layouts see Application#addPanelLayoutObserver. |
window | the index of the window where the mixer panel is shown, or -1 in case the first mixer panel found on any window should be taken |
Mixer
object Mixer createMixerSection | ( | final String | perspective, |
final int | screenIndex | ||
) |
DeviceMatcher createNotDeviceMatcher | ( | DeviceMatcher | deviceMatcher | ) |
Creates a DeviceMatcher that matches a device if the supplied matcher does not match the device.
DeviceMatcher createNoteEffectMatcher | ( | ) |
Creates a DeviceMatcher that will match any note effect.
AbsoluteHardwareValueMatcher createOrAbsoluteHardwareValueMatcher | ( | AbsoluteHardwareValueMatcher | matcher1, |
AbsoluteHardwareValueMatcher | matcher2 | ||
) |
Creates a AbsoluteHardwareValueMatcher that is matched by either of the 2 supplied action matchers.
DeviceMatcher createOrDeviceMatcher | ( | DeviceMatcher... | deviceMatchers | ) |
Creates a DeviceMatcher that matches a device if any of the supplied matchers match the device.
HardwareActionMatcher createOrHardwareActionMatcher | ( | HardwareActionMatcher | matcher1, |
HardwareActionMatcher | matcher2 | ||
) |
Creates a HardwareActionMatcher that is matched by either of the 2 supplied action matchers.
RelativeHardwareValueMatcher createOrRelativeHardwareValueMatcher | ( | RelativeHardwareValueMatcher | matcher1, |
RelativeHardwareValueMatcher | matcher2 | ||
) |
Creates a RelativeHardwareValueMatcher that is matched by either of the 2 supplied action matchers.
PopupBrowser createPopupBrowser | ( | ) |
Creates a PopupBrowser that represents the pop-up browser in Bitwig Studio.
default HardwareActionBindable createPressureCallbackAction | ( | final DoubleConsumer | actionPressureConsumer, |
final Supplier< String > | descriptionProvider | ||
) |
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.
This is exactly the same as createAction(DoubleConsumer, Supplier) but does not use parameter overloading so can be used from non type safe languages like JavaScript.
actionPressureConsumer | Consumer that will be notified of the pressure of the action |
descriptionProvider | Provider that can provide a description of what the runnable does (used for showing onscreen feedback or help to the user). |
RelativeHardwarControlBindable createRelativeHardwareControlAdjustmentTarget | ( | DoubleConsumer | adjustmentConsumer | ) |
Creates a RelativeHardwarControlBindable that can be used to adjust some value in an arbitrary way.
adjustmentConsumer | A consumer that will receive the relative adjustment amount when bound to a RelativeHardwareControl. |
RelativeHardwarControlBindable createRelativeHardwareControlStepTarget | ( | HardwareActionBindable | stepForwardsAction, |
HardwareActionBindable | stepBackwardsAction | ||
) |
Creates a RelativeHardwarControlBindable that can be used to step forwards or backwards when a RelativeHardwareControl is adjusted. A step is defined by the RelativeHardwareControl#setStepSize(double).
stepForwardsAction | The action that should happen when stepping forwards |
stepBackwardsAction | The action that should happen when stepping backwards |
RemoteSocket createRemoteConnection | ( | String | name, |
int | defaultPort | ||
) |
Opens a TCP (Transmission Control Protocol) host socket for allowing network connections from other hardware and software.
name | a meaningful name that describes the purpose of this connection. |
defaultPort | the port that should be used for the connection. If the port is already in use, then another port will be used. Check RemoteSocket#getPort() on the returned object to be sure. |
SceneBank createSceneBank | ( | final int | numScenes | ) |
Returns a scene bank with the given number of scenes.
A scene bank can be seen as a fixed-size window onto the list of scenes in the current document, that can be scrolled in order to access different parts of the scene list. For example a scene bank configured for 8 scenes can show scene 1-8, 2-9, 3-10 and so on.
The idea behind the bank pattern
is that hardware typically is equipped with a fixed amount of channel strips or controls, for example consider a mixing console with 8 channels, but Bitwig Studio documents contain a dynamic list of scenes, most likely more scenes than the hardware can control simultaneously. The scene bank returned by this function provides a convenient interface for controlling which scenes are currently shown on the hardware.
numScenes | the number of scenes spanned by the track bank |
TrackBank createTrackBank | ( | final int | numTracks, |
final int | numSends, | ||
final int | numScenes | ||
) |
Returns a track bank with the given number of tracks, sends and scenes.
A track bank can be seen as a fixed-size window onto the list of tracks in the current document including their sends and scenes, that can be scrolled in order to access different parts of the track list. For example a track bank configured for 8 tracks can show track 1-8, 2-9, 3-10 and so on.
The idea behind the bank pattern
is that hardware typically is equipped with a fixed amount of channel strips or controls, for example consider a mixing console with 8 channels, but Bitwig Studio documents contain a dynamic list of tracks, most likely more tracks than the hardware can control simultaneously. The track bank returned by this function provides a convenient interface for controlling which tracks are currently shown on the hardware.
Creating a track bank using this method will consider all tracks in the document, including effect tracks and the master track. Use createMainTrackBank or createEffectTrackBank in case you are only interested in tracks of a certain kind.
numTracks | the number of tracks spanned by the track bank |
numSends | the number of sends spanned by the track bank |
numScenes | the number of scenes spanned by the track bank |
TrackBank createTrackBank | ( | final int | numTracks, |
final int | numSends, | ||
final int | numScenes, | ||
final boolean | hasFlatTrackList | ||
) |
Returns a track bank with the given number of child tracks, sends and scenes.
A track bank can be seen as a fixed-size window onto the list of tracks in the connected track group including their sends and scenes, that can be scrolled in order to access different parts of the track list. For example a track bank configured for 8 tracks can show track 1-8, 2-9, 3-10 and so on.
The idea behind the bank pattern
is that hardware typically is equipped with a fixed amount of channel strips or controls, for example consider a mixing console with 8 channels, but Bitwig Studio documents contain a dynamic list of tracks, most likely more tracks than the hardware can control simultaneously. The track bank returned by this function provides a convenient interface for controlling which tracks are currently shown on the hardware.
Creating a track bank using this method will consider all tracks in the document, including effect tracks and the master track. Use createMainTrackBank or createEffectTrackBank in case you are only interested in tracks of a certain kind.
numTracks | the number of child tracks spanned by the track bank |
numSends | the number of sends spanned by the track bank |
numScenes | the number of scenes spanned by the track bank |
hasFlatTrackList | specifies whether the track bank should operate on a flat list of all nested child tracks or only on the direct child tracks of the connected group track. |
TrackBank createTrackBankSection | ( | final int | numTracks, |
final int | numSends, | ||
final int | numScenes | ||
) |
Transport createTransport | ( | ) |
Returns an object for controlling and monitoring the elements of the Transport
section in Bitwig Studio. This function should be called once during initialization of the script if transport access is desired.
Transport
section in Bitwig Studio. Transport createTransportSection | ( | ) |
UserControlBank createUserControls | ( | final int | numControllers | ) |
Returns an object that is used to define a bank of custom user controls. These controls are available to the user for free controller assignments and are typically used when bank-wise navigation is inconvenient.
numControllers | the number of controls that are available for free assignments |
UserControlBank createUserControlsSection | ( | final int | numControllers | ) |
DeviceMatcher createVST2DeviceMatcher | ( | int | id | ) |
Creates a DeviceMatcher that will match any VST2 plug-in with the supplied id.
DeviceMatcher createVST3DeviceMatcher | ( | String | id | ) |
Creates a DeviceMatcher that will match any VST3 plug-in with the supplied id.
BeatTimeFormatter defaultBeatTimeFormatter | ( | ) |
BeatTimeFormatter used to format beat times by default. This will be used to format beat times when asking for a beat time in string format without providing any formatting options. For example by calling BeatTimeStringValue#get().
void defineController | ( | String | vendor, |
String | name, | ||
String | version, | ||
String | uuid | ||
) |
void defineController | ( | String | vendor, |
String | name, | ||
String | version, | ||
String | uuid, | ||
String | author | ||
) |
Registers a controller script with the given parameters. This function must be called once at the global scope of the script.
vendor | the name of the hardware vendor. Must not be null . |
name | the name of the controller script as listed in the user interface of Bitwig Studio. Must not be null . |
version | the version of the controller script. Must not be null . |
uuid | a universal unique identifier (UUID) string that is used to distinguish one script from another, for example 550e8400-e29b-11d4-a716-446655440000 . Must not be null . For generating random UUID strings several free web tools are available. |
author | the name of the script author |
void defineMidiPorts | ( | int | numInports, |
int | numOutports | ||
) |
Defines the number of MIDI ports for input and output that the device uses. This method should be called once in the global scope if the script is supposed to exchange MIDI messages with the device, or if the script adds entries to the MIDI input/output choosers in Bitwig Studio. After calling this method the individual port objects can be accessed using getMidiInPort(int index) and getMidiInPort(int index).
numInports | the number of input ports |
numOutports | the number of output ports |
void defineSysexDiscovery | ( | String | request, |
String | reply | ||
) |
void defineSysexIdentityReply | ( | String | reply | ) |
Registers the Identity Reply Universal SysEx
message (if any) that the MIDI device sends after receiving the Identity Request Universal SysEx
message (F0 7E 7F 06 01 F7
), as defined in the MIDI standard.
This function may be called at the global scope of the script, but is optional. Please note that this function is only applicable to scripts with one MIDI input and one MIDI output. Also note that not all MIDI hardware supports SysEx identity messages.
reply | the Identity Reply Universal SysEx message. Must not be null |
void deleteObjects | ( | DeleteableObject... | objects | ) |
It will delete multiple object within one undo step.
void deleteObjects | ( | String | undoName, |
DeleteableObject... | objects | ||
) |
It will delete multiple object within one undo step.
void errorln | ( | String | s | ) |
Prints the given string in the control surface console window using a text style that highlights the string as error. The console window can be opened in the view menu of Bitwig Studio.
s | the error string to be printed |
DocumentState getDocumentState | ( | ) |
Creates a document state object that can be used to insert settings into the Studio I/O Panel in Bitwig Studio.
MidiIn getMidiInPort | ( | int | index | ) |
Returns the MIDI input port with the given index.
index | the index of the MIDI input port, must be valid. |
MidiOut getMidiOutPort | ( | int | index | ) |
Returns the MIDI output port with the given index.
index | the index of the MIDI output port, must be valid. |
NotificationSettings getNotificationSettings | ( | ) |
Returns an object that is used to configure automatic notifications. Bitwig Studio supports automatic visual feedback from controllers that shows up as popup notifications. For example when the selected track or the current device preset was changed on the controller these notifications are shown, depending on your configuration.
Preferences getPreferences | ( | ) |
Creates a preferences object that can be used to insert settings into the Controller Preferences panel in Bitwig Studio.
Project getProject | ( | ) |
Returns an object for controlling various aspects of the currently selected project.
HardwareDevice hardwareDevice | ( | int | index | ) |
Gets the HardwareDevice at the specified index. This index corresponds to the index of the HardwareDeviceMatcher specified in the ControllerExtensionDefinition#listHardwareDevices(java.util.List)
void load | ( | String | path | ) |
Loads the script defined by the supplied path. This is only intended to be called from a controller script. It cannot be called from a Java controller extension.
void loadAPI | ( | int | version | ) |
Loads the supplied API version into the calling script. This is only intended to be called from a controller script. It cannot be called from a Java controller extension.
MidiExpressions 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.
boolean platformIsLinux | ( | ) |
Indicates if the host platform is Linux.
true
if the host platform is Linux, false
otherwise. boolean platformIsMac | ( | ) |
Indicates if the host platform is Apple Mac OS X.
true
if the host platform is Mac, false
otherwise. boolean platformIsWindows | ( | ) |
Indicates if the host platform is Windows.
true
if the host platform is Windows, false
otherwise. void println | ( | String | s | ) |
Prints the given string in the control surface console window. The console window can be opened in the view menu of Bitwig Studio.
s | the string to be printed |
void requestFlush | ( | ) |
Requests that the driver's flush method gets called.
void restart | ( | ) |
Restarts this controller.
void scheduleTask | ( | Object | callback, |
Object[] | args, | ||
long | delay | ||
) |
Schedules the given callback function for execution after the given delay. For timer applications call this method once initially and then from within the callback function.
callback | the callback function that will be called |
args | that array of arguments that gets passed into the callback function, may be null |
delay | the duration after which the callback function will be called in milliseconds |
void scheduleTask | ( | Runnable | callback, |
long | delay | ||
) |
Schedules the given callback function for execution after the given delay. For timer applications call this method once initially and then from within the callback function.
callback | the callback function that will be called |
delay | the duration after which the callback function will be called in milliseconds |
void sendDatagramPacket | ( | String | host, |
int | port, | ||
byte[] | data | ||
) |
Sends a UDP (User Datagram Protocol) packet with the given data to the specified host.
host | the destination host name or IP address |
port | the destination port |
data | the data to be send. When creating a numeric byte array in JavaScript, the byte values must be signed (in the range -128..127). |
void setDefaultBeatTimeFormatter | ( | BeatTimeFormatter | formatter | ) |
Sets the BeatTimeFormatter to use by default for formatting beat times.
void setShouldFailOnDeprecatedUse | ( | boolean | value | ) |
Sets whether the calling script should fail if it calls a deprecated method based on the API version that it requested. This is only intended to be called from a controller script. It cannot be called from a Java controller extension.
boolean shouldFailOnDeprecatedUse | ( | ) |
Determines whether the calling script should fail if it calls a deprecated method based on the API version that it requested.
void showPopupNotification | ( | String | text | ) |
Shows a temporary text overlay on top of the application GUI, that will fade-out after a short interval. If the overlay is already shown, it will get updated with the given text.
text | the text to be shown |
void useBetaApi | ( | ) |
Call this method to allow your script to use Beta APIs.
Beta APIs are still on development and might not be available in a future version of Bitwig Studio.
Turning this flag to true, will flag your extension as being a beta extension which might not work after updating Bitwig Studio.