Bitwig Studio Control Surface API  5.0.11
InputPipe Interface Reference
+ Inheritance diagram for InputPipe:

Public Member Functions

void readAsync (MemoryBlock data, AsyncTransferCompledCallback callback, int timeoutInMs)
 
int read (MemoryBlock data, int timeoutInMs)
 

Detailed Description

A pipe that can be used to read data.

Since
API version 7

Member Function Documentation

◆ read()

int read ( MemoryBlock  data,
int  timeoutInMs 
)

Requests to read some data from this pipe in a synchronous way (the caller is blocked until the transfer completes).

Returns
The number of bytes that was read.
Parameters
timeoutInMsA timeout in milliseconds that will result in an error and termination of the controller if the read does not happen in this time. For inifinite timeout use 0.

◆ readAsync()

void readAsync ( MemoryBlock  data,
AsyncTransferCompledCallback  callback,
int  timeoutInMs 
)

Requests to read some data from this pipe in an asynchronous way (the caller is not blocked). Once some data has been read the callback will be notified on the controller's thread.

Parameters
dataA MemoryBlock that can receive the data that is read.
callbackA callback that is notified on the controller's thread when the read has completed.
timeoutInMsA timeout in milliseconds that will result in an error and termination of the controller if the read does not happen in this time. For inifnite timeout use 0.

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