ofDocsdocumentation addons ofxOsc ofxOscMessage

ofxOscMessage

editEdit

addBlobArg( ... )

void addBlobArg(const ofBuffer &argument)

add a binary blog

addBoolArg( ... )

void addBoolArg(bool argument)

add a bool true sends a OFXOSC_TYPE_TRUE & false sends a OFXOSC_TYPE_FALSE

addCharArg( ... )

void addCharArg(char argument)

add a char

addDoubleArg( ... )

void addDoubleArg(double argument)

add a 64-bit double

addFloatArg( ... )

void addFloatArg(float argument)

add a 32-bit float

addImpulseArg( )

void addImpulseArg()

add a trigger impulse (has no value) alias for addTriggerArg()

addInfinitumArg( )

void addInfinitumArg()

add a trigger impulse (has no value) alias for addTriggerArg()

addInt32Arg( ... )

void addInt32Arg(int32_t argument)

add a 32-bit integer

addInt64Arg( ... )

void addInt64Arg(int64_t argument)

add a 64-bit integer

addIntArg( ... )

void addIntArg(int32_t argument)

add a 32-bit integer

addMidiMessageArg( ... )

void addMidiMessageArg(uint32_t argument)

add a 4-byte MIDI message

addNoneArg( )

void addNoneArg()

add a none/nil (has no value)

addRgbaColorArg( ... )

void addRgbaColorArg(uint32_t argument)

add a 32-bit color

addStringArg( ... )

void addStringArg(const string &argument)

add a string

addSymbolArg( ... )

void addSymbolArg(const string &argument)

add a symbol (string)

addTimetagArg( ... )

void addTimetagArg(uint64_t argument)

add a 64-bit NTP time tag

addTriggerArg( )

void addTriggerArg()

add a trigger impulse (has no value)

clear( )

void clear()

clear this message

copy( ... )

ofxOscMessage & copy(const ofxOscMessage &other)

for operator= and copy constructor

getAddress( )

string getAddress()

\return the OSC address

getArgAsBlob( ... )

ofBuffer getArgAsBlob(size_t index)

Parameters:

index The index of the queried item. \return given argument as a binary blob

getArgAsBool( ... )

bool getArgAsBool(size_t index)

get argument as a bool, converts numeric types automatically this argument type matches both OFXOSC_TYPE_TRUE & OFXOSC_TYPE_FALSE

Parameters:

index The index of the queried item. \return given argument value as a bool

getArgAsChar( ... )

char getArgAsChar(size_t index)

get argument as a string, converts numeric types with a warning

Parameters:

index The index of the queried item. \return given argument value as a string

getArgAsDouble( ... )

double getArgAsDouble(size_t index)

get argument as a double, converts numeric types automatically

Parameters:

index The index of the queried item. \return given argument value as a double

getArgAsFloat( ... )

float getArgAsFloat(size_t index)

get argument as a float, converts numeric types automatically prints a warning when converting higher precision types

Parameters:

index The index of the queried item. \return given argument value as a float

getArgAsImpulse( ... )

bool getArgAsImpulse(size_t index)

get argument as a trigger impulse this is an alias for getArgAsTrigger()

Parameters:

index The index of the queried item. \return true if argument was a trigger

getArgAsInfinitum( ... )

bool getArgAsInfinitum(size_t index)

get argument as a trigger impulse this is an alias for getArgAsTrigger()

Parameters:

index The index of the queried item. \return true if argument was a trigger

getArgAsInt( ... )

int32_t getArgAsInt(size_t index)

get argument as an integer, converts numeric types automatically prints a warning when converting higher precision types

Parameters:

index The index of the queried item. \return given argument value as a 32-bit int

getArgAsInt32( ... )

int32_t getArgAsInt32(size_t index)

get argument as an integer, converts numeric types automatically prints a warning when converting higher precision types

Parameters:

index The index of the queried item. \return given argument value as a 32-bit int

getArgAsInt64( ... )

int64_t getArgAsInt64(size_t index)

get argument as a 64-bit integer, converts numeric types automatically \return given argument value as a 64-bit int

Parameters:

index The index of the queried item.

getArgAsMidiMessage( ... )

uint32_t getArgAsMidiMessage(size_t index)

Parameters:

index The index of the queried item. \return given argument value as a 4-byte midi message

getArgAsNone( ... )

bool getArgAsNone(size_t index)

get argument as a none/nil

Parameters:

index The index of the queried item. \return true if argument was a none/nil

getArgAsRgbaColor( ... )

uint32_t getArgAsRgbaColor(size_t index)

get an argument as an RGBA color, converts int32 automatically

Parameters:

index The index of the queried item. \return given argument as a 32-bit color value

getArgAsString( ... )

string getArgAsString(size_t index)

get argument as a string, converts numeric types with a warning

Parameters:

index The index of the queried item. \return given argument value as a string

getArgAsSymbol( ... )

string getArgAsSymbol(size_t index)

get argument as a symbol (string), converts numeric types with a warning

Parameters:

index The index of the queried item. \return given argument value as a symbol (string)

getArgAsTimetag( ... )

uint64_t getArgAsTimetag(size_t index)

Parameters:

index The index of the queried item. \return given argument as a 64-bit NTP time tag

getArgAsTrigger( ... )

bool getArgAsTrigger(size_t index)

get argument as a trigger impulse

Parameters:

index The index of the queried item. \return true if argument was a trigger

getArgType( ... )

ofxOscArgType getArgType(size_t index)

Parameters:

index The index of the queried item. \return argument type code for a given index

getArgTypeName( ... )

string getArgTypeName(size_t index)

Parameters:

index The index of the queried item. \return argument type tag char as a string

getNumArgs( )

size_t getNumArgs()

\return number of arguments

getRemoteHost( )

string getRemoteHost()

\return the remote host name/ip or "" if not set

getRemotePort( )

int getRemotePort()

\return the remote port or 0 if not set

getTypeString( )

string getTypeString()

Parameters:

index The index of the queried item. \return type tags for all arguments as a string, 1 char for each argument

ofxOscMessage( ... )

ofxOscMessage(const ofxOscMessage &other)

ofxOscMessage( )

ofxOscMessage()

operator=( ... )

ofxOscMessage & operator=(const ofxOscMessage &other)

setAddress( ... )

void setAddress(const string &address)

set the message address, must start with a /

setRemoteEndpoint( ... )

void setRemoteEndpoint(const string &host, int port)

set host and port of the remote endpoint, this is mainly used by ofxOscReceiver

~ofxOscMessage( )

~ofxOscMessage()