Package com.bitwig.extension.api

Interface Host

All Known Subinterfaces:

ControllerHost

public interface Host

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

Method Summary

Modifier and Type	Method	Description
MemoryBlock	allocateMemoryBlock(int size)	Allocates some memory that will be automatically freed once the extension exits.
Bitmap	createBitmap(int width, int height, BitmapFormat format)	Creates an offscreen bitmap that the extension can use to render into.
FontOptions	createFontOptions()	Creates a new FontOptions.
int	getHostApiVersion()	Returns the latest supported API version of the host application.
String	getHostProduct()	Returns the product name of the host application.
String	getHostVendor()	Returns the vendor of the host application.
String	getHostVersion()	Returns the version number of the host application.
OscModule	getOscModule()	Gets the OpenSoundControl module.
PlatformType	getPlatformType()	The platform type that this host is running on.
FontFace	loadFontFace(String path)	Loads a font.
Image	loadPNG(String path)	Loads a PNG image.
Image	loadSVG(String path, double scale)	Loads a SVG image.
void	setErrorReportingEMail(String address)	Sets an email address to use for reporting errors found in this script.

Method Details

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

getHostVendor

String getHostVendor()

Returns the vendor of the host application.

Returns:

the vendor 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

getHostVersion

String getHostVersion()

Returns the version number of the host application.

Returns:

the version number of the host application

Since:

API version 1

getPlatformType

PlatformType getPlatformType()

The platform type that this host is running on.

setErrorReportingEMail

void setErrorReportingEMail(String address)

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

Since:

API version 2

getOscModule

OscModule getOscModule()

Gets the OpenSoundControl module.

Since:

API version 5

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

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

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

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