e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-17 14:41:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.3 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:38:16 +02:00
committed by Stephen Sinclair
parent 503ed3cc9f
commit e11bff2fe8
275 changed files with 1190 additions and 1228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/html/classWvOut.html
View File

@@ -8,7 +8,7 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.6 -->
<!-- Generated by Doxygen 1.3.4 -->
<h1>WvOut Class Reference</h1>STK audio data output base class.
<a href="#_details">More...</a>
<p>
@@ -28,16 +28,16 @@
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a0">WvOut</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a1">WvOut</a> (const char *fileName, unsigned int nChannels=1, FILE_TYPE type=<a class="el" href="classWvOut.html#s1">WVOUT_WAV</a>, Stk::STK_FORMAT format=<a class="el" href="classStk.html#s1">STK_SINT16</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a1">WvOut</a> (const char *fileName, unsigned int nChannels=1, FILE_TYPE type=<a class="el" href="classWvOut.html#s1">WVOUT_WAV</a>, Stk::STK_FORMAT format=<a class="el" href="classStk.html#s1">STK_SINT16</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor used to specify a file name, type, and data format with this object. <a href="#a1"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloaded constructor used to specify a file name, type, and data format with this object. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="WvOut::~WvOut" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a2">~WvOut</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a3">openFile</a> (const char *fileName, unsigned int nChannels=1, WvOut::FILE_TYPE type=<a class="el" href="classWvOut.html#s1">WVOUT_WAV</a>, Stk::STK_FORMAT format=<a class="el" href="classStk.html#s1">STK_SINT16</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a3">openFile</a> (const char *fileName, unsigned int nChannels=1, WvOut::FILE_TYPE type=<a class="el" href="classWvOut.html#s1">WVOUT_WAV</a>, Stk::STK_FORMAT format=<a class="el" href="classStk.html#s1">STK_SINT16</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a file of the specified type and name and output samples to it in the given data format. <a href="#a3"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a file of the specified type and name and output samples to it in the given data format. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="WvOut::closeFile" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a4">closeFile</a> (void)</td></tr>
@@ -50,25 +50,25 @@ unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" hre
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a6">getTime</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of seconds of data output. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a7">tick</a> (const MY_FLOAT sample)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a7">tick</a> (const MY_FLOAT sample)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output a single sample to all channels in a sample frame. <a href="#a7"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a8">tick</a> (const MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output a single sample to all channels in a sample frame. </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a8">tick</a> (const MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output each sample in <em>vector</em> to all channels in <em>vectorSize</em> sample frames. <a href="#a8"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a9">tickFrame</a> (const MY_FLOAT *frameVector, unsigned int frames=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output each sample in <em>vector</em> to all channels in <em>vectorSize</em> sample frames. </em> <a href="#a8"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#a9">tickFrame</a> (const MY_FLOAT *frameVector, unsigned int frames=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output the <em>frameVector</em> of sample frames of the given length. <a href="#a9"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output the <em>frameVector</em> of sample frames of the given length. </em> <a href="#a9"></a><em><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s0">WVOUT_RAW</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s0">WVOUT_RAW</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s1">WVOUT_WAV</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s1">WVOUT_WAV</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s2">WVOUT_SND</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s2">WVOUT_SND</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s3">WVOUT_AIF</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s3">WVOUT_AIF</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s4">WVOUT_MAT</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const FILE_TYPE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classWvOut.html#s4">WVOUT_MAT</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
@@ -95,19 +95,19 @@ Definition at line <a class="el" href="WvOut_8h-source.html#l00044">44</a> of fi
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nChannels</em> = 1, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>FILE_TYPE&nbsp;</td>
<td class="mdname" nowrap> <em>type</em> = <a class="el" href="classWvOut.html#s1">WVOUT_WAV</a>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>Stk::STK_FORMAT&nbsp;</td>
<td class="mdname" nowrap> <em>format</em> = <a class="el" href="classStk.html#s1">STK_SINT16</a></td>
@@ -148,19 +148,19 @@ An <a class="el" href="classStkError.html">StkError</a> is thrown for invalid ar
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>nChannels</em> = 1, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>WvOut::FILE_TYPE&nbsp;</td>
<td class="mdname" nowrap> <em>type</em> = <a class="el" href="classWvOut.html#s1">WVOUT_WAV</a>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>Stk::STK_FORMAT&nbsp;</td>
<td class="mdname" nowrap> <em>format</em> = <a class="el" href="classStk.html#s1">STK_SINT16</a></td>
@@ -233,7 +233,7 @@ Reimplemented in <a class="el" href="classRtWvOut.html#a6">RtWvOut</a>, and <a c
<td class="mdname" nowrap> <em>vector</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>vectorSize</em></td>
@@ -275,7 +275,7 @@ Reimplemented in <a class="el" href="classRtWvOut.html#a7">RtWvOut</a>, and <a c
<td class="mdname" nowrap> <em>frameVector</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em> = 1</td>