diff options
Diffstat (limited to 'libraries/oscP5/reference/oscP5/OscMessage.html')
| -rw-r--r-- | libraries/oscP5/reference/oscP5/OscMessage.html | 1447 |
1 files changed, 1447 insertions, 0 deletions
diff --git a/libraries/oscP5/reference/oscP5/OscMessage.html b/libraries/oscP5/reference/oscP5/OscMessage.html new file mode 100644 index 0000000..3bb21cb --- /dev/null +++ b/libraries/oscP5/reference/oscP5/OscMessage.html @@ -0,0 +1,1447 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_33) on Sun Dec 23 14:34:38 SGT 2012 --> +<TITLE> +OscMessage (Javadocs: oscP5) +</TITLE> + +<META NAME="date" CONTENT="2012-12-23"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OscMessage (Javadocs: oscP5)"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../oscP5/OscIn.html" title="class in oscP5"><B>PREV CLASS</B></A> + <A HREF="../oscP5/OscNetManager.html" title="class in oscP5"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html?oscP5/OscMessage.html" target="_top"><B>FRAMES</B></A> + <A HREF="OscMessage.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +oscP5</FONT> +<BR> +Class OscMessage</H2> +<PRE> +<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../resources/inherit.gif" ALT="extended by "><A HREF="../oscP5/OscPatcher.html" title="class in oscP5">oscP5.OscPatcher</A> + <IMG SRC="../resources/inherit.gif" ALT="extended by "><A HREF="../oscP5/OscPacket.html" title="class in oscP5">oscP5.OscPacket</A> + <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>oscP5.OscMessage</B> +</PRE> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../oscP5/OscIn.html" title="class in oscP5">OscIn</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>OscMessage</B><DT>extends <A HREF="../oscP5/OscPacket.html" title="class in oscP5">OscPacket</A></DL> +</PRE> + +<P> +An OSC message consists of an OSC Address Pattern, an OSC Type Tag String + and the OSC arguments. +<P> + +<P> +<DL> +<script type="text/javascript"> +<!-- +document.getElementsByTagName('html')[0].className = 'isjs';function toggle(dt) { var display, dd=dt; do{ dd = dd.nextSibling } while(dd.tagName!='DD'); toOpen =!dd.style.display;dd.style.display = toOpen? 'block':''; dt.getElementsByTagName('span')[0].innerHTML = toOpen? '-':'+' ; } +--> +</script> +<div id="test" class="toggleList"><dl><dt onclick="toggle(this);"><span>+</span>Example</dt><dd><pre>/** + * oscP5sendreceive by andreas schlegel + * example shows how to send and receive osc messages. + * oscP5 website at http://www.sojamo.de/oscP5 + */ + +import oscP5.*; +import netP5.*; + +OscP5 oscP5; +NetAddress myRemoteLocation; + +void setup() { + size(400,400); + frameRate(25); + /* start oscP5, listening for incoming messages at port 12000 */ + oscP5 = new OscP5(this,12000); + + /* myRemoteLocation is a NetAddress. a NetAddress takes 2 parameters, + * an ip address and a port number. myRemoteLocation is used as parameter in + * oscP5.send() when sending osc packets to another computer, device, + * application. usage see below. for testing purposes the listening port + * and the port of the remote location address are the same, hence you will + * send messages back to this sketch. + */ + myRemoteLocation = new NetAddress("127.0.0.1",12000); +} + + +void draw() { + background(0); +} + +void mousePressed() { + /* in the following different ways of creating osc messages are shown by example */ + OscMessage myMessage = new OscMessage("/test"); + + myMessage.add(123); /* add an int to the osc message */ + + /* send the message */ + oscP5.send(myMessage, myRemoteLocation); +} + + +/* incoming osc message are forwarded to the oscEvent method. */ +void oscEvent(OscMessage theOscMessage) { + /* print the address pattern and the typetag of the received OscMessage */ + print("### received an osc message."); + print(" addrpattern: "+theOscMessage.addrPattern()); + println(" typetag: "+theOscMessage.typetag()); +} +</pre></dd></dl></div></DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#OscMessage(int)">OscMessage</A></B>(int theAddrInt)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#OscMessage(int, java.lang.Object[])">OscMessage</A></B>(int theAddrPattern, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#OscMessage(oscP5.OscMessage)">OscMessage</A></B>(<A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> theOscMessage)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#OscMessage(java.lang.String)">OscMessage</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#OscMessage(java.lang.String, java.lang.Object[])">OscMessage</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add()">add</A></B>()</CODE> + +<BR> + add values to an osc message.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(boolean)">add</A></B>(boolean theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.Boolean)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(byte[])">add</A></B>(byte[] theArray)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(char)">add</A></B>(char theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(char[])">add</A></B>(char[] theArray)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.Character)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(double)">add</A></B>(double theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.Double)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(float)">add</A></B>(float theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.Float)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A> theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(float[])">add</A></B>(float[] theArray)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(int)">add</A></B>(int theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(int[])">add</A></B>(int[] theArray)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.Integer)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A> theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(int, int, int, int)">add</A></B>(int channel, + int status, + int value1, + int value2)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.Object[])">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArray)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.String)">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#add(java.lang.String[])">add</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] theArray)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#addArguments(java.lang.Object[])">addArguments</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</CODE> + +<BR> + add a list of arguments to an exisiting set of arguments.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#addrInt()">addrInt</A></B>()</CODE> + +<BR> + returns the address pattern of the osc message as int.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#addrPattern()">addrPattern</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#arguments()">arguments</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#checkAddrPattern(java.lang.String)">checkAddrPattern</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern)</CODE> + +<BR> + check if an address pattern equals a specific address pattern + you are looking for.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#checkTypetag(java.lang.String)">checkTypetag</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theTypeTag)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#clear()">clear</A></B>()</CODE> + +<BR> + clear and reset an OscMessage for reuse.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#clearArguments()">clearArguments</A></B>()</CODE> + +<BR> + clears the arguments in a message, + but keeps the address the address pattern.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../oscP5/OscArgument.html" title="class in oscP5">OscArgument</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#get(int)">get</A></B>(int theIndex)</CODE> + +<BR> + get a value at a specific position in the osc message.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#getAddrPatternAsBytes()">getAddrPatternAsBytes</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#getBytes()">getBytes</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#getTypetagAsBytes()">getTypetagAsBytes</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#isPlugged()">isPlugged</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#makeBlob(byte[])">makeBlob</A></B>(byte[] b)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#print()">print</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#printData()">printData</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#set(int, java.lang.Object)">set</A></B>(int theIndex, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> theObject)</CODE> + +<BR> + TODO + set should enable the programmer to set values + of an existing osc message.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#setAddrPattern(int)">setAddrPattern</A></B>(int theAddrPattern)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#setAddrPattern(java.lang.String)">setAddrPattern</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern)</CODE> + +<BR> + set the address pattern of an osc message.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#setArguments(java.lang.Object[])">setArguments</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</CODE> + +<BR> + set the arguments of the osc message using an object array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#timetag()">timetag</A></B>()</CODE> + +<BR> + get the timetag of an osc message.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#toString()">toString</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscMessage.html#typetag()">typetag</A></B>()</CODE> + +<BR> + returns the typetag of the osc message.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_oscP5.OscPacket"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class oscP5.<A HREF="../oscP5/OscPacket.html" title="class in oscP5">OscPacket</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../oscP5/OscPacket.html#address()">address</A>, <A HREF="../oscP5/OscPacket.html#netaddress()">netaddress</A>, <A HREF="../oscP5/OscPacket.html#netAddress()">netAddress</A>, <A HREF="../oscP5/OscPacket.html#port()">port</A>, <A HREF="../oscP5/OscPacket.html#tcpConnection()">tcpConnection</A></CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="OscMessage(oscP5.OscMessage)"><!-- --></A><H3> +OscMessage</H3> +<PRE> +public <B>OscMessage</B>(<A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> theOscMessage)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theOscMessage</CODE> - OscMessage</DL> +</DL> +<HR> + +<A NAME="OscMessage(java.lang.String)"><!-- --></A><H3> +OscMessage</H3> +<PRE> +public <B>OscMessage</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theAddrPattern</CODE> - String</DL> +</DL> +<HR> + +<A NAME="OscMessage(int)"><!-- --></A><H3> +OscMessage</H3> +<PRE> +public <B>OscMessage</B>(int theAddrInt)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theAddrInt</CODE> - int</DL> +</DL> +<HR> + +<A NAME="OscMessage(java.lang.String, java.lang.Object[])"><!-- --></A><H3> +OscMessage</H3> +<PRE> +public <B>OscMessage</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theAddrPattern</CODE> - String<DD><CODE>theArguments</CODE> - Object[]</DL> +</DL> +<HR> + +<A NAME="OscMessage(int, java.lang.Object[])"><!-- --></A><H3> +OscMessage</H3> +<PRE> +public <B>OscMessage</B>(int theAddrPattern, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>theAddrPattern</CODE> - int<DD><CODE>theArguments</CODE> - Object[]</DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="clear()"><!-- --></A><H3> +clear</H3> +<PRE> +public void <B>clear</B>()</PRE> +<DL> +<DD>clear and reset an OscMessage for reuse. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="clearArguments()"><!-- --></A><H3> +clearArguments</H3> +<PRE> +public void <B>clearArguments</B>()</PRE> +<DL> +<DD>clears the arguments in a message, + but keeps the address the address pattern. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="set(int, java.lang.Object)"><!-- --></A><H3> +set</H3> +<PRE> +public void <B>set</B>(int theIndex, + <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> theObject)</PRE> +<DL> +<DD>TODO + set should enable the programmer to set values + of an existing osc message. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="checkTypetag(java.lang.String)"><!-- --></A><H3> +checkTypetag</H3> +<PRE> +public boolean <B>checkTypetag</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theTypeTag)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theTypeTag</CODE> - String +<DT><B>Returns:</B><DD>boolean<script type="text/javascript"> +<!-- +document.getElementsByTagName('html')[0].className = 'isjs';function toggle(dt) { var display, dd=dt; do{ dd = dd.nextSibling } while(dd.tagName!='DD'); toOpen =!dd.style.display;dd.style.display = toOpen? 'block':''; dt.getElementsByTagName('span')[0].innerHTML = toOpen? '-':'+' ; } +--> +</script> +<div id="test" class="toggleList"><dl><dt onclick="toggle(this);"><span>+</span>Example</dt><dd><pre>/** + * oscP5parsing by andreas schlegel + * example shows how to parse incoming osc messages "by hand". + * it is recommended to take a look at oscP5plug for an + * alternative and more convenient way to parse messages. + * oscP5 website at http://www.sojamo.de/oscP5 + */ + +import oscP5.*; +import netP5.*; + +OscP5 oscP5; +NetAddress myRemoteLocation; + +void setup() { + size(400,400); + frameRate(25); + /* start oscP5, listening for incoming messages at port 12000 */ + oscP5 = new OscP5(this,12000); + + /* myRemoteLocation is a NetAddress. a NetAddress takes 2 parameters, + * an ip address and a port number. myRemoteLocation is used as parameter in + * oscP5.send() when sending osc packets to another computer, device, + * application. usage see below. for testing purposes the listening port + * and the port of the remote location address are the same, hence you will + * send messages back to this sketch. + */ + myRemoteLocation = new NetAddress("127.0.0.1",12000); +} + +void draw() { + background(0); +} + + +void mousePressed() { + /* create a new osc message object */ + OscMessage myMessage = new OscMessage("/test"); + + myMessage.add(123); /* add an int to the osc message */ + myMessage.add(12.34); /* add a float to the osc message */ + myMessage.add("some text"); /* add a string to the osc message */ + + /* send the message */ + oscP5.send(myMessage, myRemoteLocation); +} + + +void oscEvent(OscMessage theOscMessage) { + /* check if theOscMessage has the address pattern we are looking for. */ + + if(theOscMessage.checkAddrPattern("/test")==true) { + /* check if the typetag is the right one. */ + if(theOscMessage.checkTypetag("ifs")) { + /* parse theOscMessage and extract the values from the osc message arguments. */ + int firstValue = theOscMessage.get(0).intValue(); + float secondValue = theOscMessage.get(1).floatValue(); + String thirdValue = theOscMessage.get(2).stringValue(); + print("### received an osc message /test with typetag ifs."); + println(" values: "+firstValue+", "+secondValue+", "+thirdValue); + return; + } + } + println("### received an osc message. with address pattern "+theOscMessage.addrPattern()); +} +</pre></dd></dl></div></DL> +</DD> +</DL> +<HR> + +<A NAME="checkAddrPattern(java.lang.String)"><!-- --></A><H3> +checkAddrPattern</H3> +<PRE> +public boolean <B>checkAddrPattern</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern)</PRE> +<DL> +<DD>check if an address pattern equals a specific address pattern + you are looking for. this is usually used when parsing an osc message. + e.g. if(theOscMessage.checkAddrPattern("/test")==true) {...} +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theAddrPattern</CODE> - String +<DT><B>Returns:</B><DD>boolean<script type="text/javascript"> +<!-- +document.getElementsByTagName('html')[0].className = 'isjs';function toggle(dt) { var display, dd=dt; do{ dd = dd.nextSibling } while(dd.tagName!='DD'); toOpen =!dd.style.display;dd.style.display = toOpen? 'block':''; dt.getElementsByTagName('span')[0].innerHTML = toOpen? '-':'+' ; } +--> +</script> +<div id="test" class="toggleList"><dl><dt onclick="toggle(this);"><span>+</span>Example</dt><dd><pre>/** + * oscP5parsing by andreas schlegel + * example shows how to parse incoming osc messages "by hand". + * it is recommended to take a look at oscP5plug for an + * alternative and more convenient way to parse messages. + * oscP5 website at http://www.sojamo.de/oscP5 + */ + +import oscP5.*; +import netP5.*; + +OscP5 oscP5; +NetAddress myRemoteLocation; + +void setup() { + size(400,400); + frameRate(25); + /* start oscP5, listening for incoming messages at port 12000 */ + oscP5 = new OscP5(this,12000); + + /* myRemoteLocation is a NetAddress. a NetAddress takes 2 parameters, + * an ip address and a port number. myRemoteLocation is used as parameter in + * oscP5.send() when sending osc packets to another computer, device, + * application. usage see below. for testing purposes the listening port + * and the port of the remote location address are the same, hence you will + * send messages back to this sketch. + */ + myRemoteLocation = new NetAddress("127.0.0.1",12000); +} + +void draw() { + background(0); +} + + +void mousePressed() { + /* create a new osc message object */ + OscMessage myMessage = new OscMessage("/test"); + + myMessage.add(123); /* add an int to the osc message */ + myMessage.add(12.34); /* add a float to the osc message */ + myMessage.add("some text"); /* add a string to the osc message */ + + /* send the message */ + oscP5.send(myMessage, myRemoteLocation); +} + + +void oscEvent(OscMessage theOscMessage) { + /* check if theOscMessage has the address pattern we are looking for. */ + + if(theOscMessage.checkAddrPattern("/test")==true) { + /* check if the typetag is the right one. */ + if(theOscMessage.checkTypetag("ifs")) { + /* parse theOscMessage and extract the values from the osc message arguments. */ + int firstValue = theOscMessage.get(0).intValue(); + float secondValue = theOscMessage.get(1).floatValue(); + String thirdValue = theOscMessage.get(2).stringValue(); + print("### received an osc message /test with typetag ifs."); + println(" values: "+firstValue+", "+secondValue+", "+thirdValue); + return; + } + } + println("### received an osc message. with address pattern "+theOscMessage.addrPattern()); +} +</pre></dd></dl></div></DL> +</DD> +</DL> +<HR> + +<A NAME="setAddrPattern(java.lang.String)"><!-- --></A><H3> +setAddrPattern</H3> +<PRE> +public void <B>setAddrPattern</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theAddrPattern)</PRE> +<DL> +<DD>set the address pattern of an osc message. you can set + a string or an int as address pattern.tnt might be useful for + supercollider users. oscP5 does support ints and strings as + address patterns when sending and receiving messages. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theAddrPattern</CODE> - String</DL> +</DD> +</DL> +<HR> + +<A NAME="setAddrPattern(int)"><!-- --></A><H3> +setAddrPattern</H3> +<PRE> +public void <B>setAddrPattern</B>(int theAddrPattern)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theAddrPattern</CODE> - int</DL> +</DD> +</DL> +<HR> + +<A NAME="setArguments(java.lang.Object[])"><!-- --></A><H3> +setArguments</H3> +<PRE> +public void <B>setArguments</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</PRE> +<DL> +<DD>set the arguments of the osc message using an object array. + with version 0.9.4 the existing arguments are overwritten, + to add the arguments to the argument list, use addArguments(Object[]) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArguments</CODE> - Object[]</DL> +</DD> +</DL> +<HR> + +<A NAME="addArguments(java.lang.Object[])"><!-- --></A><H3> +addArguments</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>addArguments</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArguments)</PRE> +<DL> +<DD>add a list of arguments to an exisiting set of arguments. + to overwrite the existing argument list, use setArguments(Object[]) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArguments</CODE> - </DL> +</DD> +</DL> +<HR> + +<A NAME="addrPattern()"><!-- --></A><H3> +addrPattern</H3> +<PRE> +public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>addrPattern</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="addrInt()"><!-- --></A><H3> +addrInt</H3> +<PRE> +public int <B>addrInt</B>()</PRE> +<DL> +<DD>returns the address pattern of the osc message as int. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>int</DL> +</DD> +</DL> +<HR> + +<A NAME="typetag()"><!-- --></A><H3> +typetag</H3> +<PRE> +public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>typetag</B>()</PRE> +<DL> +<DD>returns the typetag of the osc message. e.g. the message contains + 3 floats then the typetag would be "fff" +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>String</DL> +</DD> +</DL> +<HR> + +<A NAME="timetag()"><!-- --></A><H3> +timetag</H3> +<PRE> +public long <B>timetag</B>()</PRE> +<DL> +<DD>get the timetag of an osc message. timetags are only sent by + osc bundles. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>long</DL> +</DD> +</DL> +<HR> + +<A NAME="arguments()"><!-- --></A><H3> +arguments</H3> +<PRE> +public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] <B>arguments</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>Object[]</DL> +</DD> +</DL> +<HR> + +<A NAME="getAddrPatternAsBytes()"><!-- --></A><H3> +getAddrPatternAsBytes</H3> +<PRE> +public byte[] <B>getAddrPatternAsBytes</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>byte[]</DL> +</DD> +</DL> +<HR> + +<A NAME="getTypetagAsBytes()"><!-- --></A><H3> +getTypetagAsBytes</H3> +<PRE> +public byte[] <B>getTypetagAsBytes</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>byte[]</DL> +</DD> +</DL> +<HR> + +<A NAME="getBytes()"><!-- --></A><H3> +getBytes</H3> +<PRE> +public byte[] <B>getBytes</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../oscP5/OscPacket.html#getBytes()">getBytes</A></CODE> in class <CODE><A HREF="../oscP5/OscPacket.html" title="class in oscP5">OscPacket</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>byte[]</DL> +</DD> +</DL> +<HR> + +<A NAME="add()"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>()</PRE> +<DL> +<DD>add values to an osc message. please check the + add documentation for specific information. +<P> +<DD><DL> +<script type="text/javascript"> +<!-- +document.getElementsByTagName('html')[0].className = 'isjs';function toggle(dt) { var display, dd=dt; do{ dd = dd.nextSibling } while(dd.tagName!='DD'); toOpen =!dd.style.display;dd.style.display = toOpen? 'block':''; dt.getElementsByTagName('span')[0].innerHTML = toOpen? '-':'+' ; } +--> +</script> +<div id="test" class="toggleList"><dl><dt onclick="toggle(this);"><span>+</span>Example</dt><dd><pre>/** + * oscP5message by andreas schlegel + * example shows how to create osc messages. + * oscP5 website at http://www.sojamo.de/oscP5 + */ + +import oscP5.*; +import netP5.*; + +OscP5 oscP5; +NetAddress myRemoteLocation; + +void setup() { + size(400,400); + frameRate(25); + /* start oscP5, listening for incoming messages at port 12000 */ + oscP5 = new OscP5(this,12000); + + /* myRemoteLocation is a NetAddress. a NetAddress takes 2 parameters, + * an ip address and a port number. myRemoteLocation is used as parameter in + * oscP5.send() when sending osc packets to another computer, device, + * application. usage see below. for testing purposes the listening port + * and the port of the remote location address are the same, hence you will + * send messages back to this sketch. + */ + myRemoteLocation = new NetAddress("127.0.0.1",12000); +} + + +void draw() { + background(0); +} + +void mousePressed() { + /* in the following different ways of creating osc messages are shown by example */ + OscMessage myMessage = new OscMessage("/test"); + + myMessage.add(123); /* add an int to the osc message */ + myMessage.add(12.34); /* add a float to the osc message */ + myMessage.add("some text"); /* add a string to the osc message */ + myMessage.add(new byte[] {0x00, 0x01, 0x10, 0x20}); /* add a byte blob to the osc message */ + myMessage.add(new int[] {1,2,3,4}); /* add an int array to the osc message */ + + /* send the message */ + oscP5.send(myMessage, myRemoteLocation); +} + + +/* incoming osc message are forwarded to the oscEvent method. */ +void oscEvent(OscMessage theOscMessage) { + /* print the address pattern and the typetag of the received OscMessage */ + print("### received an osc message."); + print(" addrpattern: "+theOscMessage.addrPattern()); + println(" typetag: "+theOscMessage.typetag()); +} +</pre></dd></dl></div></DL> +</DD> +</DL> +<HR> + +<A NAME="add(int)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(int theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - int</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.String)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - String</DL> +</DD> +</DL> +<HR> + +<A NAME="add(float)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(float theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - float</DL> +</DD> +</DL> +<HR> + +<A NAME="add(double)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(double theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - double</DL> +</DD> +</DL> +<HR> + +<A NAME="add(boolean)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(boolean theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - boolean</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.Boolean)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - Boolean</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.Integer)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A> theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - Integer</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.Float)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A> theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - Float</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.Double)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</A> theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - Double</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.Character)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - Character</DL> +</DD> +</DL> +<HR> + +<A NAME="add(char)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(char theValue)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theValue</CODE> - char</DL> +</DD> +</DL> +<HR> + +<A NAME="add(int, int, int, int)"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(int channel, + int status, + int value1, + int value2)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>channel</CODE> - int<DD><CODE>status</CODE> - int<DD><CODE>value1</CODE> - int<DD><CODE>value2</CODE> - int</DL> +</DD> +</DL> +<HR> + +<A NAME="add(int[])"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(int[] theArray)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArray</CODE> - int[]</DL> +</DD> +</DL> +<HR> + +<A NAME="add(char[])"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(char[] theArray)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArray</CODE> - char[]</DL> +</DD> +</DL> +<HR> + +<A NAME="add(float[])"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(float[] theArray)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArray</CODE> - float[]</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.String[])"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] theArray)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArray</CODE> - String[]</DL> +</DD> +</DL> +<HR> + +<A NAME="add(byte[])"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(byte[] theArray)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArray</CODE> - byte[]</DL> +</DD> +</DL> +<HR> + +<A NAME="add(java.lang.Object[])"><!-- --></A><H3> +add</H3> +<PRE> +public <A HREF="../oscP5/OscMessage.html" title="class in oscP5">OscMessage</A> <B>add</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] theArray)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theArray</CODE> - Object[]</DL> +</DD> +</DL> +<HR> + +<A NAME="makeBlob(byte[])"><!-- --></A><H3> +makeBlob</H3> +<PRE> +public static byte[] <B>makeBlob</B>(byte[] b)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>b</CODE> - byte[] +<DT><B>Returns:</B><DD>byte[]</DL> +</DD> +</DL> +<HR> + +<A NAME="get(int)"><!-- --></A><H3> +get</H3> +<PRE> +public <A HREF="../oscP5/OscArgument.html" title="class in oscP5">OscArgument</A> <B>get</B>(int theIndex)</PRE> +<DL> +<DD>get a value at a specific position in the osc message. the get method + returns an OscArgument from which the value can be parsed into the right + format. e.g. to parse an int from the first argument in the osc message, + use theOscMessage.get(0).intValue(); +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theIndex</CODE> - int +<DT><B>Returns:</B><DD>OscArgument</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>String</DL> +</DD> +</DL> +<HR> + +<A NAME="isPlugged()"><!-- --></A><H3> +isPlugged</H3> +<PRE> +public boolean <B>isPlugged</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="print()"><!-- --></A><H3> +print</H3> +<PRE> +public void <B>print</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="printData()"><!-- --></A><H3> +printData</H3> +<PRE> +public void <B>printData</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../oscP5/OscIn.html" title="class in oscP5"><B>PREV CLASS</B></A> + <A HREF="../oscP5/OscNetManager.html" title="class in oscP5"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../index.html?oscP5/OscMessage.html" target="_top"><B>FRAMES</B></A> + <A HREF="OscMessage.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +processing library oscP5 by Andreas Schlegel. (c) 2004-2012 +</BODY> +</HTML> |