e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-22 07:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.3.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:41:50 +02:00
committed by Stephen Sinclair
parent 554a74374b
commit 1a8403e203
462 changed files with 4751 additions and 3397 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/html/classRtWvOut.html
View File

@@ -6,7 +6,7 @@
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<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>
<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="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.4.4 -->
<h1>RtWvOut Class Reference</h1><!-- doxytag: class="RtWvOut" --><!-- doxytag: inherits="WvOut" --><code>#include &lt;<a class="el" href="RtWvOut_8h-source.html">RtWvOut.h</a>&gt;</code>
@@ -20,14 +20,14 @@
<a href="classRtWvOut-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK realtime audio (blocking) output class.
<p>
This class provides a simplified interface to <a class="el" href="classRtAudio.html">RtAudio</a> for realtime audio output. It is a subclass of <a class="el" href="classWvOut.html">WvOut</a>. Because this class makes use of RtAudio's blocking output routines, its performance is less robust on systems where the audio API is callback-based (Macintosh CoreAudio and Windows ASIO).<p>
This class provides a simplified interface to <a class="el" href="classRtAudio.html">RtAudio</a> for realtime audio output. It is a subclass of <a class="el" href="classWvOut.html">WvOut</a>. This class makes use of RtAudio's callback functionality by creating a large ring-buffer into which data is written. This class should not be used when low-latency is desired.<p>
RtWvOut supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classWvOut.html#a6">tick()</a> methods, which output single samples to all channels in a sample frame, from the <a class="el" href="classWvOut.html#a8">tickFrame()</a> method, which take a pointer or reference to multi-channel sample frame data.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtWvOut.html#a0">RtWvOut</a> (unsigned int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=4)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtWvOut.html#a0">RtWvOut</a> (unsigned int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=20)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtWvOut::~RtWvOut" ref="a1" args="()" -->
@@ -42,7 +42,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop the audio output stream. <a href="#a3"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="RtWvOut::RtWvOut" ref="a0" args="(unsigned int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=4)" --><p>
<a class="anchor" name="a0"></a><!-- doxytag: member="RtWvOut::RtWvOut" ref="a0" args="(unsigned int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=20)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -75,7 +75,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>nBuffers</em> = <code>4</code></td>
<td class="mdname" nowrap> <em>nBuffers</em> = <code>20</code></td>
</tr>
<tr>
<td class="md"></td>
@@ -96,7 +96,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
Default constructor.
<p>
The <em>device</em> argument is passed to <a class="el" href="classRtAudio.html">RtAudio</a> during instantiation. The default value (zero) will select the default device on your system or the first device found meeting the specified parameters. On systems with multiple soundcards/devices, values greater than zero can be specified in accordance with the order that the devices are enumerated by the underlying audio API. The default buffer size of RT_BUFFER_SIZE is defined in <a class="el" href="Stk_8h-source.html">Stk.h</a>. An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs duing instantiation. </td>
The <em>device</em> argument is passed to <a class="el" href="classRtAudio.html">RtAudio</a> during instantiation. The default value (zero) will select the default device on your system. On systems with multiple soundcards/devices, values greater than zero can be specified in accordance with the order that the devices are enumerated by the underlying audio API. The default buffer size of RT_BUFFER_SIZE is defined in <a class="el" href="Stk_8h-source.html">Stk.h</a>. An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs duing instantiation. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
@@ -166,7 +166,7 @@ It may be necessary to use this method to avoid undesireable audio buffer cyclin
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>