/usr/share/doc/libjuce/apiref/classBufferingAudioSource.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 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 | <!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: BufferingAudioSource 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="classBufferingAudioSource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BufferingAudioSource Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> which takes another source as input, and buffers it using a thread.
<a href="classBufferingAudioSource.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 BufferingAudioSource:</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="classBufferingAudioSource.png" usemap="#BufferingAudioSource_map" alt=""/>
<map id="BufferingAudioSource_map" name="BufferingAudioSource_map">
<area href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. " alt="PositionableAudioSource" shape="rect" coords="0,56,154,80"/>
<area href="classTimeSliceClient.html" title="Used by the TimeSliceThread class. " alt="TimeSliceClient" shape="rect" coords="164,56,318,80"/>
<area href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. " alt="AudioSource" shape="rect" coords="0,0,154,24"/>
</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:a325821cdc46ccbfcbad4c0c4e224e9f6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#a325821cdc46ccbfcbad4c0c4e224e9f6">BufferingAudioSource</a> (<a class="el" href="classPositionableAudioSource.html">PositionableAudioSource</a> *source, <a class="el" href="classTimeSliceThread.html">TimeSliceThread</a> &backgroundThread, bool deleteSourceWhenDeleted, int numberOfSamplesToBuffer, int numberOfChannels=2, bool prefillBufferOnPrepareToPlay=true)</td></tr>
<tr class="memdesc:a325821cdc46ccbfcbad4c0c4e224e9f6"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classBufferingAudioSource.html" title="An AudioSource which takes another source as input, and buffers it using a thread. ">BufferingAudioSource</a>. <a href="#a325821cdc46ccbfcbad4c0c4e224e9f6">More...</a><br /></td></tr>
<tr class="separator:a325821cdc46ccbfcbad4c0c4e224e9f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2633cef1b35b4d435db60374d7b2859f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#a2633cef1b35b4d435db60374d7b2859f">~BufferingAudioSource</a> ()</td></tr>
<tr class="memdesc:a2633cef1b35b4d435db60374d7b2859f"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2633cef1b35b4d435db60374d7b2859f">More...</a><br /></td></tr>
<tr class="separator:a2633cef1b35b4d435db60374d7b2859f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7fccfe307c0c3f8c4c1af52b97cb6c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#aa7fccfe307c0c3f8c4c1af52b97cb6c1">prepareToPlay</a> (int samplesPerBlockExpected, double sampleRate) override</td></tr>
<tr class="memdesc:aa7fccfe307c0c3f8c4c1af52b97cb6c1"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of the <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> method. <a href="#aa7fccfe307c0c3f8c4c1af52b97cb6c1">More...</a><br /></td></tr>
<tr class="separator:aa7fccfe307c0c3f8c4c1af52b97cb6c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62ec9a6127f4728ecb84464f807b648b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#a62ec9a6127f4728ecb84464f807b648b">releaseResources</a> () override</td></tr>
<tr class="memdesc:a62ec9a6127f4728ecb84464f807b648b"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of the <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> method. <a href="#a62ec9a6127f4728ecb84464f807b648b">More...</a><br /></td></tr>
<tr class="separator:a62ec9a6127f4728ecb84464f807b648b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53ed823e042d3b78ff7f11985d88042c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#a53ed823e042d3b78ff7f11985d88042c">getNextAudioBlock</a> (const <a class="el" href="structAudioSourceChannelInfo.html">AudioSourceChannelInfo</a> &) override</td></tr>
<tr class="memdesc:a53ed823e042d3b78ff7f11985d88042c"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of the <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> method. <a href="#a53ed823e042d3b78ff7f11985d88042c">More...</a><br /></td></tr>
<tr class="separator:a53ed823e042d3b78ff7f11985d88042c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa1d23f64abd488771fea3e6cab68ce2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#aaa1d23f64abd488771fea3e6cab68ce2">setNextReadPosition</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> newPosition) override</td></tr>
<tr class="memdesc:aaa1d23f64abd488771fea3e6cab68ce2"><td class="mdescLeft"> </td><td class="mdescRight">Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. <a href="#aaa1d23f64abd488771fea3e6cab68ce2">More...</a><br /></td></tr>
<tr class="separator:aaa1d23f64abd488771fea3e6cab68ce2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0d8d7021519e011877656c1725accea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#aa0d8d7021519e011877656c1725accea">getNextReadPosition</a> () const override</td></tr>
<tr class="memdesc:aa0d8d7021519e011877656c1725accea"><td class="mdescLeft"> </td><td class="mdescRight">Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. <a href="#aa0d8d7021519e011877656c1725accea">More...</a><br /></td></tr>
<tr class="separator:aa0d8d7021519e011877656c1725accea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9c0838f1c7c8cd5a9f93f72681b3bd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#aa9c0838f1c7c8cd5a9f93f72681b3bd8">getTotalLength</a> () const override</td></tr>
<tr class="memdesc:aa9c0838f1c7c8cd5a9f93f72681b3bd8"><td class="mdescLeft"> </td><td class="mdescRight">Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. <a href="#aa9c0838f1c7c8cd5a9f93f72681b3bd8">More...</a><br /></td></tr>
<tr class="separator:aa9c0838f1c7c8cd5a9f93f72681b3bd8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5db3f567c5b68306f23fb3fed5367c0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#ad5db3f567c5b68306f23fb3fed5367c0">isLooping</a> () const override</td></tr>
<tr class="memdesc:ad5db3f567c5b68306f23fb3fed5367c0"><td class="mdescLeft"> </td><td class="mdescRight">Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. <a href="#ad5db3f567c5b68306f23fb3fed5367c0">More...</a><br /></td></tr>
<tr class="separator:ad5db3f567c5b68306f23fb3fed5367c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b6591413bbb172929fe3514eea14238"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioSource.html#a5b6591413bbb172929fe3514eea14238">waitForNextAudioBlockReady</a> (const <a class="el" href="structAudioSourceChannelInfo.html">AudioSourceChannelInfo</a> &info, const <a class="el" href="juce__MathsFunctions_8h.html#a1134b580f8da4de94ca6b1de4d37975e">uint32</a> timeout)</td></tr>
<tr class="memdesc:a5b6591413bbb172929fe3514eea14238"><td class="mdescLeft"> </td><td class="mdescRight">A useful function to block until the next the buffer info can be filled. <a href="#a5b6591413bbb172929fe3514eea14238">More...</a><br /></td></tr>
<tr class="separator:a5b6591413bbb172929fe3514eea14238"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classPositionableAudioSource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPositionableAudioSource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classPositionableAudioSource.html">PositionableAudioSource</a></td></tr>
<tr class="memitem:aa81c6f032ae672549050b0985a665cf5 inherit pub_methods_classPositionableAudioSource"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPositionableAudioSource.html#aa81c6f032ae672549050b0985a665cf5">~PositionableAudioSource</a> ()</td></tr>
<tr class="memdesc:aa81c6f032ae672549050b0985a665cf5 inherit pub_methods_classPositionableAudioSource"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classPositionableAudioSource.html#aa81c6f032ae672549050b0985a665cf5">More...</a><br /></td></tr>
<tr class="separator:aa81c6f032ae672549050b0985a665cf5 inherit pub_methods_classPositionableAudioSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fba6ce7ef75cfc66c3176a37cda3ba9 inherit pub_methods_classPositionableAudioSource"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPositionableAudioSource.html#a8fba6ce7ef75cfc66c3176a37cda3ba9">setLooping</a> (bool shouldLoop)</td></tr>
<tr class="memdesc:a8fba6ce7ef75cfc66c3176a37cda3ba9 inherit pub_methods_classPositionableAudioSource"><td class="mdescLeft"> </td><td class="mdescRight">Tells the source whether you'd like it to play in a loop. <a href="classPositionableAudioSource.html#a8fba6ce7ef75cfc66c3176a37cda3ba9">More...</a><br /></td></tr>
<tr class="separator:a8fba6ce7ef75cfc66c3176a37cda3ba9 inherit pub_methods_classPositionableAudioSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classAudioSource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAudioSource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAudioSource.html">AudioSource</a></td></tr>
<tr class="memitem:a38b04f6bf7ea63b6cf465213c164623b inherit pub_methods_classAudioSource"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioSource.html#a38b04f6bf7ea63b6cf465213c164623b">~AudioSource</a> ()</td></tr>
<tr class="memdesc:a38b04f6bf7ea63b6cf465213c164623b inherit pub_methods_classAudioSource"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classAudioSource.html#a38b04f6bf7ea63b6cf465213c164623b">More...</a><br /></td></tr>
<tr class="separator:a38b04f6bf7ea63b6cf465213c164623b inherit pub_methods_classAudioSource"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classPositionableAudioSource"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPositionableAudioSource')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classPositionableAudioSource.html">PositionableAudioSource</a></td></tr>
<tr class="memitem:a53821ed920c27c8e81a6695041dd1dca inherit pro_methods_classPositionableAudioSource"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPositionableAudioSource.html#a53821ed920c27c8e81a6695041dd1dca">PositionableAudioSource</a> () noexcept</td></tr>
<tr class="memdesc:a53821ed920c27c8e81a6695041dd1dca inherit pro_methods_classPositionableAudioSource"><td class="mdescLeft"> </td><td class="mdescRight">Creates the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a>. <a href="classPositionableAudioSource.html#a53821ed920c27c8e81a6695041dd1dca">More...</a><br /></td></tr>
<tr class="separator:a53821ed920c27c8e81a6695041dd1dca inherit pro_methods_classPositionableAudioSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classAudioSource"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classAudioSource')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classAudioSource.html">AudioSource</a></td></tr>
<tr class="memitem:a5b8ec7dc3b76d7f219d8f77d5ccfbcef inherit pro_methods_classAudioSource"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioSource.html#a5b8ec7dc3b76d7f219d8f77d5ccfbcef">AudioSource</a> () noexcept</td></tr>
<tr class="memdesc:a5b8ec7dc3b76d7f219d8f77d5ccfbcef inherit pro_methods_classAudioSource"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a>. <a href="classAudioSource.html#a5b8ec7dc3b76d7f219d8f77d5ccfbcef">More...</a><br /></td></tr>
<tr class="separator:a5b8ec7dc3b76d7f219d8f77d5ccfbcef inherit pro_methods_classAudioSource"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> which takes another source as input, and buffers it using a thread. </p>
<p>Create this as a wrapper around another thread, and it will read-ahead with a background thread to smooth out playback. You can either create one of these directly, or use it indirectly using an <a class="el" href="classAudioTransportSource.html" title="An AudioSource that takes a PositionableAudioSource and allows it to be played, stopped, started, etc. ">AudioTransportSource</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a>, <a class="el" href="classAudioTransportSource.html" title="An AudioSource that takes a PositionableAudioSource and allows it to be played, stopped, started, etc. ">AudioTransportSource</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a325821cdc46ccbfcbad4c0c4e224e9f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a325821cdc46ccbfcbad4c0c4e224e9f6">§ </a></span>BufferingAudioSource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BufferingAudioSource::BufferingAudioSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPositionableAudioSource.html">PositionableAudioSource</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTimeSliceThread.html">TimeSliceThread</a> & </td>
<td class="paramname"><em>backgroundThread</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>deleteSourceWhenDeleted</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numberOfSamplesToBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numberOfChannels</em> = <code>2</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>prefillBufferOnPrepareToPlay</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classBufferingAudioSource.html" title="An AudioSource which takes another source as input, and buffers it using a thread. ">BufferingAudioSource</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the input source to read from </td></tr>
<tr><td class="paramname">backgroundThread</td><td>a background thread that will be used for the background read-ahead. This object must not be deleted until after any BufferingAudioSources that are using it have been deleted! </td></tr>
<tr><td class="paramname">deleteSourceWhenDeleted</td><td>if true, then the input source object will be deleted when this object is deleted </td></tr>
<tr><td class="paramname">numberOfSamplesToBuffer</td><td>the size of buffer to use for reading ahead </td></tr>
<tr><td class="paramname">numberOfChannels</td><td>the number of channels that will be played </td></tr>
<tr><td class="paramname">prefillBufferOnPrepareToPlay</td><td>if true, then calling prepareToPlay on this object will block until the buffer has been filled </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2633cef1b35b4d435db60374d7b2859f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2633cef1b35b4d435db60374d7b2859f">§ </a></span>~BufferingAudioSource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BufferingAudioSource::~BufferingAudioSource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>The input source may be deleted depending on whether the deleteSourceWhenDeleted flag was set in the constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa7fccfe307c0c3f8c4c1af52b97cb6c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7fccfe307c0c3f8c4c1af52b97cb6c1">§ </a></span>prepareToPlay()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BufferingAudioSource::prepareToPlay </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>samplesPerBlockExpected</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>sampleRate</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implementation of the <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> method. </p>
<p>Implements <a class="el" href="classAudioSource.html#a653279dbd167f70e318fd280681dbddf">AudioSource</a>.</p>
</div>
</div>
<a id="a62ec9a6127f4728ecb84464f807b648b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62ec9a6127f4728ecb84464f807b648b">§ </a></span>releaseResources()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BufferingAudioSource::releaseResources </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implementation of the <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> method. </p>
<p>Implements <a class="el" href="classAudioSource.html#a7823bf0f1c43333eed41664c7994f290">AudioSource</a>.</p>
</div>
</div>
<a id="a53ed823e042d3b78ff7f11985d88042c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53ed823e042d3b78ff7f11985d88042c">§ </a></span>getNextAudioBlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BufferingAudioSource::getNextAudioBlock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAudioSourceChannelInfo.html">AudioSourceChannelInfo</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implementation of the <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> method. </p>
<p>Implements <a class="el" href="classAudioSource.html#a36fc2484ead8fb8dc03be57d09dd5735">AudioSource</a>.</p>
</div>
</div>
<a id="aaa1d23f64abd488771fea3e6cab68ce2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa1d23f64abd488771fea3e6cab68ce2">§ </a></span>setNextReadPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BufferingAudioSource::setNextReadPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>newPosition</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. </p>
<p>Implements <a class="el" href="classPositionableAudioSource.html#a1d8360d66e08d9491eb1b27c37a330ed">PositionableAudioSource</a>.</p>
</div>
</div>
<a id="aa0d8d7021519e011877656c1725accea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0d8d7021519e011877656c1725accea">§ </a></span>getNextReadPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> BufferingAudioSource::getNextReadPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. </p>
<p>Implements <a class="el" href="classPositionableAudioSource.html#a93fffbfa30a0470c246f6dd2ae8597c6">PositionableAudioSource</a>.</p>
</div>
</div>
<a id="aa9c0838f1c7c8cd5a9f93f72681b3bd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9c0838f1c7c8cd5a9f93f72681b3bd8">§ </a></span>getTotalLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> BufferingAudioSource::getTotalLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. </p>
<p>Implements <a class="el" href="classPositionableAudioSource.html#aa32269d1013b829bb7585e65ce80f08c">PositionableAudioSource</a>.</p>
<p>References <a class="el" href="classPositionableAudioSource.html#aa32269d1013b829bb7585e65ce80f08c">PositionableAudioSource::getTotalLength()</a>.</p>
</div>
</div>
<a id="ad5db3f567c5b68306f23fb3fed5367c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5db3f567c5b68306f23fb3fed5367c0">§ </a></span>isLooping()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool BufferingAudioSource::isLooping </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements the <a class="el" href="classPositionableAudioSource.html" title="A type of AudioSource which can be repositioned. ">PositionableAudioSource</a> method. </p>
<p>Implements <a class="el" href="classPositionableAudioSource.html#a4e59a6b4cfcfb6e8afeea42c25379849">PositionableAudioSource</a>.</p>
<p>References <a class="el" href="classPositionableAudioSource.html#a4e59a6b4cfcfb6e8afeea42c25379849">PositionableAudioSource::isLooping()</a>, <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>, and <a class="el" href="classTimeSliceClient.html#a272b0868c9bd0b5c281cf09dbaa69a9c">TimeSliceClient::useTimeSlice()</a>.</p>
</div>
</div>
<a id="a5b6591413bbb172929fe3514eea14238"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b6591413bbb172929fe3514eea14238">§ </a></span>waitForNextAudioBlockReady()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BufferingAudioSource::waitForNextAudioBlockReady </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAudioSourceChannelInfo.html">AudioSourceChannelInfo</a> & </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="juce__MathsFunctions_8h.html#a1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A useful function to block until the next the buffer info can be filled. </p>
<p>This is useful for offline rendering. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__BufferingAudioSource_8h.html">juce_BufferingAudioSource.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|