mirror of
https://github.com/thestk/stk
synced 2026-01-19 15:41:52 +00:00
Release 4.1.2 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
d12ef806ac
commit
5d63b50e85
@@ -5,75 +5,85 @@
|
||||
</HEAD>
|
||||
<BODY BGCOLOR="#FFFFFF">
|
||||
<CENTER>
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"><P>
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
||||
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<h1>TcpWvIn Class Reference</h1>STK internet streaming input class.
|
||||
<!-- Generated by Doxygen 1.3.6 -->
|
||||
<h1>TcpWvIn Class Reference</h1>STK internet streaming input class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="TcpWvIn_8h-source.html">TcpWvIn.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for TcpWvIn::
|
||||
<p><center><img src="classTcpWvIn.gif" usemap="#TcpWvIn_map" border="0"></center>
|
||||
<p>Inheritance diagram for TcpWvIn:
|
||||
<p><center><img src="classTcpWvIn.png" usemap="#TcpWvIn_map" border="0" alt=""></center>
|
||||
<map name="TcpWvIn_map">
|
||||
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="0,56,61,80">
|
||||
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,61,24">
|
||||
</map>
|
||||
<a href="classTcpWvIn-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
||||
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a0">TcpWvIn</a> (int port=2006)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Default constructor starts a socket server. If not specified, the server is associated with port 2006.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a1" doxytag="TcpWvIn::~TcpWvIn"></a>
|
||||
</td><td valign=bottom><a class="el" href="classTcpWvIn.html#a1">~TcpWvIn</a> ()</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a2">listen</a> (unsigned int nChannels=1, Stk::STK_FORMAT format=<a class="el" href="classStk.html#p1">STK_SINT16</a>)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Listen for a (new) connection with specified data channels and format.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a3">isConnected</a> (void)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Returns TRUE is an input connection exists or input data remains in the queue.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a4" doxytag="TcpWvIn::lastOut"></a>
|
||||
MY_FLOAT </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a4">lastOut</a> (void) const</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Return the average across the last output sample frame.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a5" doxytag="TcpWvIn::tick"></a>
|
||||
MY_FLOAT </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a5">tick</a> (void)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Read out the average across one sample frame of data.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a6" doxytag="TcpWvIn::tick"></a>
|
||||
MY_FLOAT* </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a6">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Read out vectorSize averaged sample frames of data in <em>vector</em>.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a7" doxytag="TcpWvIn::lastFrame"></a>
|
||||
const MY_FLOAT* </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a7">lastFrame</a> (void) const</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Return a pointer to the last output sample frame.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a8" doxytag="TcpWvIn::tickFrame"></a>
|
||||
const MY_FLOAT* </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a8">tickFrame</a> (void)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Return a pointer to the next sample frame of data.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a9" doxytag="TcpWvIn::tickFrame"></a>
|
||||
MY_FLOAT* </td><td valign=bottom><a class="el" href="classTcpWvIn.html#a9">tickFrame</a> (MY_FLOAT *frameVector, unsigned int frames)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Read out sample <em>frames</em> of data to <em>frameVector</em>.</em></font><br><br></td></tr>
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a0">TcpWvIn</a> (int port=2006)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor starts a socket server. If not specified, the server is associated with port 2006. <a href="#a0"></a><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="TcpWvIn::~TcpWvIn" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a1">~TcpWvIn</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a2">listen</a> (unsigned int nChannels=1, Stk::STK_FORMAT format=<a class="el" href="classStk.html#s1">STK_SINT16</a>)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Listen for a (new) connection with specified data channels and format. <a href="#a2"></a><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a3">isConnected</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE is an input connection exists or input data remains in the queue. <a href="#a3"></a><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="TcpWvIn::lastOut" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a4">lastOut</a> (void) const </td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the average across the last output sample frame. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="TcpWvIn::tick" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a5">tick</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read out the average across one sample frame of data. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="TcpWvIn::tick" ></a>
|
||||
MY_FLOAT * </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a6">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read out vectorSize averaged sample frames of data in <em>vector</em>. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="TcpWvIn::lastFrame" ></a>
|
||||
const MY_FLOAT * </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a7">lastFrame</a> (void) const </td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the last output sample frame. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="TcpWvIn::tickFrame" ></a>
|
||||
const MY_FLOAT * </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a8">tickFrame</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the next sample frame of data. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="TcpWvIn::tickFrame" ></a>
|
||||
MY_FLOAT * </td><td class="memItemRight" valign=bottom><a class="el" href="classTcpWvIn.html#a9">tickFrame</a> (MY_FLOAT *frameVector, unsigned int frames)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read out sample <em>frames</em> of data to <em>frameVector</em>. <br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
STK internet streaming input class.
|
||||
<p>
|
||||
This protected Wvin subclass can read streamed data over a network via a TCP socket connection. The data is assumed in big-endian, or network, byte order.
|
||||
<p>
|
||||
TcpWvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classTcpWvIn.html#a5">tick</a>() methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classTcpWvIn.html#a8">tickFrame</a>() methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.
|
||||
<p>
|
||||
This class starts a socket server, which waits for a single remote connection. The default data type for the incoming stream is signed 16-bit integers, though any of the defined STK_FORMATs are permissible.
|
||||
STK internet streaming input class.
|
||||
<p>
|
||||
This protected Wvin subclass can read streamed data over a network via a TCP socket connection. The data is assumed in big-endian, or network, byte order.<p>
|
||||
TcpWvIn supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classTcpWvIn.html#a5">tick()</a> methods, which return samples produced by averaging across sample frames, from the <a class="el" href="classTcpWvIn.html#a8">tickFrame()</a> methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.<p>
|
||||
This class starts a socket server, which waits for a single remote connection. The default data type for the incoming stream is signed 16-bit integers, though any of the defined STK_FORMATs are permissible.<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
||||
<p>
|
||||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||||
<a name="a0" doxytag="TcpWvIn::TcpWvIn"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="TcpWvIn_8h-source.html#l00041">41</a> of file <a class="el" href="TcpWvIn_8h-source.html">TcpWvIn.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="TcpWvIn::TcpWvIn" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
TcpWvIn::TcpWvIn (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
int <em>port</em> = 2006 )
|
||||
</b></td>
|
||||
<td class="md" nowrap valign="top"> TcpWvIn::TcpWvIn </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">int </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>port</em> = 2006 </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
@@ -88,30 +98,33 @@ int <em>port</em> = 2006 )
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Default constructor starts a socket server. If not specified, the server is associated with port 2006.
|
||||
Default constructor starts a socket server. If not specified, the server is associated with port 2006.
|
||||
<p>
|
||||
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs while initializing the input thread or starting the socket server. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr><h2>Member Function Documentation</h2>
|
||||
<a name="a2" doxytag="TcpWvIn::listen"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<a class="anchor" name="a2" doxytag="TcpWvIn::listen" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void TcpWvIn::listen (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
unsigned int <em>nChannels</em> = 1,
|
||||
</b></td>
|
||||
<td class="md" nowrap valign="top"> void TcpWvIn::listen </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">unsigned int </td>
|
||||
<td class="mdname" nowrap> <em>nChannels</em> = 1, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="md" nowrap align="right"></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>Stk::STK_FORMAT </td>
|
||||
<td class="mdname" nowrap> <em>format</em> = <a class="el" href="classStk.html#s1">STK_SINT16</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td><b>
|
||||
Stk::STK_FORMAT <em>format</em> = <a class="el" href="classStk.html#p1">STK_SINT16</a> )
|
||||
</b></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
@@ -126,23 +139,23 @@ Stk::STK_FORMAT <em>format</em> = <a class="el" href="classStk.html#p1">STK_SINT
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Listen for a (new) connection with specified data channels and format.
|
||||
Listen for a (new) connection with specified data channels and format.
|
||||
<p>
|
||||
An <a class="el" href="classStkError.html">StkError</a> will be thrown a socket error or an invalid function argument. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a3" doxytag="TcpWvIn::isConnected"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<a class="anchor" name="a3" doxytag="TcpWvIn::isConnected" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
bool TcpWvIn::isConnected (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
void )
|
||||
</b></td>
|
||||
<td class="md" nowrap valign="top"> bool TcpWvIn::isConnected </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">void </td>
|
||||
<td class="mdname1" valign="top" nowrap> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
@@ -157,7 +170,7 @@ void )
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Returns TRUE is an input connection exists or input data remains in the queue.
|
||||
Returns TRUE is an input connection exists or input data remains in the queue.
|
||||
<p>
|
||||
This method will not return FALSE after an input connection has been closed until all buffered input data has been read out. </td>
|
||||
</tr>
|
||||
@@ -168,7 +181,7 @@ This method will not return FALSE after an input connection has been closed unti
|
||||
|
||||
<table>
|
||||
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user