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

Release 4.4.3 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:49:37 +02:00
committed by Stephen Sinclair
parent cfdfe7736a
commit f13d5bb3cd
632 changed files with 12236 additions and 19041 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/html/classstk_1_1RtWvIn.html
View File

@@ -52,7 +52,7 @@ Inheritance diagram for stk::RtWvIn:</div>
<p>STK realtime audio (blocking) input class. </p>
<p>This class provides a simplified interface to <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> for realtime audio input. It is a subclass of <a class="el" href="classstk_1_1WvIn.html" title="STK audio input abstract base class.">WvIn</a>. This class makes use of RtAudio's callback functionality by creating a large ring-buffer from which data is read. This class should not be used when low-latency is desired.</p>
<p><a class="el" href="classstk_1_1RtWvIn.html" title="STK realtime audio (blocking) input class.">RtWvIn</a> supports multi-channel data in both interleaved and non-interleaved formats. It is important to distinguish the <a class="el" href="classstk_1_1RtWvIn.html#ad2ace75cfe44dd82dd706d2c8dac7901" title="Compute a sample frame and return the specified channel value.">tick()</a> method that computes a single frame (and returns only the specified sample of a multi-channel frame) from the overloaded one that takes an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object for multi-channel and/or multi-frame data.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab84c98c568346d1ad86251961f7d1fba"></a><!-- doxytag: member="stk::RtWvIn::RtWvIn" ref="ab84c98c568346d1ad86251961f7d1fba" args="(unsigned int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=20)" -->
<div class="memitem">
@@ -164,6 +164,18 @@ Inheritance diagram for stk::RtWvIn:</div>
<p>Return the specified channel value of the last computed frame. </p>
<p>For multi-channel files, use the <a class="el" href="classstk_1_1WvIn.html#a3ab86e33eff9f962c9ef7b41e3ccb77e" title="Return an StkFrames reference to the last computed sample frame.">lastFrame()</a> function to get all values from the last computed frame. If the device is stopped, the returned value is 0.0. The <code>channel</code> argument must be less than the number of channels in the audio stream (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p><div class="fragment"><pre class="fragment"><a name="l00112"></a>00112 {
<a name="l00113"></a>00113 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel &gt;= data_.channels() ) {
<a name="l00115"></a>00115 oStream_ &lt;&lt; <span class="stringliteral">&quot;RtWvIn::lastOut(): channel argument and audio stream are incompatible!&quot;</span>;
<a name="l00116"></a>00116 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00117"></a>00117 }
<a name="l00118"></a>00118 <span class="preprocessor">#endif</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span>
<a name="l00120"></a>00120 <span class="keywordflow">return</span> lastFrame_[channel];
<a name="l00121"></a>00121 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="ad2ace75cfe44dd82dd706d2c8dac7901"></a><!-- doxytag: member="stk::RtWvIn::tick" ref="ad2ace75cfe44dd82dd706d2c8dac7901" args="(unsigned int channel=0)" -->
@@ -220,7 +232,7 @@ Inheritance diagram for stk::RtWvIn:</div>
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>