arduino/arduino-audio-tools
1
0
Fork 0
mirror of https://github.com/pschatzmann/arduino-audio-tools.git synced 2024-09-21 10:27:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
doxygen
arduino-audio-tools/classaudio__tools_1_1_port_audio_config.html

172 lines
14 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>arduino-audio-tools: PortAudioConfig 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">arduino-audio-tools
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceaudio__tools.html">audio_tools</a></li><li class="navelem"><a class="el" href="classaudio__tools_1_1_port_audio_config.html">PortAudioConfig</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classaudio__tools_1_1_port_audio_config-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PortAudioConfig Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>PortAudio information.
<a href="classaudio__tools_1_1_port_audio_config.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_port_audio_stream_8h_source.html">PortAudioStream.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PortAudioConfig:</div>
<div class="dyncontent">
<div class="center">
<img src="classaudio__tools_1_1_port_audio_config.png" usemap="#PortAudioConfig_map" alt=""/>
<map id="PortAudioConfig_map" name="PortAudioConfig_map">
<area href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S." alt="AudioInfo" shape="rect" coords="0,0,105,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:a7daa8f5a5e736f15bb618dff66191f21"><td class="memItemLeft" align="right" valign="top"><a id="a7daa8f5a5e736f15bb618dff66191f21"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PortAudioConfig</b> (const <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> &amp;in)</td></tr>
<tr class="separator:a7daa8f5a5e736f15bb618dff66191f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7023886539eb0d319a6b484b233bcb5f"><td class="memItemLeft" align="right" valign="top"><a id="a7023886539eb0d319a6b484b233bcb5f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PortAudioConfig</b> (const <a class="el" href="classaudio__tools_1_1_port_audio_config.html">PortAudioConfig</a> &amp;)=default</td></tr>
<tr class="separator:a7023886539eb0d319a6b484b233bcb5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae048282c7011eedc2e0492f6421ea73"><td class="memItemLeft" align="right" valign="top"><a id="aae048282c7011eedc2e0492f6421ea73"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="separator:aae048282c7011eedc2e0492f6421ea73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a029ace15f5ede8def0a6ab5c97a81b25"><td class="memItemLeft" align="right" valign="top"><a id="a029ace15f5ede8def0a6ab5c97a81b25"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a029ace15f5ede8def0a6ab5c97a81b25">copyFrom</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
<tr class="memdesc:a029ace15f5ede8def0a6ab5c97a81b25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as set. <br /></td></tr>
<tr class="separator:a029ace15f5ede8def0a6ab5c97a81b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13af68cdfaa4c55e22a600f1a0e75e14"><td class="memItemLeft" align="right" valign="top"><a id="a13af68cdfaa4c55e22a600f1a0e75e14"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a13af68cdfaa4c55e22a600f1a0e75e14">equals</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> alt)</td></tr>
<tr class="memdesc:a13af68cdfaa4c55e22a600f1a0e75e14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if alt values are the same like the current values. <br /></td></tr>
<tr class="separator:a13af68cdfaa4c55e22a600f1a0e75e14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7df9e0539cd3b887e16794a425cc0b1d"><td class="memItemLeft" align="right" valign="top"><a id="a7df9e0539cd3b887e16794a425cc0b1d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a7df9e0539cd3b887e16794a425cc0b1d">equalsExSampleRate</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> alt)</td></tr>
<tr class="memdesc:a7df9e0539cd3b887e16794a425cc0b1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if only the sample rate is different. <br /></td></tr>
<tr class="separator:a7df9e0539cd3b887e16794a425cc0b1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab218e07fb15285d0ecc04dc37bd3e3a0"><td class="memItemLeft" align="right" valign="top"><a id="ab218e07fb15285d0ecc04dc37bd3e3a0"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>logInfo</b> (const char *source=&quot;&quot;)</td></tr>
<tr class="separator:ab218e07fb15285d0ecc04dc37bd3e3a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b3baad8c612d81b96e46f84d7e97580"><td class="memItemLeft" align="right" valign="top"><a id="a9b3baad8c612d81b96e46f84d7e97580"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a9b3baad8c612d81b96e46f84d7e97580">operator bool</a> ()</td></tr>
<tr class="memdesc:a9b3baad8c612d81b96e46f84d7e97580"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if all components are defined (no component is 0) <br /></td></tr>
<tr class="separator:a9b3baad8c612d81b96e46f84d7e97580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a8f541005042a6b59c0a6600fd91028"><td class="memItemLeft" align="right" valign="top"><a id="a9a8f541005042a6b59c0a6600fd91028"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a9a8f541005042a6b59c0a6600fd91028">operator!=</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> alt)</td></tr>
<tr class="memdesc:a9a8f541005042a6b59c0a6600fd91028"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if alt values are the different from the current values. <br /></td></tr>
<tr class="separator:a9a8f541005042a6b59c0a6600fd91028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ad7a6f58eb72354b7c513e12d67632c"><td class="memItemLeft" align="right" valign="top"><a id="a5ad7a6f58eb72354b7c513e12d67632c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a5ad7a6f58eb72354b7c513e12d67632c">operator==</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> alt)</td></tr>
<tr class="memdesc:a5ad7a6f58eb72354b7c513e12d67632c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if alt values are the same like the current values. <br /></td></tr>
<tr class="separator:a5ad7a6f58eb72354b7c513e12d67632c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c2ab4bf80534844ec220076fcd45952"><td class="memItemLeft" align="right" valign="top"><a id="a4c2ab4bf80534844ec220076fcd45952"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a4c2ab4bf80534844ec220076fcd45952">set</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
<tr class="memdesc:a4c2ab4bf80534844ec220076fcd45952"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the values from info. <br /></td></tr>
<tr class="separator:a4c2ab4bf80534844ec220076fcd45952"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e283a9495aaf265739336829d45e215"><td class="memItemLeft" align="right" valign="top"><a id="a5e283a9495aaf265739336829d45e215"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a5e283a9495aaf265739336829d45e215">setAudioInfo</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
<tr class="memdesc:a5e283a9495aaf265739336829d45e215"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as set. <br /></td></tr>
<tr class="separator:a5e283a9495aaf265739336829d45e215"><td class="memSeparator" colspan="2">&#160;</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:aa65c89fa8336bfdc4f8d916d9d415a9f"><td class="memItemLeft" align="right" valign="top"><a id="aa65c89fa8336bfdc4f8d916d9d415a9f"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#aa65c89fa8336bfdc4f8d916d9d415a9f">bits_per_sample</a> = DEFAULT_BITS_PER_SAMPLE</td></tr>
<tr class="memdesc:aa65c89fa8336bfdc4f8d916d9d415a9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bits per sample (int16_t = 16 bits) <br />
<br /></td></tr>
<tr class="separator:aa65c89fa8336bfdc4f8d916d9d415a9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ac7822956f57069d76da865d6b33c55"><td class="memItemLeft" align="right" valign="top"><a id="a1ac7822956f57069d76da865d6b33c55"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a1ac7822956f57069d76da865d6b33c55">channels</a> = DEFAULT_CHANNELS</td></tr>
<tr class="memdesc:a1ac7822956f57069d76da865d6b33c55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of channels: 2=stereo, 1=mono. <br /></td></tr>
<tr class="separator:a1ac7822956f57069d76da865d6b33c55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8a8ede92285acbe2795e8570b81c9ae"><td class="memItemLeft" align="right" valign="top"><a id="aa8a8ede92285acbe2795e8570b81c9ae"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_input</b> = false</td></tr>
<tr class="separator:aa8a8ede92285acbe2795e8570b81c9ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7464ec491eeba4c23632a6ae583e9429"><td class="memItemLeft" align="right" valign="top"><a id="a7464ec491eeba4c23632a6ae583e9429"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_output</b> = true</td></tr>
<tr class="separator:a7464ec491eeba4c23632a6ae583e9429"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e86c53dfa0ad5dc0d2ecd0304fabc95"><td class="memItemLeft" align="right" valign="top"><a id="a0e86c53dfa0ad5dc0d2ecd0304fabc95"></a>
sample_rate_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__tools_1_1_audio_info.html#a0e86c53dfa0ad5dc0d2ecd0304fabc95">sample_rate</a> = DEFAULT_SAMPLE_RATE</td></tr>
<tr class="memdesc:a0e86c53dfa0ad5dc0d2ecd0304fabc95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sample Rate: e.g 44100. <br /></td></tr>
<tr class="separator:a0e86c53dfa0ad5dc0d2ecd0304fabc95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>PortAudio information. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/AudioLibs/<a class="el" href="_port_audio_stream_8h_source.html">PortAudioStream.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink