/usr/share/doc/libjuce/apiref/classChannelRemappingAudioSource.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 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 | <!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: ChannelRemappingAudioSource 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="classChannelRemappingAudioSource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ChannelRemappingAudioSource 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> that takes the audio from another source, and re-maps its input and output channels to a different arrangement.
<a href="classChannelRemappingAudioSource.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 ChannelRemappingAudioSource:</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="classChannelRemappingAudioSource.png" usemap="#ChannelRemappingAudioSource_map" alt=""/>
<map id="ChannelRemappingAudioSource_map" name="ChannelRemappingAudioSource_map">
<area href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. " alt="AudioSource" shape="rect" coords="0,0,195,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:ad6cfa532e77dc3993a0516cae1623b2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#ad6cfa532e77dc3993a0516cae1623b2b">ChannelRemappingAudioSource</a> (<a class="el" href="classAudioSource.html">AudioSource</a> *source, bool deleteSourceWhenDeleted)</td></tr>
<tr class="memdesc:ad6cfa532e77dc3993a0516cae1623b2b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a remapping source that will pass on audio from the given input. <a href="#ad6cfa532e77dc3993a0516cae1623b2b">More...</a><br /></td></tr>
<tr class="separator:ad6cfa532e77dc3993a0516cae1623b2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac95f5a646e2c8ad1fb90a69c1f251a65"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#ac95f5a646e2c8ad1fb90a69c1f251a65">~ChannelRemappingAudioSource</a> ()</td></tr>
<tr class="memdesc:ac95f5a646e2c8ad1fb90a69c1f251a65"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac95f5a646e2c8ad1fb90a69c1f251a65">More...</a><br /></td></tr>
<tr class="separator:ac95f5a646e2c8ad1fb90a69c1f251a65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8af553519941d35644aa5373fde05acb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a8af553519941d35644aa5373fde05acb">setNumberOfChannelsToProduce</a> (int requiredNumberOfChannels)</td></tr>
<tr class="memdesc:a8af553519941d35644aa5373fde05acb"><td class="mdescLeft"> </td><td class="mdescRight">Specifies a number of channels that this audio source must produce from its <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> callback. <a href="#a8af553519941d35644aa5373fde05acb">More...</a><br /></td></tr>
<tr class="separator:a8af553519941d35644aa5373fde05acb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a373b386b0873abccac53601fa0760f2c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a373b386b0873abccac53601fa0760f2c">clearAllMappings</a> ()</td></tr>
<tr class="memdesc:a373b386b0873abccac53601fa0760f2c"><td class="mdescLeft"> </td><td class="mdescRight">Clears any mapped channels. <a href="#a373b386b0873abccac53601fa0760f2c">More...</a><br /></td></tr>
<tr class="separator:a373b386b0873abccac53601fa0760f2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d2601cc888b1c4d19ed4bcd4877cc53"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a6d2601cc888b1c4d19ed4bcd4877cc53">setInputChannelMapping</a> (int destChannelIndex, int sourceChannelIndex)</td></tr>
<tr class="memdesc:a6d2601cc888b1c4d19ed4bcd4877cc53"><td class="mdescLeft"> </td><td class="mdescRight">Creates an input channel mapping. <a href="#a6d2601cc888b1c4d19ed4bcd4877cc53">More...</a><br /></td></tr>
<tr class="separator:a6d2601cc888b1c4d19ed4bcd4877cc53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a319830bf0ca0a05bf60d070cf3d2ab3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a319830bf0ca0a05bf60d070cf3d2ab3a">setOutputChannelMapping</a> (int sourceChannelIndex, int destChannelIndex)</td></tr>
<tr class="memdesc:a319830bf0ca0a05bf60d070cf3d2ab3a"><td class="mdescLeft"> </td><td class="mdescRight">Creates an output channel mapping. <a href="#a319830bf0ca0a05bf60d070cf3d2ab3a">More...</a><br /></td></tr>
<tr class="separator:a319830bf0ca0a05bf60d070cf3d2ab3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7af98a7fc316993a9905b9ebcf093ea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#ae7af98a7fc316993a9905b9ebcf093ea">getRemappedInputChannel</a> (int inputChannelIndex) const</td></tr>
<tr class="memdesc:ae7af98a7fc316993a9905b9ebcf093ea"><td class="mdescLeft"> </td><td class="mdescRight">Returns the channel from our input that will be sent to channel inputChannelIndex of our input audio source. <a href="#ae7af98a7fc316993a9905b9ebcf093ea">More...</a><br /></td></tr>
<tr class="separator:ae7af98a7fc316993a9905b9ebcf093ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a383a3b8bf348a9edd7aabb9895d811cc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a383a3b8bf348a9edd7aabb9895d811cc">getRemappedOutputChannel</a> (int outputChannelIndex) const</td></tr>
<tr class="memdesc:a383a3b8bf348a9edd7aabb9895d811cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the output channel to which channel outputChannelIndex of our input audio source will be sent to. <a href="#a383a3b8bf348a9edd7aabb9895d811cc">More...</a><br /></td></tr>
<tr class="separator:a383a3b8bf348a9edd7aabb9895d811cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b4f4a9a065b2570a2425296efced0b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a8b4f4a9a065b2570a2425296efced0b1">createXml</a> () const</td></tr>
<tr class="memdesc:a8b4f4a9a065b2570a2425296efced0b1"><td class="mdescLeft"> </td><td class="mdescRight">Returns an XML object to encapsulate the state of the mappings. <a href="#a8b4f4a9a065b2570a2425296efced0b1">More...</a><br /></td></tr>
<tr class="separator:a8b4f4a9a065b2570a2425296efced0b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bb3bd5bc67e413e9c143c64ba904125"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a2bb3bd5bc67e413e9c143c64ba904125">restoreFromXml</a> (const <a class="el" href="classXmlElement.html">XmlElement</a> &)</td></tr>
<tr class="memdesc:a2bb3bd5bc67e413e9c143c64ba904125"><td class="mdescLeft"> </td><td class="mdescRight">Restores the mappings from an XML object created by createXML(). <a href="#a2bb3bd5bc67e413e9c143c64ba904125">More...</a><br /></td></tr>
<tr class="separator:a2bb3bd5bc67e413e9c143c64ba904125"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe7b07c27ff2987fd6968f1db40caafa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#abe7b07c27ff2987fd6968f1db40caafa">prepareToPlay</a> (int samplesPerBlockExpected, double sampleRate) override</td></tr>
<tr class="memdesc:abe7b07c27ff2987fd6968f1db40caafa"><td class="mdescLeft"> </td><td class="mdescRight">Tells the source to prepare for playing. <a href="#abe7b07c27ff2987fd6968f1db40caafa">More...</a><br /></td></tr>
<tr class="separator:abe7b07c27ff2987fd6968f1db40caafa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adec9a1e901cc8b88626f02aaa5582a85"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#adec9a1e901cc8b88626f02aaa5582a85">releaseResources</a> () override</td></tr>
<tr class="memdesc:adec9a1e901cc8b88626f02aaa5582a85"><td class="mdescLeft"> </td><td class="mdescRight">Allows the source to release anything it no longer needs after playback has stopped. <a href="#adec9a1e901cc8b88626f02aaa5582a85">More...</a><br /></td></tr>
<tr class="separator:adec9a1e901cc8b88626f02aaa5582a85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7cc4e508799f79e4a7c750ea7a3c23f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3">getNextAudioBlock</a> (const <a class="el" href="structAudioSourceChannelInfo.html">AudioSourceChannelInfo</a> &) override</td></tr>
<tr class="memdesc:a7cc4e508799f79e4a7c750ea7a3c23f3"><td class="mdescLeft"> </td><td class="mdescRight">Called repeatedly to fetch subsequent blocks of audio data. <a href="#a7cc4e508799f79e4a7c750ea7a3c23f3">More...</a><br /></td></tr>
<tr class="separator:a7cc4e508799f79e4a7c750ea7a3c23f3"><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_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> that takes the audio from another source, and re-maps its input and output channels to a different arrangement. </p>
<p>You can use this to increase or decrease the number of channels that an audio source uses, or to re-order those channels.</p>
<p>Call the reset() method before using it to set up a default mapping, and then the <a class="el" href="classChannelRemappingAudioSource.html#a6d2601cc888b1c4d19ed4bcd4877cc53" title="Creates an input channel mapping. ">setInputChannelMapping()</a> and <a class="el" href="classChannelRemappingAudioSource.html#a319830bf0ca0a05bf60d070cf3d2ab3a" title="Creates an output channel mapping. ">setOutputChannelMapping()</a> methods to create an appropriate mapping, otherwise no channels will be connected and it'll produce silence.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad6cfa532e77dc3993a0516cae1623b2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6cfa532e77dc3993a0516cae1623b2b">§ </a></span>ChannelRemappingAudioSource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ChannelRemappingAudioSource::ChannelRemappingAudioSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAudioSource.html">AudioSource</a> * </td>
<td class="paramname"><em>source</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a remapping source that will pass on audio from the given input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the input source to use. Make sure that this doesn't get deleted before the <a class="el" href="classChannelRemappingAudioSource.html" title="An AudioSource that takes the audio from another source, and re-maps its input and output channels to...">ChannelRemappingAudioSource</a> object </td></tr>
<tr><td class="paramname">deleteSourceWhenDeleted</td><td>if true, the input source will be deleted when this object is deleted, if false, the caller is responsible for its deletion </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac95f5a646e2c8ad1fb90a69c1f251a65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac95f5a646e2c8ad1fb90a69c1f251a65">§ </a></span>~ChannelRemappingAudioSource()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ChannelRemappingAudioSource::~ChannelRemappingAudioSource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8af553519941d35644aa5373fde05acb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8af553519941d35644aa5373fde05acb">§ </a></span>setNumberOfChannelsToProduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChannelRemappingAudioSource::setNumberOfChannelsToProduce </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>requiredNumberOfChannels</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies a number of channels that this audio source must produce from its <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> callback. </p>
</div>
</div>
<a id="a373b386b0873abccac53601fa0760f2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a373b386b0873abccac53601fa0760f2c">§ </a></span>clearAllMappings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChannelRemappingAudioSource::clearAllMappings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears any mapped channels. </p>
<p>After this, no channels are mapped, so this object will produce silence. Create some mappings with <a class="el" href="classChannelRemappingAudioSource.html#a6d2601cc888b1c4d19ed4bcd4877cc53" title="Creates an input channel mapping. ">setInputChannelMapping()</a> and <a class="el" href="classChannelRemappingAudioSource.html#a319830bf0ca0a05bf60d070cf3d2ab3a" title="Creates an output channel mapping. ">setOutputChannelMapping()</a>. </p>
</div>
</div>
<a id="a6d2601cc888b1c4d19ed4bcd4877cc53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d2601cc888b1c4d19ed4bcd4877cc53">§ </a></span>setInputChannelMapping()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChannelRemappingAudioSource::setInputChannelMapping </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>destChannelIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>sourceChannelIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an input channel mapping. </p>
<p>When the <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> method is called, the data in channel sourceChannelIndex of the incoming data will be sent to destChannelIndex of our input source.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destChannelIndex</td><td>the index of an input channel in our input audio source (i.e. the source specified when this object was created). </td></tr>
<tr><td class="paramname">sourceChannelIndex</td><td>the index of the input channel in the incoming audio data buffer during our <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> callback </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a319830bf0ca0a05bf60d070cf3d2ab3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a319830bf0ca0a05bf60d070cf3d2ab3a">§ </a></span>setOutputChannelMapping()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChannelRemappingAudioSource::setOutputChannelMapping </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sourceChannelIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>destChannelIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an output channel mapping. </p>
<p>When the <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> method is called, the data returned in channel sourceChannelIndex by our input audio source will be copied to channel destChannelIndex of the final buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sourceChannelIndex</td><td>the index of an output channel coming from our input audio source (i.e. the source specified when this object was created). </td></tr>
<tr><td class="paramname">destChannelIndex</td><td>the index of the output channel in the incoming audio data buffer during our <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> callback </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae7af98a7fc316993a9905b9ebcf093ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7af98a7fc316993a9905b9ebcf093ea">§ </a></span>getRemappedInputChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ChannelRemappingAudioSource::getRemappedInputChannel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>inputChannelIndex</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the channel from our input that will be sent to channel inputChannelIndex of our input audio source. </p>
</div>
</div>
<a id="a383a3b8bf348a9edd7aabb9895d811cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a383a3b8bf348a9edd7aabb9895d811cc">§ </a></span>getRemappedOutputChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ChannelRemappingAudioSource::getRemappedOutputChannel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>outputChannelIndex</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the output channel to which channel outputChannelIndex of our input audio source will be sent to. </p>
</div>
</div>
<a id="a8b4f4a9a065b2570a2425296efced0b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b4f4a9a065b2570a2425296efced0b1">§ </a></span>createXml()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXmlElement.html">XmlElement</a>* ChannelRemappingAudioSource::createXml </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an XML object to encapsulate the state of the mappings. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classChannelRemappingAudioSource.html#a2bb3bd5bc67e413e9c143c64ba904125" title="Restores the mappings from an XML object created by createXML(). ">restoreFromXml</a> </dd></dl>
</div>
</div>
<a id="a2bb3bd5bc67e413e9c143c64ba904125"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bb3bd5bc67e413e9c143c64ba904125">§ </a></span>restoreFromXml()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChannelRemappingAudioSource::restoreFromXml </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXmlElement.html">XmlElement</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restores the mappings from an XML object created by createXML(). </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classChannelRemappingAudioSource.html#a8b4f4a9a065b2570a2425296efced0b1" title="Returns an XML object to encapsulate the state of the mappings. ">createXml</a> </dd></dl>
</div>
</div>
<a id="abe7b07c27ff2987fd6968f1db40caafa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe7b07c27ff2987fd6968f1db40caafa">§ </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 ChannelRemappingAudioSource::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>Tells the source to prepare for playing. </p>
<p>An <a class="el" href="classAudioSource.html" title="Base class for objects that can produce a continuous stream of audio. ">AudioSource</a> has two states: prepared and unprepared.</p>
<p>The <a class="el" href="classChannelRemappingAudioSource.html#abe7b07c27ff2987fd6968f1db40caafa" title="Tells the source to prepare for playing. ">prepareToPlay()</a> method is guaranteed to be called at least once on an 'unpreprared' source to put it into a 'prepared' state before any calls will be made to <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a>. This callback allows the source to initialise any resources it might need when playing.</p>
<p>Once playback has finished, the <a class="el" href="classChannelRemappingAudioSource.html#adec9a1e901cc8b88626f02aaa5582a85" title="Allows the source to release anything it no longer needs after playback has stopped. ">releaseResources()</a> method is called to put the stream back into an 'unprepared' state.</p>
<p>Note that this method could be called more than once in succession without a matching call to <a class="el" href="classChannelRemappingAudioSource.html#adec9a1e901cc8b88626f02aaa5582a85" title="Allows the source to release anything it no longer needs after playback has stopped. ">releaseResources()</a>, so make sure your code is robust and can handle that kind of situation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">samplesPerBlockExpected</td><td>the number of samples that the source will be expected to supply each time its <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> method is called. This number may vary slightly, because it will be dependent on audio hardware callbacks, and these aren't guaranteed to always use a constant block size, so the source should be able to cope with small variations. </td></tr>
<tr><td class="paramname">sampleRate</td><td>the sample rate that the output will be used at - this is needed by sources such as tone generators. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classChannelRemappingAudioSource.html#adec9a1e901cc8b88626f02aaa5582a85" title="Allows the source to release anything it no longer needs after playback has stopped. ">releaseResources</a>, <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock</a> </dd></dl>
<p>Implements <a class="el" href="classAudioSource.html#a653279dbd167f70e318fd280681dbddf">AudioSource</a>.</p>
</div>
</div>
<a id="adec9a1e901cc8b88626f02aaa5582a85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adec9a1e901cc8b88626f02aaa5582a85">§ </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 ChannelRemappingAudioSource::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>Allows the source to release anything it no longer needs after playback has stopped. </p>
<p>This will be called when the source is no longer going to have its <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock()</a> method called, so it should release any spare memory, etc. that it might have allocated during the <a class="el" href="classChannelRemappingAudioSource.html#abe7b07c27ff2987fd6968f1db40caafa" title="Tells the source to prepare for playing. ">prepareToPlay()</a> call.</p>
<p>Note that there's no guarantee that <a class="el" href="classChannelRemappingAudioSource.html#abe7b07c27ff2987fd6968f1db40caafa" title="Tells the source to prepare for playing. ">prepareToPlay()</a> will actually have been called before <a class="el" href="classChannelRemappingAudioSource.html#adec9a1e901cc8b88626f02aaa5582a85" title="Allows the source to release anything it no longer needs after playback has stopped. ">releaseResources()</a>, and it may be called more than once in succession, so make sure your code is robust and doesn't make any assumptions about when it will be called.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classChannelRemappingAudioSource.html#abe7b07c27ff2987fd6968f1db40caafa" title="Tells the source to prepare for playing. ">prepareToPlay</a>, <a class="el" href="classChannelRemappingAudioSource.html#a7cc4e508799f79e4a7c750ea7a3c23f3" title="Called repeatedly to fetch subsequent blocks of audio data. ">getNextAudioBlock</a> </dd></dl>
<p>Implements <a class="el" href="classAudioSource.html#a7823bf0f1c43333eed41664c7994f290">AudioSource</a>.</p>
</div>
</div>
<a id="a7cc4e508799f79e4a7c750ea7a3c23f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cc4e508799f79e4a7c750ea7a3c23f3">§ </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 ChannelRemappingAudioSource::getNextAudioBlock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAudioSourceChannelInfo.html">AudioSourceChannelInfo</a> & </td>
<td class="paramname"><em>bufferToFill</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>Called repeatedly to fetch subsequent blocks of audio data. </p>
<p>After calling the <a class="el" href="classChannelRemappingAudioSource.html#abe7b07c27ff2987fd6968f1db40caafa" title="Tells the source to prepare for playing. ">prepareToPlay()</a> method, this callback will be made each time the audio playback hardware (or whatever other destination the audio data is going to) needs another block of data.</p>
<p>It will generally be called on a high-priority system thread, or possibly even an interrupt, so be careful not to do too much work here, as that will cause audio glitches!</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structAudioSourceChannelInfo.html" title="Used by AudioSource::getNextAudioBlock(). ">AudioSourceChannelInfo</a>, <a class="el" href="classChannelRemappingAudioSource.html#abe7b07c27ff2987fd6968f1db40caafa" title="Tells the source to prepare for playing. ">prepareToPlay</a>, <a class="el" href="classChannelRemappingAudioSource.html#adec9a1e901cc8b88626f02aaa5582a85" title="Allows the source to release anything it no longer needs after playback has stopped. ">releaseResources</a> </dd></dl>
<p>Implements <a class="el" href="classAudioSource.html#a36fc2484ead8fb8dc03be57d09dd5735">AudioSource</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ChannelRemappingAudioSource_8h.html">juce_ChannelRemappingAudioSource.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|