Package com.bitwig.extension.api.opensoundcontrol

Interface OscAddressSpace

public interface OscAddressSpace

An OSC address space. It contains the root OscContainer.

Since:

API version 5

Method Summary

Modifier and Type	Method	Description
void	registerDefaultMethod(OscMethodCallback callback)	This method will be called if no registered OscMethod could handle incoming OscPacket.
void	registerMethod(String address, String typeTagPattern, String desc, OscMethodCallback callback)	Low level way to register an Osc Method.
void	registerObjectMethods(String addressPrefix, Object object)	Register all the methods annotated with OscMethod object.
void	setName(String name)	This gives a display name for this address space.
void	setShouldLogMessages(boolean shouldLogMessages)	Should the address spaces log the messages it dispatches? Default is false.

Method Details

registerObjectMethods

void registerObjectMethods(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.

Throws:

OscInvalidArgumentTypeException

registerMethod

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

Low level way to register an Osc Method.

Parameters:

address - The address to register the method at

typeTagPattern - The globing pattern used to match the type tag. Pass "*" to match anything.

desc - The method description.

callback - The OSC Method call handler.

registerDefaultMethod

void registerDefaultMethod(OscMethodCallback callback)

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

setShouldLogMessages

void setShouldLogMessages(boolean shouldLogMessages)

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

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.