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:
- 5:247b80b139d3
- Parent:
- 4:f365c577b3c6
- Child:
- 6:bdcd499c3ed4
--- a/mbedOSC.h Sun Apr 15 12:55:04 2012 +0000 +++ b/mbedOSC.h Sun Apr 15 12:59:19 2012 +0000 @@ -83,7 +83,7 @@ /** Gets the address string of the OSC message * - * @param [in] <-- _index is the index of the address string (byte) + * @param [in] _index is the index of the address string (byte) * return pointer of the address string (char *) * @note ex. "/ard/test"<br> * getAddress(0) = "/ard"<br> @@ -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 @@ -291,7 +291,7 @@ /** 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);