diff options
Diffstat (limited to 'libraries/oscP5/reference/oscP5/OscProperties.html')
| -rw-r--r-- | libraries/oscP5/reference/oscP5/OscProperties.html | 799 |
1 files changed, 799 insertions, 0 deletions
diff --git a/libraries/oscP5/reference/oscP5/OscProperties.html b/libraries/oscP5/reference/oscP5/OscProperties.html new file mode 100644 index 0000000..21dc5d3 --- /dev/null +++ b/libraries/oscP5/reference/oscP5/OscProperties.html @@ -0,0 +1,799 @@ +<!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> +OscProperties (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="OscProperties (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/OscPlug.html" title="class in oscP5"><B>PREV CLASS</B></A> + <A HREF="../oscP5/OscStatus.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/OscProperties.html" target="_top"><B>FRAMES</B></A> + <A HREF="OscProperties.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <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 OscProperties</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 "><B>oscP5.OscProperties</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>OscProperties</B><DT>extends <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></DL> +</PRE> + +<P> +osc properties are used to start oscP5 with more specific settings. + osc properties have to be passed to oscP5 in the constructor when + starting a new instance of oscP5. +<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>/** + * oscP5properities by andreas schlegel + * example shows how to use osc properties. + * if you need more specific settings for your osc session, + * osc properties serves your needs. + * oscP5 website at http://www.sojamo.de/oscP5 + */ +import oscP5.*; +import netP5.*; + +OscP5 oscP5; + +void setup() { + size(400,400); + frameRate(25); + + /* create a new osc properties object */ + OscProperties properties = new OscProperties(); + + /* set a default NetAddress. sending osc messages with no NetAddress parameter + * in oscP5.send() will be sent to the default NetAddress. + */ + properties.setRemoteAddress("127.0.0.1",12000); + + /* the port number you are listening for incoming osc packets. */ + properties.setListeningPort(12000); + + + /* Send Receive Same Port is an option where the sending and receiving port are the same. + * this is sometimes necessary for example when sending osc packets to supercolider server. + * while both port numbers are the same, the receiver can simply send an osc packet back to + * the host and port the message came from. + */ + properties.setSRSP(OscProperties.ON); + + /* set the datagram byte buffer size. this can be useful when you send/receive + * huge amounts of data, but keep in mind, that UDP is limited to 64k + */ + properties.setDatagramSize(1024); + + /* initialize oscP5 with our osc properties */ + oscP5 = new OscP5(this,properties); + + /* print your osc properties */ + println(properties.toString()); +} + + + +void mousePressed() { + /* create a new osc message with address pattern /test */ + OscMessage myMessage = new OscMessage("/test"); + myMessage.add(200); + + /* send the osc message to the default netAddress, set in the OscProperties above.*/ + oscP5.send(myMessage); +} + + +void draw() { + background(0); +} + + + +/* 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> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_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>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#MULTICAST">MULTICAST</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#OFF">OFF</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#ON">ON</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#TCP">TCP</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#UDP">UDP</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== 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/OscProperties.html#OscProperties()">OscProperties</A></B>()</CODE> + +<BR> + create a new OscProperties Object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#OscProperties(oscP5.OscEventListener)">OscProperties</A></B>(<A HREF="../oscP5/OscEventListener.html" title="interface in oscP5">OscEventListener</A> theParent)</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> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#datagramSize()">datagramSize</A></B>()</CODE> + +<BR> + returns the current size of the datagram bytebuffer.</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/OscProperties.html#eventMethod()">eventMethod</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/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</A><<A HREF="../oscP5/OscEventListener.html" title="interface in oscP5">OscEventListener</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#listeners()">listeners</A></B>()</CODE> + +<BR> + </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/OscProperties.html#listeningPort()">listeningPort</A></B>()</CODE> + +<BR> + returns the port number currently used to receive osc packets.</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/OscProperties.html#networkProtocol()">networkProtocol</A></B>()</CODE> + +<BR> + returns the network protocol being used to transmit osc packets.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../oscP5/OscProperties.html#remoteAddress()">remoteAddress</A></B>()</CODE> + +<BR> + returns a NetAddress of the remote host you are sending + osc packets to.</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/OscProperties.html#sendStatus()">sendStatus</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/OscProperties.html#setDatagramSize(int)">setDatagramSize</A></B>(int theSize)</CODE> + +<BR> + set the size of the datagrampacket byte buffer.</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/OscProperties.html#setEventMethod(java.lang.String)">setEventMethod</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> theEventMethod)</CODE> + +<BR> + set the name of the default event method.</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/OscProperties.html#setListeningPort(int)">setListeningPort</A></B>(int thePort)</CODE> + +<BR> + set port number you are listening for incoming osc packets.</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/OscProperties.html#setNetworkProtocol(int)">setNetworkProtocol</A></B>(int theProtocol)</CODE> + +<BR> + set the network protocol over which osc messages are transmitted.</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/OscProperties.html#setRemoteAddress(netP5.NetAddress)">setRemoteAddress</A></B>(<A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A> theNetAddress)</CODE> + +<BR> + set the remote host address.</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/OscProperties.html#setRemoteAddress(java.lang.String, int)">setRemoteAddress</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> theHostAddress, + int thePort)</CODE> + +<BR> + set the remote host address.</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/OscProperties.html#setSRSP(boolean)">setSRSP</A></B>(boolean theFlag)</CODE> + +<BR> + SRSP stand for Send and Receive on Same Port.</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/OscProperties.html#srsp()">srsp</A></B>()</CODE> + +<BR> + you can send and receive at the same port while on a udp con</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/OscProperties.html#toString()">toString</A></B>()</CODE> + +<BR> + prints out the current osc properties settings.</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> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_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>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="ON"><!-- --></A><H3> +ON</H3> +<PRE> +public static final boolean <B>ON</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#oscP5.OscProperties.ON">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="OFF"><!-- --></A><H3> +OFF</H3> +<PRE> +public static final boolean <B>OFF</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#oscP5.OscProperties.OFF">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="UDP"><!-- --></A><H3> +UDP</H3> +<PRE> +public static final int <B>UDP</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#oscP5.OscProperties.UDP">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="MULTICAST"><!-- --></A><H3> +MULTICAST</H3> +<PRE> +public static final int <B>MULTICAST</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#oscP5.OscProperties.MULTICAST">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="TCP"><!-- --></A><H3> +TCP</H3> +<PRE> +public static final int <B>TCP</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../constant-values.html#oscP5.OscProperties.TCP">Constant Field Values</A></DL> +</DL> + +<!-- ========= 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="OscProperties(oscP5.OscEventListener)"><!-- --></A><H3> +OscProperties</H3> +<PRE> +public <B>OscProperties</B>(<A HREF="../oscP5/OscEventListener.html" title="interface in oscP5">OscEventListener</A> theParent)</PRE> +<DL> +</DL> +<HR> + +<A NAME="OscProperties()"><!-- --></A><H3> +OscProperties</H3> +<PRE> +public <B>OscProperties</B>()</PRE> +<DL> +<DD>create a new OscProperties Object. +<P> +</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="listeners()"><!-- --></A><H3> +listeners</H3> +<PRE> +public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</A><<A HREF="../oscP5/OscEventListener.html" title="interface in oscP5">OscEventListener</A>> <B>listeners</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>OscEventListener</DL> +</DD> +</DL> +<HR> + +<A NAME="sendStatus()"><!-- --></A><H3> +sendStatus</H3> +<PRE> +public boolean <B>sendStatus</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>boolean</DL> +</DD> +</DL> +<HR> + +<A NAME="setRemoteAddress(java.lang.String, int)"><!-- --></A><H3> +setRemoteAddress</H3> +<PRE> +public void <B>setRemoteAddress</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> theHostAddress, + int thePort)</PRE> +<DL> +<DD>set the remote host address. set ip address and port of the host + message should be sent to. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theHostAddress</CODE> - String<DD><CODE>thePort</CODE> - int</DL> +</DD> +</DL> +<HR> + +<A NAME="setRemoteAddress(netP5.NetAddress)"><!-- --></A><H3> +setRemoteAddress</H3> +<PRE> +public void <B>setRemoteAddress</B>(<A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A> theNetAddress)</PRE> +<DL> +<DD>set the remote host address. set ip address and port of the host + message should be sent to. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theNetAddress</CODE> - NetAddress</DL> +</DD> +</DL> +<HR> + +<A NAME="setListeningPort(int)"><!-- --></A><H3> +setListeningPort</H3> +<PRE> +public void <B>setListeningPort</B>(int thePort)</PRE> +<DL> +<DD>set port number you are listening for incoming osc packets. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>thePort</CODE> - int</DL> +</DD> +</DL> +<HR> + +<A NAME="setDatagramSize(int)"><!-- --></A><H3> +setDatagramSize</H3> +<PRE> +public void <B>setDatagramSize</B>(int theSize)</PRE> +<DL> +<DD>set the size of the datagrampacket byte buffer. + the default size is 1536 bytes. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theSize</CODE> - int</DL> +</DD> +</DL> +<HR> + +<A NAME="setEventMethod(java.lang.String)"><!-- --></A><H3> +setEventMethod</H3> +<PRE> +public void <B>setEventMethod</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> theEventMethod)</PRE> +<DL> +<DD>set the name of the default event method. + the event method is the method to which incoming osc messages + are forwarded. the default name for the event method is + "oscEvent" +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theEventMethod</CODE> - String</DL> +</DD> +</DL> +<HR> + +<A NAME="setNetworkProtocol(int)"><!-- --></A><H3> +setNetworkProtocol</H3> +<PRE> +public void <B>setNetworkProtocol</B>(int theProtocol)</PRE> +<DL> +<DD>set the network protocol over which osc messages are transmitted. + options are OscProperties.UDP and OscProperties.MULTICAST + the network protocol can only be set before initializing + oscP5. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theProtocol</CODE> - int</DL> +</DD> +</DL> +<HR> + +<A NAME="setSRSP(boolean)"><!-- --></A><H3> +setSRSP</H3> +<PRE> +public void <B>setSRSP</B>(boolean theFlag)</PRE> +<DL> +<DD>SRSP stand for Send and Receive on Same Port. + by default osc packets are not received and sent by the same port. + if you need to send and receive on the same port call + setSRSP(OscProperties.ON) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>theFlag</CODE> - boolean</DL> +</DD> +</DL> +<HR> + +<A NAME="srsp()"><!-- --></A><H3> +srsp</H3> +<PRE> +public boolean <B>srsp</B>()</PRE> +<DL> +<DD>you can send and receive at the same port while on a udp con +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>boolean</DL> +</DD> +</DL> +<HR> + +<A NAME="listeningPort()"><!-- --></A><H3> +listeningPort</H3> +<PRE> +public int <B>listeningPort</B>()</PRE> +<DL> +<DD>returns the port number currently used to receive osc packets. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>int</DL> +</DD> +</DL> +<HR> + +<A NAME="remoteAddress()"><!-- --></A><H3> +remoteAddress</H3> +<PRE> +public <A HREF="../netP5/NetAddress.html" title="class in netP5">NetAddress</A> <B>remoteAddress</B>()</PRE> +<DL> +<DD>returns a NetAddress of the remote host you are sending + osc packets to. by default this is null. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>NetAddress</DL> +</DD> +</DL> +<HR> + +<A NAME="datagramSize()"><!-- --></A><H3> +datagramSize</H3> +<PRE> +public int <B>datagramSize</B>()</PRE> +<DL> +<DD>returns the current size of the datagram bytebuffer. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>int</DL> +</DD> +</DL> +<HR> + +<A NAME="eventMethod()"><!-- --></A><H3> +eventMethod</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>eventMethod</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>String</DL> +</DD> +</DL> +<HR> + +<A NAME="networkProtocol()"><!-- --></A><H3> +networkProtocol</H3> +<PRE> +public int <B>networkProtocol</B>()</PRE> +<DL> +<DD>returns the network protocol being used to transmit osc packets. returns an int. + 0 (UDP), 1 (MULTICAST), 2 (TCP) +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>int</DL> +</DD> +</DL> +<HR> + +<A NAME="toString()"><!-- --></A><H3> +toString</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>toString</B>()</PRE> +<DL> +<DD>prints out the current osc properties settings. +<P> +<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> +<!-- ========= 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/OscPlug.html" title="class in oscP5"><B>PREV CLASS</B></A> + <A HREF="../oscP5/OscStatus.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/OscProperties.html" target="_top"><B>FRAMES</B></A> + <A HREF="OscProperties.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <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> |