Bitwig Studio Control Surface API  5.0.11
RemoteConnection Interface Reference

Public Member Functions

void disconnect ()
 
void setDisconnectCallback (NoArgsCallback callback)
 
void setReceiveCallback (DataReceivedCallback callback)
 
void send (byte[] data) throws IOException
 

Detailed Description

Instances of this interface are reported to the supplied script callback when connecting to a remote TCP socket via ControllerHost#connectToRemoteHost.

See also
ControllerHost#connectToRemoteHost
Since
API version 1

Member Function Documentation

◆ disconnect()

void disconnect ( )

Disconnects from the remote host.

Since
API version 1

◆ send()

void send ( byte[]  data) throws IOException

Sends data to the remote host.

Parameters
datathe byte array containing the data to be sent. When creating a numeric byte array in JavaScript, the byte values must be signed (in the range -128..127).
Exceptions
IOException
Since
API version 1

◆ setDisconnectCallback()

void setDisconnectCallback ( NoArgsCallback  callback)

Registers a callback function that gets called when the connection gets lost or disconnected.

Parameters
callbacka callback function that doesn't receive any parameters
Since
API version 1

◆ setReceiveCallback()

void setReceiveCallback ( DataReceivedCallback  callback)

Sets the callback used for receiving data.

The remote connection needs a header for each message sent to it containing a 32-bit big-endian integer saying how big the rest of the message is. The data delivered to the script will not include this header.

Parameters
callbacka callback function with the signature (byte[] data)
Since
API version 1

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