/usr/share/doc/libjuce/apiref/classBufferingAudioReader.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 | <!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: BufferingAudioReader 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="classBufferingAudioReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BufferingAudioReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An <a class="el" href="classAudioFormatReader.html" title="Reads samples from an audio file stream. ">AudioFormatReader</a> that uses a background thread to pre-read data from another reader.
<a href="classBufferingAudioReader.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 BufferingAudioReader:</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="classBufferingAudioReader.png" usemap="#BufferingAudioReader_map" alt=""/>
<map id="BufferingAudioReader_map" name="BufferingAudioReader_map">
<area href="classAudioFormatReader.html" title="Reads samples from an audio file stream. " alt="AudioFormatReader" shape="rect" coords="0,0,138,24"/>
<area href="classTimeSliceClient.html" title="Used by the TimeSliceThread class. " alt="TimeSliceClient" shape="rect" coords="148,0,286,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:ab68442def75d9d7b8a1f78883992041c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioReader.html#ab68442def75d9d7b8a1f78883992041c">BufferingAudioReader</a> (<a class="el" href="classAudioFormatReader.html">AudioFormatReader</a> *sourceReader, <a class="el" href="classTimeSliceThread.html">TimeSliceThread</a> &timeSliceThread, int samplesToBuffer)</td></tr>
<tr class="memdesc:ab68442def75d9d7b8a1f78883992041c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader. <a href="#ab68442def75d9d7b8a1f78883992041c">More...</a><br /></td></tr>
<tr class="separator:ab68442def75d9d7b8a1f78883992041c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a568c48a6b62ce2acf4e0e59f7ac78711"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioReader.html#a568c48a6b62ce2acf4e0e59f7ac78711">~BufferingAudioReader</a> ()</td></tr>
<tr class="separator:a568c48a6b62ce2acf4e0e59f7ac78711"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a27246602984c5614b7f708005a9d34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioReader.html#a5a27246602984c5614b7f708005a9d34">setReadTimeout</a> (int timeoutMilliseconds) noexcept</td></tr>
<tr class="memdesc:a5a27246602984c5614b7f708005a9d34"><td class="mdescLeft"> </td><td class="mdescRight">Sets a number of milliseconds that the reader can block for in its <a class="el" href="classBufferingAudioReader.html#a578f7686c957cfb442a5a385c2ebbbeb" title="Subclasses must implement this method to perform the low-level read operation. ">readSamples()</a> method before giving up and returning silence. <a href="#a5a27246602984c5614b7f708005a9d34">More...</a><br /></td></tr>
<tr class="separator:a5a27246602984c5614b7f708005a9d34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a578f7686c957cfb442a5a385c2ebbbeb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBufferingAudioReader.html#a578f7686c957cfb442a5a385c2ebbbeb">readSamples</a> (int **destSamples, int numDestChannels, int startOffsetInDestBuffer, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> startSampleInFile, int numSamples) override</td></tr>
<tr class="memdesc:a578f7686c957cfb442a5a385c2ebbbeb"><td class="mdescLeft"> </td><td class="mdescRight">Subclasses must implement this method to perform the low-level read operation. <a href="#a578f7686c957cfb442a5a385c2ebbbeb">More...</a><br /></td></tr>
<tr class="separator:a578f7686c957cfb442a5a385c2ebbbeb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classAudioFormatReader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAudioFormatReader')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAudioFormatReader.html">AudioFormatReader</a></td></tr>
<tr class="memitem:aa5c4a7c0715e60d829a03b8aa67a8c49 inherit pub_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#aa5c4a7c0715e60d829a03b8aa67a8c49">~AudioFormatReader</a> ()</td></tr>
<tr class="memdesc:aa5c4a7c0715e60d829a03b8aa67a8c49 inherit pub_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classAudioFormatReader.html#aa5c4a7c0715e60d829a03b8aa67a8c49">More...</a><br /></td></tr>
<tr class="separator:aa5c4a7c0715e60d829a03b8aa67a8c49 inherit pub_methods_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae90256289d171f649fd83d2070b4ae32 inherit pub_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#ae90256289d171f649fd83d2070b4ae32">getFormatName</a> () const noexcept</td></tr>
<tr class="memdesc:ae90256289d171f649fd83d2070b4ae32 inherit pub_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Returns a description of what type of format this is. <a href="classAudioFormatReader.html#ae90256289d171f649fd83d2070b4ae32">More...</a><br /></td></tr>
<tr class="separator:ae90256289d171f649fd83d2070b4ae32 inherit pub_methods_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe581e23098c90f1fb187fdff68d3481 inherit pub_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#afe581e23098c90f1fb187fdff68d3481">read</a> (int *const *destSamples, int numDestChannels, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> startSampleInSource, int numSamplesToRead, bool fillLeftoverChannelsWithCopies)</td></tr>
<tr class="memdesc:afe581e23098c90f1fb187fdff68d3481 inherit pub_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Reads samples from the stream. <a href="classAudioFormatReader.html#afe581e23098c90f1fb187fdff68d3481">More...</a><br /></td></tr>
<tr class="separator:afe581e23098c90f1fb187fdff68d3481 inherit pub_methods_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76b621162d046224e14943782c42e090 inherit pub_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#a76b621162d046224e14943782c42e090">read</a> (<a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> *buffer, int startSampleInDestBuffer, int numSamples, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> readerStartSample, bool useReaderLeftChan, bool useReaderRightChan)</td></tr>
<tr class="memdesc:a76b621162d046224e14943782c42e090 inherit pub_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Fills a section of an AudioSampleBuffer from this reader. <a href="classAudioFormatReader.html#a76b621162d046224e14943782c42e090">More...</a><br /></td></tr>
<tr class="separator:a76b621162d046224e14943782c42e090 inherit pub_methods_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafdf75471df1ce853785ecd5fe74b9f7 inherit pub_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#aafdf75471df1ce853785ecd5fe74b9f7">readMaxLevels</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> startSample, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> numSamples, <a class="el" href="classRange.html">Range</a>< float > *results, int numChannelsToRead)</td></tr>
<tr class="memdesc:aafdf75471df1ce853785ecd5fe74b9f7 inherit pub_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Finds the highest and lowest sample levels from a section of the audio stream. <a href="classAudioFormatReader.html#aafdf75471df1ce853785ecd5fe74b9f7">More...</a><br /></td></tr>
<tr class="separator:aafdf75471df1ce853785ecd5fe74b9f7 inherit pub_methods_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6393d5cb57b6a03cb7544df495d86b6 inherit pub_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#aa6393d5cb57b6a03cb7544df495d86b6">readMaxLevels</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> startSample, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> numSamples, float &lowestLeft, float &highestLeft, float &lowestRight, float &highestRight)</td></tr>
<tr class="memdesc:aa6393d5cb57b6a03cb7544df495d86b6 inherit pub_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Finds the highest and lowest sample levels from a section of the audio stream. <a href="classAudioFormatReader.html#aa6393d5cb57b6a03cb7544df495d86b6">More...</a><br /></td></tr>
<tr class="separator:aa6393d5cb57b6a03cb7544df495d86b6 inherit pub_methods_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a088e8f4f625a23a4fd0234eec16ec53a inherit pub_methods_classAudioFormatReader"><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="classAudioFormatReader.html#a088e8f4f625a23a4fd0234eec16ec53a">searchForLevel</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> startSample, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> numSamplesToSearch, double magnitudeRangeMinimum, double magnitudeRangeMaximum, int minimumConsecutiveSamples)</td></tr>
<tr class="memdesc:a088e8f4f625a23a4fd0234eec16ec53a inherit pub_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Scans the source looking for a sample whose magnitude is in a specified range. <a href="classAudioFormatReader.html#a088e8f4f625a23a4fd0234eec16ec53a">More...</a><br /></td></tr>
<tr class="separator:a088e8f4f625a23a4fd0234eec16ec53a inherit pub_methods_classAudioFormatReader"><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 pub_attribs_classAudioFormatReader"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classAudioFormatReader')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classAudioFormatReader.html">AudioFormatReader</a></td></tr>
<tr class="memitem:aafcd07b3ac08e83c019621cd8cd0c7c5 inherit pub_attribs_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#aafcd07b3ac08e83c019621cd8cd0c7c5">sampleRate</a></td></tr>
<tr class="memdesc:aafcd07b3ac08e83c019621cd8cd0c7c5 inherit pub_attribs_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">The sample-rate of the stream. <a href="classAudioFormatReader.html#aafcd07b3ac08e83c019621cd8cd0c7c5">More...</a><br /></td></tr>
<tr class="separator:aafcd07b3ac08e83c019621cd8cd0c7c5 inherit pub_attribs_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa450170dd89d247be8eb1f657b8b47d5 inherit pub_attribs_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#aa450170dd89d247be8eb1f657b8b47d5">bitsPerSample</a></td></tr>
<tr class="memdesc:aa450170dd89d247be8eb1f657b8b47d5 inherit pub_attribs_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">The number of bits per sample, e.g. <a href="classAudioFormatReader.html#aa450170dd89d247be8eb1f657b8b47d5">More...</a><br /></td></tr>
<tr class="separator:aa450170dd89d247be8eb1f657b8b47d5 inherit pub_attribs_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7373fd7e45ed1f026647fc8671e997f inherit pub_attribs_classAudioFormatReader"><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="classAudioFormatReader.html#af7373fd7e45ed1f026647fc8671e997f">lengthInSamples</a></td></tr>
<tr class="memdesc:af7373fd7e45ed1f026647fc8671e997f inherit pub_attribs_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">The total number of samples in the audio stream. <a href="classAudioFormatReader.html#af7373fd7e45ed1f026647fc8671e997f">More...</a><br /></td></tr>
<tr class="separator:af7373fd7e45ed1f026647fc8671e997f inherit pub_attribs_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a7c577b4ececb03d3658fd0625c5b70 inherit pub_attribs_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#a2a7c577b4ececb03d3658fd0625c5b70">numChannels</a></td></tr>
<tr class="memdesc:a2a7c577b4ececb03d3658fd0625c5b70 inherit pub_attribs_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">The total number of channels in the audio stream. <a href="classAudioFormatReader.html#a2a7c577b4ececb03d3658fd0625c5b70">More...</a><br /></td></tr>
<tr class="separator:a2a7c577b4ececb03d3658fd0625c5b70 inherit pub_attribs_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed5e9ba760d519f110c18053d6adba7a inherit pub_attribs_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#aed5e9ba760d519f110c18053d6adba7a">usesFloatingPointData</a></td></tr>
<tr class="memdesc:aed5e9ba760d519f110c18053d6adba7a inherit pub_attribs_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the data is floating-point or fixed. <a href="classAudioFormatReader.html#aed5e9ba760d519f110c18053d6adba7a">More...</a><br /></td></tr>
<tr class="separator:aed5e9ba760d519f110c18053d6adba7a inherit pub_attribs_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8dfe48ed0e171928185c716811f5ecdb inherit pub_attribs_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classStringPairArray.html">StringPairArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#a8dfe48ed0e171928185c716811f5ecdb">metadataValues</a></td></tr>
<tr class="memdesc:a8dfe48ed0e171928185c716811f5ecdb inherit pub_attribs_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">A set of metadata values that the reader has pulled out of the stream. <a href="classAudioFormatReader.html#a8dfe48ed0e171928185c716811f5ecdb">More...</a><br /></td></tr>
<tr class="separator:a8dfe48ed0e171928185c716811f5ecdb inherit pub_attribs_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81797ede6915ec762408d8ed23ec4d10 inherit pub_attribs_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classInputStream.html">InputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#a81797ede6915ec762408d8ed23ec4d10">input</a></td></tr>
<tr class="memdesc:a81797ede6915ec762408d8ed23ec4d10 inherit pub_attribs_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">The input stream, for use by subclasses. <a href="classAudioFormatReader.html#a81797ede6915ec762408d8ed23ec4d10">More...</a><br /></td></tr>
<tr class="separator:a81797ede6915ec762408d8ed23ec4d10 inherit pub_attribs_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classAudioFormatReader"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classAudioFormatReader')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classAudioFormatReader.html">AudioFormatReader</a></td></tr>
<tr class="memitem:a2dfb6080eb01440fa8e8dde6b7baf5c6 inherit pro_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#a2dfb6080eb01440fa8e8dde6b7baf5c6">AudioFormatReader</a> (<a class="el" href="classInputStream.html">InputStream</a> *sourceStream, const <a class="el" href="classString.html">String</a> &formatName)</td></tr>
<tr class="memdesc:a2dfb6080eb01440fa8e8dde6b7baf5c6 inherit pro_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classAudioFormatReader.html" title="Reads samples from an audio file stream. ">AudioFormatReader</a> object. <a href="classAudioFormatReader.html#a2dfb6080eb01440fa8e8dde6b7baf5c6">More...</a><br /></td></tr>
<tr class="separator:a2dfb6080eb01440fa8e8dde6b7baf5c6 inherit pro_methods_classAudioFormatReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_static_methods_classAudioFormatReader"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_classAudioFormatReader')"><img src="closed.png" alt="-"/> Static Protected Member Functions inherited from <a class="el" href="classAudioFormatReader.html">AudioFormatReader</a></td></tr>
<tr class="memitem:a263fd3b6a51850da53fe57688f9ccb46 inherit pro_static_methods_classAudioFormatReader"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioFormatReader.html#a263fd3b6a51850da53fe57688f9ccb46">clearSamplesBeyondAvailableLength</a> (int **destSamples, int numDestChannels, int startOffsetInDestBuffer, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> startSampleInFile, int &numSamples, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> fileLengthInSamples)</td></tr>
<tr class="memdesc:a263fd3b6a51850da53fe57688f9ccb46 inherit pro_static_methods_classAudioFormatReader"><td class="mdescLeft"> </td><td class="mdescRight">Used by <a class="el" href="classAudioFormatReader.html" title="Reads samples from an audio file stream. ">AudioFormatReader</a> subclasses to clear any parts of the data blocks that lie beyond the end of their available length. <a href="classAudioFormatReader.html#a263fd3b6a51850da53fe57688f9ccb46">More...</a><br /></td></tr>
<tr class="separator:a263fd3b6a51850da53fe57688f9ccb46 inherit pro_static_methods_classAudioFormatReader"><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="classAudioFormatReader.html" title="Reads samples from an audio file stream. ">AudioFormatReader</a> that uses a background thread to pre-read data from another reader. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioFormatReader.html" title="Reads samples from an audio file stream. ">AudioFormatReader</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab68442def75d9d7b8a1f78883992041c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab68442def75d9d7b8a1f78883992041c">§ </a></span>BufferingAudioReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BufferingAudioReader::BufferingAudioReader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAudioFormatReader.html">AudioFormatReader</a> * </td>
<td class="paramname"><em>sourceReader</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>timeSliceThread</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>samplesToBuffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a reader. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sourceReader</td><td>the source reader to wrap. This <a class="el" href="classBufferingAudioReader.html" title="An AudioFormatReader that uses a background thread to pre-read data from another reader. ">BufferingAudioReader</a> takes ownership of this object and will delete it later when no longer needed </td></tr>
<tr><td class="paramname">timeSliceThread</td><td>the thread that should be used to do the background reading. Make sure that the thread you supply is running, and won't be deleted while the reader object still exists. </td></tr>
<tr><td class="paramname">samplesToBuffer</td><td>the total number of samples to buffer ahead. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a568c48a6b62ce2acf4e0e59f7ac78711"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a568c48a6b62ce2acf4e0e59f7ac78711">§ </a></span>~BufferingAudioReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BufferingAudioReader::~BufferingAudioReader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5a27246602984c5614b7f708005a9d34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a27246602984c5614b7f708005a9d34">§ </a></span>setReadTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BufferingAudioReader::setReadTimeout </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeoutMilliseconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a number of milliseconds that the reader can block for in its <a class="el" href="classBufferingAudioReader.html#a578f7686c957cfb442a5a385c2ebbbeb" title="Subclasses must implement this method to perform the low-level read operation. ">readSamples()</a> method before giving up and returning silence. </p>
<p>A value of less that 0 means "wait forever". The default timeout is 0. </p>
</div>
</div>
<a id="a578f7686c957cfb442a5a385c2ebbbeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a578f7686c957cfb442a5a385c2ebbbeb">§ </a></span>readSamples()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool BufferingAudioReader::readSamples </td>
<td>(</td>
<td class="paramtype">int ** </td>
<td class="paramname"><em>destSamples</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numDestChannels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>startOffsetInDestBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>startSampleInFile</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Subclasses must implement this method to perform the low-level read operation. </p>
<p>Callers should use <a class="el" href="classAudioFormatReader.html#afe581e23098c90f1fb187fdff68d3481" title="Reads samples from the stream. ">read()</a> instead of calling this directly.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destSamples</td><td>the array of destination buffers to fill. Some of these pointers may be null </td></tr>
<tr><td class="paramname">numDestChannels</td><td>the number of items in the destSamples array. This value is guaranteed not to be greater than the number of channels that this reader object contains </td></tr>
<tr><td class="paramname">startOffsetInDestBuffer</td><td>the number of samples from the start of the dest data at which to begin writing </td></tr>
<tr><td class="paramname">startSampleInFile</td><td>the number of samples into the source data at which to begin reading. This value is guaranteed to be >= 0. </td></tr>
<tr><td class="paramname">numSamples</td><td>the number of samples to read </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classAudioFormatReader.html#a8447eed7f81e0b931248a8eb98ed106f">AudioFormatReader</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__BufferingAudioFormatReader_8h.html">juce_BufferingAudioFormatReader.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|