Bitwig Studio Control Surface API  5.0.11
OscAddressSpace Interface Reference

Public Member Functions

void registerObjectMethods (final String addressPrefix, Object object) throws OscInvalidArgumentTypeException
 
void registerMethod (String address, String typeTagPattern, String desc, OscMethodCallback callback)
 
void registerDefaultMethod (OscMethodCallback callback)
 
void setShouldLogMessages (boolean shouldLogMessages)
 
void setName (String name)
 

Detailed Description

An OSC address space.

It contains the root OscContainer.

Since
API version 5

Member Function Documentation

◆ registerDefaultMethod()

void registerDefaultMethod ( OscMethodCallback  callback)

This method will be called if no registered OscMethod could handle incoming OscPacket.

◆ registerMethod()

void registerMethod ( String  address,
String  typeTagPattern,
String  desc,
OscMethodCallback  callback 
)

Low level way to register an Osc Method.

Parameters
addressThe address to register the method at
typeTagPatternThe globing pattern used to match the type tag. Pass "*" to match anything.
descThe method description.
callbackThe OSC Method call handler.

◆ registerObjectMethods()

void registerObjectMethods ( final String  addressPrefix,
Object  object 
) throws OscInvalidArgumentTypeException

Register all the methods annotated with OscMethod object. Also, if a method is annotated with OscNode, this method will be called and the returned object's method will be registered.

◆ setName()

void setName ( String  name)

This gives a display name for this address space. It is useful if you have multiple address space to identify them when we generate the documentation.

◆ setShouldLogMessages()

void setShouldLogMessages ( boolean  shouldLogMessages)

Should the address spaces log the messages it dispatches? Default is false.


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