JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
juce::OSCAddress Class Reference

An OSC address. More...

#include "juce_OSCAddress.h"

Public Member Functions

 OSCAddress (const String &address)
 Constructs a new OSCAddress from a String.
 
 OSCAddress (const char *address)
 Constructs a new OSCAddress from a C string.
 
bool operator== (const OSCAddress &other) const noexcept
 Compares two OSCAddress objects.
 
bool operator!= (const OSCAddress &other) const noexcept
 Compares two OSCAddress objects.
 
String toString () const noexcept
 Converts the OSCAddress to a String.
 

Friends

class OSCAddressPattern
 

Detailed Description

An OSC address.

This address always starts with a forward slash and has a format similar to an URL, with several address parts separated by slashes.

Only a subset of ASCII characters are allowed in OSC addresses; see OpenSoundControl 1.0 specification for details.

OSC addresses can be used to register ListenerWithOSCAddress objects to an OSCReceiver if you wish them to only listen to certain messages with matching OSC address patterns.

See also
OSCReceiver, OSCAddressPattern, OSCMessage

@tags{OSC}

Definition at line 47 of file juce_OSCAddress.h.

Constructor & Destructor Documentation

◆ OSCAddress() [1/2]

juce::OSCAddress::OSCAddress ( const String address)

Constructs a new OSCAddress from a String.

Exceptions
OSCFormatErrorif the string is not a valid OSC address.

Definition at line 319 of file juce_OSCAddress.cpp.

◆ OSCAddress() [2/2]

juce::OSCAddress::OSCAddress ( const char address)

Constructs a new OSCAddress from a C string.

Exceptions
OSCFormatErrorof the string is not a valid OSC address.

Definition at line 325 of file juce_OSCAddress.cpp.

Member Function Documentation

◆ operator!=()

bool juce::OSCAddress::operator!= ( const OSCAddress other) const
noexcept

Compares two OSCAddress objects.

Returns
false if they contain the same address, true otherwise.

Definition at line 337 of file juce_OSCAddress.cpp.

◆ operator==()

bool juce::OSCAddress::operator== ( const OSCAddress other) const
noexcept

Compares two OSCAddress objects.

Returns
true if they contain the same address, false otherwise.

Definition at line 332 of file juce_OSCAddress.cpp.

◆ toString()

String juce::OSCAddress::toString ( ) const
noexcept

Converts the OSCAddress to a String.

Note: Trailing slashes are always removed automatically.

Returns
a String object that represents the OSC address.

Definition at line 343 of file juce_OSCAddress.cpp.

Friends And Related Symbol Documentation

◆ OSCAddressPattern

friend class OSCAddressPattern
friend

Definition at line 82 of file juce_OSCAddress.h.


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