1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<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.6.2 -->
<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" -->
<p>STK audio output abstract base class.
<a href="#_details">More...</a></p>
<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">
<div class="center">
<img src="classstk_1_1WvOut.png" usemap="#stk::WvOut_map" alt=""/>
<map id="stk::WvOut_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>
</div>
<p><a href="classstk_1_1WvOut-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4337bc4efb010ce57af3543dc5ed6f66"></a><!-- doxytag: member="stk::WvOut::WvOut" ref="a4337bc4efb010ce57af3543dc5ed6f66" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#a4337bc4efb010ce57af3543dc5ed6f66">WvOut</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0ef107e58e0b470cbb47de292251a5e"></a><!-- doxytag: member="stk::WvOut::getFrameCount" ref="aa0ef107e58e0b470cbb47de292251a5e" args="(void) const " -->
unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#aa0ef107e58e0b470cbb47de292251a5e">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" align="right" valign="top"><a class="anchor" id="aca11b8991f281beb2b1c4d562c7ff43b"></a><!-- doxytag: member="stk::WvOut::getTime" ref="aca11b8991f281beb2b1c4d562c7ff43b" args="(void) const " -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#aca11b8991f281beb2b1c4d562c7ff43b">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" align="right" valign="top"><a class="anchor" id="aed503fe979c33eb8240901f005cb48d5"></a><!-- doxytag: member="stk::WvOut::clipStatus" ref="aed503fe979c33eb8240901f005cb48d5" args="(void)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#aed503fe979c33eb8240901f005cb48d5">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" align="right" valign="top"><a class="anchor" id="a73f7143c2a574afd0a6c7934a92e7bf3"></a><!-- doxytag: member="stk::WvOut::resetClipStatus" ref="a73f7143c2a574afd0a6c7934a92e7bf3" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#a73f7143c2a574afd0a6c7934a92e7bf3">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" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#a7fe517928a0043353ebc2a852b49953c">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="#a7fe517928a0043353ebc2a852b49953c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e20334ec73dde8c6c5edef697812b7e"></a><!-- doxytag: member="stk::WvOut::tick" ref="a7e20334ec73dde8c6c5edef697812b7e" args="(const StkFrames &frames)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvOut.html#a7e20334ec73dde8c6c5edef697812b7e">tick</a> (const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> data. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK audio output abstract base class. </p>
<p>This class provides common functionality for a variety of audio data output subclasses.</p>
<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#a5fbe37000a611ce56075ee7d8936472d" title="Static method that returns the current STK sample rate.">Stk::sampleRate()</a>.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7fe517928a0043353ebc2a852b49953c"></a><!-- doxytag: member="stk::WvOut::tick" ref="a7fe517928a0043353ebc2a852b49953c" 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>
<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>
<p>Implemented in <a class="el" href="classstk_1_1FileWvOut.html#a9d3505aea3cd3c4d6822f05a2679dc41">stk::FileWvOut</a>, <a class="el" href="classstk_1_1InetWvOut.html#a800f77228d851a2d276fae6a24bcdc9a">stk::InetWvOut</a>, and <a class="el" href="classstk_1_1RtWvOut.html#a02adabdc987f3b9ac4dc4e02ea20962d">stk::RtWvOut</a>.</p>
</div>
</div>
<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></li>
</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-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
