-
Notifications
You must be signed in to change notification settings - Fork 282
/
classAudioComponent.html
315 lines (292 loc) · 16.2 KB
/
classAudioComponent.html
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Open Ephys GUI: AudioComponent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open Ephys GUI
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<div class="title">AudioComponent Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interfaces with system audio hardware.
<a href="classAudioComponent.html#details">More...</a></p>
<p><code>#include <AudioComponent.h></code></p>
<p><a href="classAudioComponent-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaea64af7cd81778f6737f0a4bee35394"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#aaea64af7cd81778f6737f0a4bee35394">AudioComponent</a> ()</td></tr>
<tr class="memdesc:aaea64af7cd81778f6737f0a4bee35394"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aaea64af7cd81778f6737f0a4bee35394"></a><br/></td></tr>
<tr class="memitem:a68bf2351458d61601aad7abeb3f58588"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#a68bf2351458d61601aad7abeb3f58588">~AudioComponent</a> ()</td></tr>
<tr class="memitem:a39ef696dde4891e20b17adb0c8057740"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#a39ef696dde4891e20b17adb0c8057740">beginCallbacks</a> ()</td></tr>
<tr class="memdesc:a39ef696dde4891e20b17adb0c8057740"><td class="mdescLeft"> </td><td class="mdescRight">Begins the audio callbacks that drive data acquisition. <a href="#a39ef696dde4891e20b17adb0c8057740"></a><br/></td></tr>
<tr class="memitem:a78e2a818d271fb26387d41875271e4ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#a78e2a818d271fb26387d41875271e4ba">endCallbacks</a> ()</td></tr>
<tr class="memdesc:a78e2a818d271fb26387d41875271e4ba"><td class="mdescLeft"> </td><td class="mdescRight">Stops the audio callbacks that drive data acquisition. <a href="#a78e2a818d271fb26387d41875271e4ba"></a><br/></td></tr>
<tr class="memitem:aaffe78d6dae978d9905cf2caf2f883b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#aaffe78d6dae978d9905cf2caf2f883b2">connectToProcessorGraph</a> (AudioProcessorGraph *processorGraph)</td></tr>
<tr class="memdesc:aaffe78d6dae978d9905cf2caf2f883b2"><td class="mdescLeft"> </td><td class="mdescRight"><pre class="fragment">Connects the AudioComponent to the ProcessorGraph (crucial for any sort of
</pre><p> data acquisition; done at startup). <a href="#aaffe78d6dae978d9905cf2caf2f883b2"></a><br/></td></tr>
<tr class="memitem:a8570488c01bd73e836cfb1f153d7ec86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#a8570488c01bd73e836cfb1f153d7ec86">disconnectProcessorGraph</a> ()</td></tr>
<tr class="memdesc:a8570488c01bd73e836cfb1f153d7ec86"><td class="mdescLeft"> </td><td class="mdescRight"><pre class="fragment">Disconnects the AudioComponent to the ProcessorGraph (only done when the application
</pre><p> is about to close). <a href="#a8570488c01bd73e836cfb1f153d7ec86"></a><br/></td></tr>
<tr class="memitem:a5f6d992b7a5c267332416f8ee0b1aff0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#a5f6d992b7a5c267332416f8ee0b1aff0">callbacksAreActive</a> ()</td></tr>
<tr class="memdesc:a5f6d992b7a5c267332416f8ee0b1aff0"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the audio callbacks are active, false otherwise. <a href="#a5f6d992b7a5c267332416f8ee0b1aff0"></a><br/></td></tr>
<tr class="memitem:afa720e702e65def918da93505a4a9e7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#afa720e702e65def918da93505a4a9e7e">restartDevice</a> ()</td></tr>
<tr class="memdesc:afa720e702e65def918da93505a4a9e7e"><td class="mdescLeft"> </td><td class="mdescRight"><pre class="fragment">Restarts communication with the audio device in order to update settings
</pre><p> or just prior the start of data acquisition callbacks. <a href="#afa720e702e65def918da93505a4a9e7e"></a><br/></td></tr>
<tr class="memitem:ac85bf5472fbb1112b8429e26bcea6bc1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#ac85bf5472fbb1112b8429e26bcea6bc1">stopDevice</a> ()</td></tr>
<tr class="memdesc:ac85bf5472fbb1112b8429e26bcea6bc1"><td class="mdescLeft"> </td><td class="mdescRight"><pre class="fragment">Stops communication with the selected audio device (to conserve CPU load
</pre><p> when callbacks are not active). <a href="#ac85bf5472fbb1112b8429e26bcea6bc1"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a84f78369c478a8531a258ba8683033e1"><td class="memItemLeft" align="right" valign="top">AudioDeviceManager </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioComponent.html#a84f78369c478a8531a258ba8683033e1">deviceManager</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interfaces with system audio hardware. </p>
<p>Uses the audio card to generate the callbacks to run the <a class="el" href="classProcessorGraph.html" title="Owns all processors and constructs the signal chain.">ProcessorGraph</a> during data acquisition.</p>
<p>Sends output to the audio card for audio monitoring.</p>
<p>Determines the initial size of the sample buffer (crucial for real-time feedback latency).</p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="classMainWindow.html" title="The main window for the GUI application.">MainWindow</a>, <a class="el" href="classProcessorGraph.html" title="Owns all processors and constructs the signal chain.">ProcessorGraph</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aaea64af7cd81778f6737f0a4bee35394"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AudioComponent::AudioComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Finds the audio component (if there is one), and sets the default sample rate and buffer size. </p>
</div>
</div>
<a class="anchor" id="a68bf2351458d61601aad7abeb3f58588"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AudioComponent::~AudioComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a39ef696dde4891e20b17adb0c8057740"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioComponent::beginCallbacks </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Begins the audio callbacks that drive data acquisition. </p>
</div>
</div>
<a class="anchor" id="a78e2a818d271fb26387d41875271e4ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioComponent::endCallbacks </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the audio callbacks that drive data acquisition. </p>
</div>
</div>
<a class="anchor" id="aaffe78d6dae978d9905cf2caf2f883b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioComponent::connectToProcessorGraph </td>
<td>(</td>
<td class="paramtype">AudioProcessorGraph * </td>
<td class="paramname"><em>processorGraph</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><pre class="fragment">Connects the AudioComponent to the ProcessorGraph (crucial for any sort of
</pre><p> data acquisition; done at startup). </p>
</div>
</div>
<a class="anchor" id="a8570488c01bd73e836cfb1f153d7ec86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioComponent::disconnectProcessorGraph </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><pre class="fragment">Disconnects the AudioComponent to the ProcessorGraph (only done when the application
</pre><p> is about to close). </p>
</div>
</div>
<a class="anchor" id="a5f6d992b7a5c267332416f8ee0b1aff0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AudioComponent::callbacksAreActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the audio callbacks are active, false otherwise. </p>
</div>
</div>
<a class="anchor" id="afa720e702e65def918da93505a4a9e7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioComponent::restartDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><pre class="fragment">Restarts communication with the audio device in order to update settings
</pre><p> or just prior the start of data acquisition callbacks. </p>
</div>
</div>
<a class="anchor" id="ac85bf5472fbb1112b8429e26bcea6bc1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioComponent::stopDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><pre class="fragment">Stops communication with the selected audio device (to conserve CPU load
</pre><p> when callbacks are not active). </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a84f78369c478a8531a258ba8683033e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AudioDeviceManager AudioComponent::deviceManager</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="AudioComponent_8h.html">AudioComponent.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 27 2012 13:56:41 for Open Ephys GUI by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>