/usr/share/doc/libjuce/apiref/classAudioIODeviceCallback.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 316 317 | <!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"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: AudioIODeviceCallback 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="classAudioIODeviceCallback-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AudioIODeviceCallback Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>One of these is passed to an <a class="el" href="classAudioIODevice.html" title="Base class for an audio device with synchronised input and output channels. ">AudioIODevice</a> object to stream the audio data in and out.
<a href="classAudioIODeviceCallback.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for AudioIODeviceCallback:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classAudioIODeviceCallback.png" usemap="#AudioIODeviceCallback_map" alt=""/>
<map id="AudioIODeviceCallback_map" name="AudioIODeviceCallback_map">
<area href="classAudioProcessorPlayer.html" title="An AudioIODeviceCallback object which streams audio through an AudioProcessor. " alt="AudioProcessorPlayer" shape="rect" coords="0,56,147,80"/>
<area href="classAudioSourcePlayer.html" title="Wrapper class to continuously stream audio from an audio source to an AudioIODevice. " alt="AudioSourcePlayer" shape="rect" coords="157,56,304,80"/>
<area href="classSoundPlayer.html" title="A simple sound player that you can add to the AudioDeviceManager to play simple sounds. " alt="SoundPlayer" shape="rect" coords="314,56,461,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a922abd58862d1bc04c067683a6a8e59a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODeviceCallback.html#a922abd58862d1bc04c067683a6a8e59a">~AudioIODeviceCallback</a> ()</td></tr>
<tr class="memdesc:a922abd58862d1bc04c067683a6a8e59a"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a922abd58862d1bc04c067683a6a8e59a">More...</a><br /></td></tr>
<tr class="separator:a922abd58862d1bc04c067683a6a8e59a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ba147cd10fe995c3016dbf35132f995"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODeviceCallback.html#a9ba147cd10fe995c3016dbf35132f995">audioDeviceIOCallback</a> (const float **inputChannelData, int numInputChannels, float **outputChannelData, int numOutputChannels, int numSamples)=0</td></tr>
<tr class="memdesc:a9ba147cd10fe995c3016dbf35132f995"><td class="mdescLeft"> </td><td class="mdescRight">Processes a block of incoming and outgoing audio data. <a href="#a9ba147cd10fe995c3016dbf35132f995">More...</a><br /></td></tr>
<tr class="separator:a9ba147cd10fe995c3016dbf35132f995"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bec2ae89543a93e31461991f7404aec"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODeviceCallback.html#a1bec2ae89543a93e31461991f7404aec">audioDeviceAboutToStart</a> (<a class="el" href="classAudioIODevice.html">AudioIODevice</a> *device)=0</td></tr>
<tr class="memdesc:a1bec2ae89543a93e31461991f7404aec"><td class="mdescLeft"> </td><td class="mdescRight">Called to indicate that the device is about to start calling back. <a href="#a1bec2ae89543a93e31461991f7404aec">More...</a><br /></td></tr>
<tr class="separator:a1bec2ae89543a93e31461991f7404aec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b3e3c479e4e0b3b19ea992960ef46f5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODeviceCallback.html#a7b3e3c479e4e0b3b19ea992960ef46f5">audioDeviceStopped</a> ()=0</td></tr>
<tr class="memdesc:a7b3e3c479e4e0b3b19ea992960ef46f5"><td class="mdescLeft"> </td><td class="mdescRight">Called to indicate that the device has stopped. <a href="#a7b3e3c479e4e0b3b19ea992960ef46f5">More...</a><br /></td></tr>
<tr class="separator:a7b3e3c479e4e0b3b19ea992960ef46f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7768d640daf7d5d56399ced8188b2b75"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioIODeviceCallback.html#a7768d640daf7d5d56399ced8188b2b75">audioDeviceError</a> (const <a class="el" href="classString.html">String</a> &errorMessage)</td></tr>
<tr class="memdesc:a7768d640daf7d5d56399ced8188b2b75"><td class="mdescLeft"> </td><td class="mdescRight">This can be overridden to be told if the device generates an error while operating. <a href="#a7768d640daf7d5d56399ced8188b2b75">More...</a><br /></td></tr>
<tr class="separator:a7768d640daf7d5d56399ced8188b2b75"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>One of these is passed to an <a class="el" href="classAudioIODevice.html" title="Base class for an audio device with synchronised input and output channels. ">AudioIODevice</a> object to stream the audio data in and out. </p>
<p>The <a class="el" href="classAudioIODevice.html" title="Base class for an audio device with synchronised input and output channels. ">AudioIODevice</a> will repeatedly call this class's <a class="el" href="classAudioIODeviceCallback.html#a9ba147cd10fe995c3016dbf35132f995" title="Processes a block of incoming and outgoing audio data. ">audioDeviceIOCallback()</a> method on its own high-priority audio thread, when it needs to send or receive the next block of data.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioIODevice.html" title="Base class for an audio device with synchronised input and output channels. ">AudioIODevice</a>, <a class="el" href="classAudioDeviceManager.html" title="Manages the state of some audio and midi i/o devices. ">AudioDeviceManager</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a922abd58862d1bc04c067683a6a8e59a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a922abd58862d1bc04c067683a6a8e59a">§ </a></span>~AudioIODeviceCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual AudioIODeviceCallback::~AudioIODeviceCallback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9ba147cd10fe995c3016dbf35132f995"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ba147cd10fe995c3016dbf35132f995">§ </a></span>audioDeviceIOCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AudioIODeviceCallback::audioDeviceIOCallback </td>
<td>(</td>
<td class="paramtype">const float ** </td>
<td class="paramname"><em>inputChannelData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numInputChannels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float ** </td>
<td class="paramname"><em>outputChannelData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numOutputChannels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numSamples</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Processes a block of incoming and outgoing audio data. </p>
<p>The subclass's implementation should use the incoming audio for whatever purposes it needs to, and must fill all the output channels with the next block of output data before returning.</p>
<p>The channel data is arranged with the same array indices as the channel name array returned by <a class="el" href="classAudioIODevice.html#a49d09c50d23685dfeb881594c6e8a621" title="Returns the names of all the available output channels on this device. ">AudioIODevice::getOutputChannelNames()</a>, but those channels that aren't specified in <a class="el" href="classAudioIODevice.html#a519b91efd6bf7bf88fbe85eb5510629f" title="Tries to open the device ready to play. ">AudioIODevice::open()</a> will have a null pointer for their associated channel, so remember to check for this.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputChannelData</td><td>a set of arrays containing the audio data for each incoming channel - this data is valid until the function returns. There will be one channel of data for each input channel that was enabled when the audio device was opened (see <a class="el" href="classAudioIODevice.html#a519b91efd6bf7bf88fbe85eb5510629f" title="Tries to open the device ready to play. ">AudioIODevice::open()</a>) </td></tr>
<tr><td class="paramname">numInputChannels</td><td>the number of pointers to channel data in the inputChannelData array. </td></tr>
<tr><td class="paramname">outputChannelData</td><td>a set of arrays which need to be filled with the data that should be sent to each outgoing channel of the device. There will be one channel of data for each output channel that was enabled when the audio device was opened (see <a class="el" href="classAudioIODevice.html#a519b91efd6bf7bf88fbe85eb5510629f" title="Tries to open the device ready to play. ">AudioIODevice::open()</a>) The initial contents of the array is undefined, so the callback function must fill all the channels with zeros if its output is silence. Failing to do this could cause quite an unpleasant noise! </td></tr>
<tr><td class="paramname">numOutputChannels</td><td>the number of pointers to channel data in the outputChannelData array. </td></tr>
<tr><td class="paramname">numSamples</td><td>the number of samples in each channel of the input and output arrays. The number of samples will depend on the audio device's buffer size and will usually remain constant, although this isn't guaranteed, so make sure your code can cope with reasonable changes in the buffer size from one callback to the next. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classSoundPlayer.html#a90ec033e5d30ddb9168698b08b749576">SoundPlayer</a>, <a class="el" href="classAudioSourcePlayer.html#affe24f50bfa4d73f8e2d220bec2433ec">AudioSourcePlayer</a>, and <a class="el" href="classAudioProcessorPlayer.html#aa9ec99f33b14a00a4dc33d47f29576f6">AudioProcessorPlayer</a>.</p>
<p>Referenced by <a class="el" href="classAudioProcessorPlayer.html#aab453796aff8eba0ca2abde731746ba7">AudioProcessorPlayer::getDoublePrecisionProcessing()</a>, and <a class="el" href="classAudioSourcePlayer.html#aa705d1a6ee51b4bc1f25bddf8a912d69">AudioSourcePlayer::getGain()</a>.</p>
</div>
</div>
<a id="a1bec2ae89543a93e31461991f7404aec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bec2ae89543a93e31461991f7404aec">§ </a></span>audioDeviceAboutToStart()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AudioIODeviceCallback::audioDeviceAboutToStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAudioIODevice.html">AudioIODevice</a> * </td>
<td class="paramname"><em>device</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to indicate that the device is about to start calling back. </p>
<p>This will be called just before the audio callbacks begin, either when this callback has just been added to an audio device, or after the device has been restarted because of a sample-rate or block-size change.</p>
<p>You can use this opportunity to find out the sample rate and block size that the device is going to use by calling the <a class="el" href="classAudioIODevice.html#afba31b6d244b7cc257e925a04c5c383c" title="Returns the sample rate that the device is currently using. ">AudioIODevice::getCurrentSampleRate()</a> and <a class="el" href="classAudioIODevice.html#af7636fe06f58b58c41bc8575184f518f" title="Returns the buffer size that the device is currently using. ">AudioIODevice::getCurrentBufferSizeSamples()</a> on the supplied pointer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>the audio IO device that will be used to drive the callback. Note that if you're going to store this this pointer, it is only valid until the next time that audioDeviceStopped is called. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classSoundPlayer.html#a655a273e8d700f0b251d5bc732b7dd55">SoundPlayer</a>, <a class="el" href="classAudioSourcePlayer.html#a873c307b234e375b25aa589aba5ebaca">AudioSourcePlayer</a>, and <a class="el" href="classAudioProcessorPlayer.html#a6e86ec16b53690d894d67fd7cfd7fcc4">AudioProcessorPlayer</a>.</p>
<p>Referenced by <a class="el" href="classAudioProcessorPlayer.html#aab453796aff8eba0ca2abde731746ba7">AudioProcessorPlayer::getDoublePrecisionProcessing()</a>, and <a class="el" href="classAudioSourcePlayer.html#aa705d1a6ee51b4bc1f25bddf8a912d69">AudioSourcePlayer::getGain()</a>.</p>
</div>
</div>
<a id="a7b3e3c479e4e0b3b19ea992960ef46f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b3e3c479e4e0b3b19ea992960ef46f5">§ </a></span>audioDeviceStopped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AudioIODeviceCallback::audioDeviceStopped </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to indicate that the device has stopped. </p>
<p>Implemented in <a class="el" href="classSoundPlayer.html#a31316aeaf085210d8c3c9ad516116ce4">SoundPlayer</a>, <a class="el" href="classAudioSourcePlayer.html#a4858c64b3dc045c9fd400ea72bed1898">AudioSourcePlayer</a>, and <a class="el" href="classAudioProcessorPlayer.html#ab7ce7ac03e058c2fe908b98f2889c65b">AudioProcessorPlayer</a>.</p>
<p>Referenced by <a class="el" href="classAudioProcessorPlayer.html#aab453796aff8eba0ca2abde731746ba7">AudioProcessorPlayer::getDoublePrecisionProcessing()</a>, and <a class="el" href="classAudioSourcePlayer.html#aa705d1a6ee51b4bc1f25bddf8a912d69">AudioSourcePlayer::getGain()</a>.</p>
</div>
</div>
<a id="a7768d640daf7d5d56399ced8188b2b75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7768d640daf7d5d56399ced8188b2b75">§ </a></span>audioDeviceError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AudioIODeviceCallback::audioDeviceError </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>errorMessage</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This can be overridden to be told if the device generates an error while operating. </p>
<p>Be aware that this could be called by any thread! And not all devices perform this callback. </p>
<p>Reimplemented in <a class="el" href="classSoundPlayer.html#a2e4fbd35c60ab3af1f46fb9963a433ad">SoundPlayer</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__AudioIODevice_8h.html">juce_AudioIODevice.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|