mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
103 lines
7.2 KiB
HTML
103 lines
7.2 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
|
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#FFFFFF">
|
|
<CENTER>
|
|
<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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.5.8 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1WvOut.html">WvOut</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::WvOut Class Reference</h1><!-- doxytag: class="stk::WvOut" --><!-- doxytag: inherits="stk::Stk" -->STK audio output abstract base class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="WvOut_8h-source.html">WvOut.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::WvOut:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1WvOut.png" usemap="#stk::WvOut_map" border="0" alt=""></center>
|
|
<map name="stk::WvOut_map">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="102,0,194,24">
|
|
<area href="classstk_1_1FileWvOut.html" alt="stk::FileWvOut" shape="rect" coords="0,112,92,136">
|
|
<area href="classstk_1_1InetWvOut.html" alt="stk::InetWvOut" shape="rect" coords="102,112,194,136">
|
|
<area href="classstk_1_1RtWvOut.html" alt="stk::RtWvOut" shape="rect" coords="204,112,296,136">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1WvOut-members.html">List of all members.</a><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"><a class="anchor" name="4337bc4efb010ce57af3543dc5ed6f66"></a><!-- doxytag: member="stk::WvOut::WvOut" ref="4337bc4efb010ce57af3543dc5ed6f66" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#4337bc4efb010ce57af3543dc5ed6f66">WvOut</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0ef107e58e0b470cbb47de292251a5e"></a><!-- doxytag: member="stk::WvOut::getFrameCount" ref="a0ef107e58e0b470cbb47de292251a5e" args="(void) const " -->
|
|
unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#a0ef107e58e0b470cbb47de292251a5e">getFrameCount</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of sample frames output. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca11b8991f281beb2b1c4d562c7ff43b"></a><!-- doxytag: member="stk::WvOut::getTime" ref="ca11b8991f281beb2b1c4d562c7ff43b" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#ca11b8991f281beb2b1c4d562c7ff43b">getTime</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of seconds of data output. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed503fe979c33eb8240901f005cb48d5"></a><!-- doxytag: member="stk::WvOut::clipStatus" ref="ed503fe979c33eb8240901f005cb48d5" args="(void)" -->
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#ed503fe979c33eb8240901f005cb48d5">clipStatus</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if clipping has been detected during output since instantiation or the last reset. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73f7143c2a574afd0a6c7934a92e7bf3"></a><!-- doxytag: member="stk::WvOut::resetClipStatus" ref="73f7143c2a574afd0a6c7934a92e7bf3" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#73f7143c2a574afd0a6c7934a92e7bf3">resetClipStatus</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the clipping status to <code>false</code>. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#7fe517928a0043353ebc2a852b49953c">tick</a> (const StkFloat sample)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output a single sample to all channels in a sample frame. <a href="#7fe517928a0043353ebc2a852b49953c"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK audio output abstract base class.
|
|
<p>
|
|
This class provides common functionality for a variety of audio data output subclasses.<p>
|
|
Currently, <a class="el" href="classstk_1_1WvOut.html" title="STK audio output abstract base class.">WvOut</a> is non-interpolating and the output rate is always <a class="el" href="classstk_1_1Stk.html#5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">Stk::sampleRate()</a>.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="7fe517928a0043353ebc2a852b49953c"></a><!-- doxytag: member="stk::WvOut::tick" ref="7fe517928a0043353ebc2a852b49953c" args="(const StkFloat sample)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void stk::WvOut::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const StkFloat </td>
|
|
<td class="paramname"> <em>sample</em> </td>
|
|
<td> ) </td>
|
|
<td><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Output a single sample to all channels in a sample frame.
|
|
<p>
|
|
An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> is thrown if an output error occurs.
|
|
<p>Implemented in <a class="el" href="classstk_1_1FileWvOut.html#9d3505aea3cd3c4d6822f05a2679dc41">stk::FileWvOut</a>, <a class="el" href="classstk_1_1InetWvOut.html#800f77228d851a2d276fae6a24bcdc9a">stk::InetWvOut</a>, and <a class="el" href="classstk_1_1RtWvOut.html#02adabdc987f3b9ac4dc4e02ea20962d">stk::RtWvOut</a>.</p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="WvOut_8h-source.html">WvOut.h</a></ul>
|
|
</div>
|
|
<HR>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|