An Open Sound Control library for the mbed, created to be compatible with Recotana's OSCClass library (http://recotana.com) for the Arduino with Ethernet shield. It also uses parts of the OSC Transceiver(Sender/Receiver) code by xshige written by: Alvaro Cassinelli, October 2011 tweaked by: Toby Harris / *spark audio-visual, March 2012
Dependencies: NetServices mbed
Diff: mbedOSC.h
- Revision:
- 6:bdcd499c3ed4
- Parent:
- 5:247b80b139d3
- Child:
- 7:090b23c0a504
diff -r 247b80b139d3 -r bdcd499c3ed4 mbedOSC.h --- a/mbedOSC.h Sun Apr 15 12:59:19 2012 +0000 +++ b/mbedOSC.h Sun Apr 15 13:00:53 2012 +0000 @@ -96,12 +96,12 @@ /** Gets the TopAddress string of the OSC message (this is just the address with index 0) - param[in] None +@param[in] None return pointer of the TopAddress string (char *), i.e. address[0] Example: In the case "/ard/test", getTopAddress() = "/ard" (WITH the slash "/") *//* Gets the TopAddress string of the OSC message (this is just the address with index 0) - param[in] None +@param[in] None return pointer of the TopAddress string (char *), i.e. address[0] Example: In the case "/ard/test", getTopAddress() = "/ard" (WITH the slash "/") */ @@ -109,7 +109,7 @@ /** Gets the "SubAddress" string of the OSC message (this is just the address with index 1) - param[in] None +@param[in] None return pointer of the SubAddress string (char *), i.e. address[1] Example: in the case "/ard/test", getSubAddress() = "/test" (WITH the slash "/") */ @@ -117,7 +117,7 @@ /** Gets the number of the OSC message address - param[in] None +@param[in] None return number of the OSC message address (byte) Examples: "/ard" --> the number of the addresses is 1 "/ard/test" --> the number of the addresses is 2 @@ -127,7 +127,7 @@ /** Gets the TypeTag string (with index) of the OSC message - param[in] <--_index is the index of the TypeTag string (byte) +@param[in] <--_index is the index of the TypeTag string (byte) return: TypeTag char (char) Example: in the case of a total typetag string equal to "if", getTypeTag(0) = 'i' and getTypeTag(1) = 'f' Attention: MAX_ARG is maximum number of the args, if the index argument is larger, it will be constrained to this max. @@ -137,7 +137,7 @@ /** Gets the number of the OSC message args - param[in] None +@param[in] None return number of the args (byte) Example: "i" 123 --> number of the OSC message args is 1 "if" 123 54.24 --> number of the OSC message args is 2 @@ -147,7 +147,7 @@ /** Get the args of the OSC message with an integer value - param[in] <--_index is (an int, or uint8_t), corresponding to the index of the args (byte) +@param[in] <--_index is (an int, or uint8_t), corresponding to the index of the args (byte) return: integer value (long, or int32_t) Example: in the case "if" 123 54.24, getArgInt(0) = 123 Noe: "i" is integer, but the return type is "long" @@ -157,7 +157,7 @@ /** Get the args of the OSC message with a float value - param[in] <--_index is the index of the args +@param[in] <--_index is the index of the args return: float value (double) note: In this case "if" 123 54.24, getArgFloat(1) = 54.24 attention: arg declared as float, but return value cast as "double" @@ -168,7 +168,7 @@ /** Set TopAddress string of OSC Message - param[in] _address is a string pointer for the TopAddress String (char *). NOTE: is this a good idea? why not pass as const, and do allocation here? +@param[in] _address is a string pointer for the TopAddress String (char *). NOTE: is this a good idea? why not pass as const, and do allocation here? return: None Example: if the complete address string is "/ard/test", we set the topaddress as follows: char top[]="/ard" (allocation done here!), then setTopAddress(top) */ @@ -176,7 +176,7 @@ /** Set SubAddress string of the OSC Message - param[in] _address is a string pointer for the SubAddress String (char *) +@param[in] _address is a string pointer for the SubAddress String (char *) return: None Example: if the complete address string is "/ard/test", we set the subaddress as follows: char sub[]="/test" (allocation done here!), then setSubAddress(sub) Attention: we should call first setTopAddress, and then setSubAddress. The order is important. This does not seems like a good idea... @@ -185,7 +185,7 @@ /** Set the complete Address string of the OSC Message (top and sub addresses) - param[in] _topAddress and _subAddress are the string pointers to top and sub addresses (char *) +@param[in] _topAddress and _subAddress are the string pointers to top and sub addresses (char *) return: None Example: in the case "/ard/test", we need to do: char top[]="/ard", char sub[]="/test", and then setAddress(top,sub) Reminder: in this implementation, the maximum number of addresses is MAX_ADDRESS=2 @@ -203,7 +203,7 @@ /** Set IP Address of the OSC Message (for SENDING messages - for receiving this will be done when receiving something ) - param[in] _ip pointer of IP Address array (byte *) +@param[in] _ip pointer of IP Address array (byte *) Example: IP=192.168.0.99, then we have to do: ip[]={192,168,0,1}, then setIp(ip) */ void setIp( uint8_t *_ip ); //set ip @@ -284,14 +284,14 @@ /** This initializes the OSC communication object with default receiving port (DEFAULT_REC_PORT) - param[in]: None +@param[in]: None return: None */ void begin(); /** Initialize an OSC object with arbitrary listening port - param[in] _recievePort, is the listening ("receiving") Port No (unsigned int) +@param[in] _recievePort, is the listening ("receiving") Port No (unsigned int) return: None */ void begin(uint16_t _recievePort); @@ -306,7 +306,7 @@ /** Set a OSC receive message container - param[in] _mes Pointer to the OSC receive message container (OSCMessage *) +@param[in] _mes Pointer to the OSC receive message container (OSCMessage *) return None */ void setReceiveMessage( OSCMessage *_mes ); //set receive OSCmessage container (note: the message has a "host" object from which we get the upd packets) @@ -323,7 +323,7 @@ /** Send an OSC Message (message contain the host ip and port where the message data has to be sent) - param[in] _mes Pointer to the OSC message container (OSCMessage *) +@param[in] _mes Pointer to the OSC message container (OSCMessage *) return None */ void sendOsc( OSCMessage *_mes ); //set&send OSCmessage (note: it will be sent to the host defined in the message container)