/usr/share/doc/libjuce/apiref/structAudioSourceChannelInfo.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 | <!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: AudioSourceChannelInfo Struct 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="#pub-attribs">Public Attributes</a> |
<a href="structAudioSourceChannelInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AudioSourceChannelInfo Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used by <a class="el" href="classAudioSource.html#a36fc2484ead8fb8dc03be57d09dd5735" title="Called repeatedly to fetch subsequent blocks of audio data. ">AudioSource::getNextAudioBlock()</a>.
<a href="structAudioSourceChannelInfo.html#details">More...</a></p>
<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:ab6cb8323683ddb2e9170c96aedfb4e6f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioSourceChannelInfo.html#ab6cb8323683ddb2e9170c96aedfb4e6f">AudioSourceChannelInfo</a> () noexcept</td></tr>
<tr class="memdesc:ab6cb8323683ddb2e9170c96aedfb4e6f"><td class="mdescLeft"> </td><td class="mdescRight">Creates an uninitialised <a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a>. <a href="#ab6cb8323683ddb2e9170c96aedfb4e6f">More...</a><br /></td></tr>
<tr class="separator:ab6cb8323683ddb2e9170c96aedfb4e6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0076062656d54e026c971aafc6051d50"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioSourceChannelInfo.html#a0076062656d54e026c971aafc6051d50">AudioSourceChannelInfo</a> (<a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> *bufferToUse, int startSampleOffset, int numSamplesToUse) noexcept</td></tr>
<tr class="memdesc:a0076062656d54e026c971aafc6051d50"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a>. <a href="#a0076062656d54e026c971aafc6051d50">More...</a><br /></td></tr>
<tr class="separator:a0076062656d54e026c971aafc6051d50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae486e3eb8d0b4e53b279793d5d03dc19"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioSourceChannelInfo.html#ae486e3eb8d0b4e53b279793d5d03dc19">AudioSourceChannelInfo</a> (<a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> &bufferToUse) noexcept</td></tr>
<tr class="memdesc:ae486e3eb8d0b4e53b279793d5d03dc19"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a> that uses the whole of a buffer. <a href="#ae486e3eb8d0b4e53b279793d5d03dc19">More...</a><br /></td></tr>
<tr class="separator:ae486e3eb8d0b4e53b279793d5d03dc19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6246ca9f1f6ef86dab31fc0eeaacb7a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioSourceChannelInfo.html#a6246ca9f1f6ef86dab31fc0eeaacb7a3">clearActiveBufferRegion</a> () const</td></tr>
<tr class="memdesc:a6246ca9f1f6ef86dab31fc0eeaacb7a3"><td class="mdescLeft"> </td><td class="mdescRight">Convenient method to clear the buffer if the source is not producing any data. <a href="#a6246ca9f1f6ef86dab31fc0eeaacb7a3">More...</a><br /></td></tr>
<tr class="separator:a6246ca9f1f6ef86dab31fc0eeaacb7a3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:abed0807b4447de67b8ffd29ef2f2d2d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioSourceChannelInfo.html#abed0807b4447de67b8ffd29ef2f2d2d1">buffer</a></td></tr>
<tr class="memdesc:abed0807b4447de67b8ffd29ef2f2d2d1"><td class="mdescLeft"> </td><td class="mdescRight">The destination buffer to fill with audio data. <a href="#abed0807b4447de67b8ffd29ef2f2d2d1">More...</a><br /></td></tr>
<tr class="separator:abed0807b4447de67b8ffd29ef2f2d2d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42e88ccc05d4893015e2415785390259"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioSourceChannelInfo.html#a42e88ccc05d4893015e2415785390259">startSample</a></td></tr>
<tr class="memdesc:a42e88ccc05d4893015e2415785390259"><td class="mdescLeft"> </td><td class="mdescRight">The first sample in the buffer from which the callback is expected to write data. <a href="#a42e88ccc05d4893015e2415785390259">More...</a><br /></td></tr>
<tr class="separator:a42e88ccc05d4893015e2415785390259"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6669c809cf3b47afa94af63d4fa48101"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioSourceChannelInfo.html#a6669c809cf3b47afa94af63d4fa48101">numSamples</a></td></tr>
<tr class="memdesc:a6669c809cf3b47afa94af63d4fa48101"><td class="mdescLeft"> </td><td class="mdescRight">The number of samples in the buffer which the callback is expected to fill with data. <a href="#a6669c809cf3b47afa94af63d4fa48101">More...</a><br /></td></tr>
<tr class="separator:a6669c809cf3b47afa94af63d4fa48101"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used by <a class="el" href="classAudioSource.html#a36fc2484ead8fb8dc03be57d09dd5735" title="Called repeatedly to fetch subsequent blocks of audio data. ">AudioSource::getNextAudioBlock()</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab6cb8323683ddb2e9170c96aedfb4e6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6cb8323683ddb2e9170c96aedfb4e6f">§ </a></span>AudioSourceChannelInfo() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AudioSourceChannelInfo::AudioSourceChannelInfo </td>
<td>(</td>
<td class="paramname"></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>Creates an uninitialised <a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a>. </p>
</div>
</div>
<a id="a0076062656d54e026c971aafc6051d50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0076062656d54e026c971aafc6051d50">§ </a></span>AudioSourceChannelInfo() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AudioSourceChannelInfo::AudioSourceChannelInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> * </td>
<td class="paramname"><em>bufferToUse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>startSampleOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numSamplesToUse</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a>. </p>
</div>
</div>
<a id="ae486e3eb8d0b4e53b279793d5d03dc19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae486e3eb8d0b4e53b279793d5d03dc19">§ </a></span>AudioSourceChannelInfo() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AudioSourceChannelInfo::AudioSourceChannelInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a> & </td>
<td class="paramname"><em>bufferToUse</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a> that uses the whole of a buffer. </p>
<p>Note that the buffer provided must not be deleted while the <a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a> is still using it. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6246ca9f1f6ef86dab31fc0eeaacb7a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6246ca9f1f6ef86dab31fc0eeaacb7a3">§ </a></span>clearActiveBufferRegion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioSourceChannelInfo::clearActiveBufferRegion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenient method to clear the buffer if the source is not producing any data. </p>
<p>References <a class="el" href="classAudioBuffer.html#a7dcadc4a02b048ae99166b5b306e552a">AudioBuffer< Type >::clear()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abed0807b4447de67b8ffd29ef2f2d2d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abed0807b4447de67b8ffd29ef2f2d2d1">§ </a></span>buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="juce__AudioSampleBuffer_8h.html#a97a2916214efbd76c6b870f9c48efba0">AudioSampleBuffer</a>* AudioSourceChannelInfo::buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>The destination buffer to fill with audio data. </p>
<p>When the <a class="el" href="classAudioSource.html#a36fc2484ead8fb8dc03be57d09dd5735" title="Called repeatedly to fetch subsequent blocks of audio data. ">AudioSource::getNextAudioBlock()</a> method is called, the active section of this buffer should be filled with whatever output the source produces.</p>
<p>Only the samples specified by the startSample and numSamples members of this structure should be affected by the call.</p>
<p>The contents of the buffer when it is passed to the <a class="el" href="classAudioSource.html#a36fc2484ead8fb8dc03be57d09dd5735" title="Called repeatedly to fetch subsequent blocks of audio data. ">AudioSource::getNextAudioBlock()</a> method can be treated as the input if the source is performing some kind of filter operation, but should be cleared if this is not the case - the <a class="el" href="structAudioSourceChannelInfo.html#a6246ca9f1f6ef86dab31fc0eeaacb7a3" title="Convenient method to clear the buffer if the source is not producing any data. ">clearActiveBufferRegion()</a> is a handy way of doing this.</p>
<p>The number of channels in the buffer could be anything, so the <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> must cope with this in whatever way is appropriate for its function. </p>
</div>
</div>
<a id="a42e88ccc05d4893015e2415785390259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42e88ccc05d4893015e2415785390259">§ </a></span>startSample</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int AudioSourceChannelInfo::startSample</td>
</tr>
</table>
</div><div class="memdoc">
<p>The first sample in the buffer from which the callback is expected to write data. </p>
</div>
</div>
<a id="a6669c809cf3b47afa94af63d4fa48101"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6669c809cf3b47afa94af63d4fa48101">§ </a></span>numSamples</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int AudioSourceChannelInfo::numSamples</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of samples in the buffer which the callback is expected to fill with data. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="juce__AudioSource_8h.html">juce_AudioSource.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|