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

Public Member Functions

int getHostApiVersion ()
 
String getHostVendor ()
 
String getHostProduct ()
 
String getHostVersion ()
 
PlatformType getPlatformType ()
 
void setErrorReportingEMail (String address)
 
OscModule getOscModule ()
 
MemoryBlock allocateMemoryBlock (int size)
 
Bitmap createBitmap (int width, int height, BitmapFormat format)
 
FontFace loadFontFace (String path)
 
FontOptions createFontOptions ()
 
Image loadPNG (String path)
 
Image loadSVG (String path, double scale)
 

Detailed Description

Defines the interface through which an extension can talk to the host application.

Member Function Documentation

◆ allocateMemoryBlock()

MemoryBlock allocateMemoryBlock ( int  size)

Allocates some memory that will be automatically freed once the extension exits.

Since
API version 7

◆ createBitmap()

Bitmap createBitmap ( int  width,
int  height,
BitmapFormat  format 
)

Creates an offscreen bitmap that the extension can use to render into. The memory used by this bitmap is guaranteed to be freed once this extension exits.

Since
API version 7

◆ createFontOptions()

FontOptions createFontOptions ( )

Creates a new FontOptions. This object is used to configure how the GraphicOutput will display text. The memory used by this object is guaranteed to be freed once this extension exits.

Since
API version 7

◆ getHostApiVersion()

int getHostApiVersion ( )

Returns the latest supported API version of the host application.

Returns
the latest supported API version of the host application
Since
API version 1

◆ getHostProduct()

String getHostProduct ( )

Returns the product name of the host application.

Returns
the product name of the host application
Since
API version 1

◆ getHostVendor()

String getHostVendor ( )

Returns the vendor of the host application.

Returns
the vendor of the host application
Since
API version 1

◆ getHostVersion()

String getHostVersion ( )

Returns the version number of the host application.

Returns
the version number of the host application
Since
API version 1

◆ getOscModule()

OscModule getOscModule ( )

Gets the OpenSoundControl module.

Since
API version 5

◆ getPlatformType()

PlatformType getPlatformType ( )

The platform type that this host is running on.

◆ loadFontFace()

FontFace loadFontFace ( String  path)

Loads a font. The memory used by this font is guaranteed to be freed once this extension exits.

Since
API version 7

◆ loadPNG()

Image loadPNG ( String  path)

Loads a PNG image. The memory used by this image is guaranteed to be freed once this extension exits.

Since
API version 7

◆ loadSVG()

Image loadSVG ( String  path,
double  scale 
)

Loads a SVG image. The memory used by this image is guaranteed to be freed once this extension exits.

Since
API version 7

◆ setErrorReportingEMail()

void setErrorReportingEMail ( String  address)

Sets an email address to use for reporting errors found in this script.

Since
API version 2

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