juce::OSCArgument Class Reference

An OSC argument. More...

#include "juce_OSCArgument.h"

Public Member Functions
	OSCArgument (int32 value)
	Constructs an OSCArgument with type int32 and a given value.
	OSCArgument (float value)
	Constructs an OSCArgument with type float32 and a given value.
	OSCArgument (const String &value)
	Constructs an OSCArgument with type string and a given value.
	OSCArgument (MemoryBlock blob)
	Constructs an OSCArgument with type blob and copies dataSize bytes from the memory pointed to by data into the blob.
	OSCArgument (OSCColour colour)
	Constructs an OSCArgument with type colour and a given colour value.
OSCType	getType () const noexcept
	Returns the type of the OSCArgument as an OSCType.
bool	isInt32 () const noexcept
	Returns whether the type of the OSCArgument is int32.
bool	isFloat32 () const noexcept
	Returns whether the type of the OSCArgument is float.
bool	isString () const noexcept
	Returns whether the type of the OSCArgument is string.
bool	isBlob () const noexcept
	Returns whether the type of the OSCArgument is blob.
bool	isColour () const noexcept
	Returns whether the type of the OSCArgument is colour.
int32	getInt32 () const noexcept
	Returns the value of the OSCArgument as an int32.
float	getFloat32 () const noexcept
	Returns the value of the OSCArgument as a float32.
String	getString () const noexcept
	Returns the value of the OSCArgument as a string.
const MemoryBlock &	getBlob () const noexcept
	Returns the binary data contained in the blob and owned by the OSCArgument, as a reference to a JUCE MemoryBlock object.
OSCColour	getColour () const noexcept
	Returns the value of the OSCArgument as an OSCColour.

Detailed Description

An OSC argument.

An OSC argument is a value of one of the following types: int32, float32, string, or blob (raw binary data).

OSCMessage objects are essentially arrays of OSCArgument objects.

@tags{OSC}

Definition at line 40 of file juce_OSCArgument.h.

Constructor & Destructor Documentation

OSCArgument() [1/5]

juce::OSCArgument::OSCArgument

(

int32

value

)

Constructs an OSCArgument with type int32 and a given value.

Definition at line 29 of file juce_OSCArgument.cpp.

OSCArgument() [2/5]

juce::OSCArgument::OSCArgument

(

float

value

)

Constructs an OSCArgument with type float32 and a given value.

Definition at line 30 of file juce_OSCArgument.cpp.

OSCArgument() [3/5]

juce::OSCArgument::OSCArgument

(

const String &

value

)

Constructs an OSCArgument with type string and a given value.

Definition at line 31 of file juce_OSCArgument.cpp.

OSCArgument() [4/5]

juce::OSCArgument::OSCArgument

(

MemoryBlock

blob

)

Constructs an OSCArgument with type blob and copies dataSize bytes from the memory pointed to by data into the blob.

The data owned by the blob will be released when the OSCArgument object gets destructed.

Definition at line 32 of file juce_OSCArgument.cpp.

OSCArgument() [5/5]

juce::OSCArgument::OSCArgument

(

OSCColour

colour

)

Constructs an OSCArgument with type colour and a given colour value.

Definition at line 33 of file juce_OSCArgument.cpp.

Member Function Documentation

getBlob()

const MemoryBlock & juce::OSCArgument::getBlob ( ) const

noexcept

Returns the binary data contained in the blob and owned by the OSCArgument, as a reference to a JUCE MemoryBlock object.

If the type of the OSCArgument is not blob, the behaviour is undefined.

Definition at line 63 of file juce_OSCArgument.cpp.

getColour()

OSCColour juce::OSCArgument::getColour ( ) const

noexcept

Returns the value of the OSCArgument as an OSCColour.

If the type of the OSCArgument is not a colour, the behaviour is undefined.

Definition at line 71 of file juce_OSCArgument.cpp.

getFloat32()

float juce::OSCArgument::getFloat32 ( ) const

noexcept

Returns the value of the OSCArgument as a float32.

If the type of the OSCArgument is not float32, the behaviour is undefined.

Definition at line 54 of file juce_OSCArgument.cpp.

getInt32()

int32 juce::OSCArgument::getInt32 ( ) const

noexcept

Returns the value of the OSCArgument as an int32.

If the type of the OSCArgument is not int32, the behaviour is undefined.

Definition at line 45 of file juce_OSCArgument.cpp.

getString()

String juce::OSCArgument::getString ( ) const

noexcept

Returns the value of the OSCArgument as a string.

If the type of the OSCArgument is not string, the behaviour is undefined.

Definition at line 36 of file juce_OSCArgument.cpp.

getType()

OSCType juce::OSCArgument::getType ( ) const

noexcept

Returns the type of the OSCArgument as an OSCType.

OSCType is a char type, and its value will be the OSC type tag of the type.

Definition at line 66 of file juce_OSCArgument.h.

isBlob()

bool juce::OSCArgument::isBlob ( ) const

noexcept

Returns whether the type of the OSCArgument is blob.

Definition at line 78 of file juce_OSCArgument.h.

isColour()

bool juce::OSCArgument::isColour ( ) const

noexcept

Returns whether the type of the OSCArgument is colour.

Definition at line 81 of file juce_OSCArgument.h.

isFloat32()

bool juce::OSCArgument::isFloat32 ( ) const

noexcept

Returns whether the type of the OSCArgument is float.

Definition at line 72 of file juce_OSCArgument.h.

isInt32()

bool juce::OSCArgument::isInt32 ( ) const

noexcept

Returns whether the type of the OSCArgument is int32.

Definition at line 69 of file juce_OSCArgument.h.

isString()

bool juce::OSCArgument::isString ( ) const

noexcept

Returns whether the type of the OSCArgument is string.

Definition at line 75 of file juce_OSCArgument.h.

---

The documentation for this class was generated from the following files:

• juce_osc/osc/juce_OSCArgument.h
• juce_osc/osc/juce_OSCArgument.cpp