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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<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_1RtWvOut.html">RtWvOut</a>
</div>
<div class="contents">
<h1>stk::RtWvOut Class Reference</h1><!-- doxytag: class="stk::RtWvOut" --><!-- doxytag: inherits="stk::WvOut" -->
<p>STK realtime audio (blocking) output class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="RtWvOut_8h_source.html">RtWvOut.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::RtWvOut:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1RtWvOut.png" usemap="#stk::RtWvOut_map" alt=""/>
<map id="stk::RtWvOut_map" name="stk::RtWvOut_map">
<area href="classstk_1_1WvOut.html" alt="stk::WvOut" shape="rect" coords="0,56,82,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,82,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1RtWvOut-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1RtWvOut.html#af2ee408eb10a0dbf9e14407b34f2181e">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"> </td><td class="mdescRight">Default constructor. <a href="#af2ee408eb10a0dbf9e14407b34f2181e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85b2e30c6a153c959a33ec4aae528ca2"></a><!-- doxytag: member="stk::RtWvOut::~RtWvOut" ref="a85b2e30c6a153c959a33ec4aae528ca2" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1RtWvOut.html#a85b2e30c6a153c959a33ec4aae528ca2">~RtWvOut</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1RtWvOut.html#a2e34c9ff845155230e0336ea3729dc45">start</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the audio output stream. <a href="#a2e34c9ff845155230e0336ea3729dc45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1RtWvOut.html#a7368c42b81670c0335b25f14faa08918">stop</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop the audio output stream. <a href="#a7368c42b81670c0335b25f14faa08918"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1RtWvOut.html#a02adabdc987f3b9ac4dc4e02ea20962d">tick</a> (const StkFloat sample)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output a single sample to all channels in a sample frame. <a href="#a02adabdc987f3b9ac4dc4e02ea20962d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1RtWvOut.html#a025484fb9849d37ccc254c51929c77ab">tick</a> (const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames)</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. <a href="#a025484fb9849d37ccc254c51929c77ab"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK realtime audio (blocking) output 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 output. It is a subclass of <a class="el" href="classstk_1_1WvOut.html" title="STK audio output abstract base class.">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>
<p><a class="el" href="classstk_1_1RtWvOut.html" title="STK realtime audio (blocking) output class.">RtWvOut</a> supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classstk_1_1RtWvOut.html#a02adabdc987f3b9ac4dc4e02ea20962d" title="Output a single sample to all channels in a sample frame.">tick()</a> method that outputs a single sample to all channels in a sample frame from the overloaded one that takes a reference to 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-2012. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af2ee408eb10a0dbf9e14407b34f2181e"></a><!-- doxytag: member="stk::RtWvOut::RtWvOut" ref="af2ee408eb10a0dbf9e14407b34f2181e" args="(unsigned int nChannels=1, StkFloat sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=20)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::RtWvOut::RtWvOut </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>nChannels</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">StkFloat </td>
<td class="paramname"> <em>sampleRate</em> = <code>Stk::sampleRate()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>device</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>bufferFrames</em> = <code>RT_BUFFER_SIZE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nBuffers</em> = <code>20</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>The default <em>device</em> argument value (zero) will select the default output device on your system. The first device enumerated by the underlying audio API is specified with a value of one. 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="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if an error occurs duing instantiation. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2e34c9ff845155230e0336ea3729dc45"></a><!-- doxytag: member="stk::RtWvOut::start" ref="a2e34c9ff845155230e0336ea3729dc45" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::RtWvOut::start </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start the audio output stream. </p>
<p>The stream is started automatically, if necessary, when a <a class="el" href="classstk_1_1RtWvOut.html#a02adabdc987f3b9ac4dc4e02ea20962d" title="Output a single sample to all channels in a sample frame.">tick()</a> method is called. </p>
</div>
</div>
<a class="anchor" id="a7368c42b81670c0335b25f14faa08918"></a><!-- doxytag: member="stk::RtWvOut::stop" ref="a7368c42b81670c0335b25f14faa08918" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::RtWvOut::stop </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop the audio output stream. </p>
<p>It may be necessary to use this method to avoid undesireable audio buffer cycling if you wish to temporarily stop audio output. </p>
</div>
</div>
<a class="anchor" id="a02adabdc987f3b9ac4dc4e02ea20962d"></a><!-- doxytag: member="stk::RtWvOut::tick" ref="a02adabdc987f3b9ac4dc4e02ea20962d" args="(const StkFloat sample)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::RtWvOut::tick </td>
<td>(</td>
<td class="paramtype">const StkFloat </td>
<td class="paramname"> <em>sample</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Output a single sample to all channels in a sample frame. </p>
<p>If the device is "stopped", it is "started". </p>
<p>Implements <a class="el" href="classstk_1_1WvOut.html#a7fe517928a0043353ebc2a852b49953c">stk::WvOut</a>.</p>
</div>
</div>
<a class="anchor" id="a025484fb9849d37ccc254c51929c77ab"></a><!-- doxytag: member="stk::RtWvOut::tick" ref="a025484fb9849d37ccc254c51929c77ab" args="(const StkFrames &frames)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::RtWvOut::tick </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
<td class="paramname"> <em>frames</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Output the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> data. </p>
<p>If the device is "stopped", it is "started". The number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument must equal the number of channels specified during instantiation. However, this is only checked if _STK_DEBUG_ is defined during compilation, in which case an incompatibility will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implements <a class="el" href="classstk_1_1WvOut.html#a7e20334ec73dde8c6c5edef697812b7e">stk::WvOut</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RtWvOut_8h_source.html">RtWvOut.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>
|
