Control Surface API  2.2.2
Host Interface Reference
Inheritance diagram for Host:

Public Member Functions

int getHostApiVersion ()
 
String getHostVendor ()
 
String getHostProduct ()
 
String getHostVersion ()
 
PlatformType getPlatformType ()
 
void setErrorReportingEMail (String address)
 

Detailed Description

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

Definition at line 6 of file Host.java.

Member Function Documentation

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
String getHostProduct ( )

Returns the product name of the host application.

Returns
the product name of the host application
Since
API version 1
String getHostVendor ( )

Returns the vendor of the host application.

Returns
the vendor of the host application
Since
API version 1
String getHostVersion ( )

Returns the version number of the host application.

Returns
the version number of the host application
Since
API version 1
PlatformType getPlatformType ( )

The platform type that this host is running on.

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: