mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
193 lines
17 KiB
HTML
193 lines
17 KiB
HTML
<!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: VS1053Config 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&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&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_v_s1053_config.html">VS1053Config</a></li> </ul>
|
|
</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="classaudio__tools_1_1_v_s1053_config-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">VS1053Config Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Configuration for <a class="el" href="classaudio__tools_1_1_v_s1053_stream.html" title="VS1053 Output Interface which processes PCM data by default. If you want to write encoded data set is...">VS1053Stream</a>.
|
|
<a href="classaudio__tools_1_1_v_s1053_config.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_v_s1053_stream_8h_source.html">VS1053Stream.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for VS1053Config:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaudio__tools_1_1_v_s1053_config.png" usemap="#VS1053Config_map" alt=""/>
|
|
<map id="VS1053Config_map" name="VS1053Config_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,94,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:aae048282c7011eedc2e0492f6421ea73"><td class="memItemLeft" align="right" valign="top"><a id="aae048282c7011eedc2e0492f6421ea73"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
|
|
<tr class="separator:aae048282c7011eedc2e0492f6421ea73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a029ace15f5ede8def0a6ab5c97a81b25"><td class="memItemLeft" align="right" valign="top"><a id="a029ace15f5ede8def0a6ab5c97a81b25"></a>
|
|
void </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"> </td><td class="mdescRight">Same as set. <br /></td></tr>
|
|
<tr class="separator:a029ace15f5ede8def0a6ab5c97a81b25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13af68cdfaa4c55e22a600f1a0e75e14"><td class="memItemLeft" align="right" valign="top"><a id="a13af68cdfaa4c55e22a600f1a0e75e14"></a>
|
|
bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a7df9e0539cd3b887e16794a425cc0b1d"><td class="memItemLeft" align="right" valign="top"><a id="a7df9e0539cd3b887e16794a425cc0b1d"></a>
|
|
bool </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"> </td><td class="mdescRight">Checks if only the sample rate is different. <br /></td></tr>
|
|
<tr class="separator:a7df9e0539cd3b887e16794a425cc0b1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab218e07fb15285d0ecc04dc37bd3e3a0"><td class="memItemLeft" align="right" valign="top"><a id="ab218e07fb15285d0ecc04dc37bd3e3a0"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>logInfo</b> (const char *source="")</td></tr>
|
|
<tr class="separator:ab218e07fb15285d0ecc04dc37bd3e3a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b3baad8c612d81b96e46f84d7e97580"><td class="memItemLeft" align="right" valign="top"><a id="a9b3baad8c612d81b96e46f84d7e97580"></a>
|
|
 </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"> </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"> </td></tr>
|
|
<tr class="memitem:a9a8f541005042a6b59c0a6600fd91028"><td class="memItemLeft" align="right" valign="top"><a id="a9a8f541005042a6b59c0a6600fd91028"></a>
|
|
bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a5ad7a6f58eb72354b7c513e12d67632c"><td class="memItemLeft" align="right" valign="top"><a id="a5ad7a6f58eb72354b7c513e12d67632c"></a>
|
|
bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a4c2ab4bf80534844ec220076fcd45952"><td class="memItemLeft" align="right" valign="top"><a id="a4c2ab4bf80534844ec220076fcd45952"></a>
|
|
void </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"> </td><td class="mdescRight">Copies the values from info. <br /></td></tr>
|
|
<tr class="separator:a4c2ab4bf80534844ec220076fcd45952"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e283a9495aaf265739336829d45e215"><td class="memItemLeft" align="right" valign="top"><a id="a5e283a9495aaf265739336829d45e215"></a>
|
|
void </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"> </td><td class="mdescRight">Same as set. <br /></td></tr>
|
|
<tr class="separator:a5e283a9495aaf265739336829d45e215"><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:aa65c89fa8336bfdc4f8d916d9d415a9f"><td class="memItemLeft" align="right" valign="top"><a id="aa65c89fa8336bfdc4f8d916d9d415a9f"></a>
|
|
uint8_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:a1ac7822956f57069d76da865d6b33c55"><td class="memItemLeft" align="right" valign="top"><a id="a1ac7822956f57069d76da865d6b33c55"></a>
|
|
uint16_t </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"> </td><td class="mdescRight">Number of channels: 2=stereo, 1=mono. <br /></td></tr>
|
|
<tr class="separator:a1ac7822956f57069d76da865d6b33c55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed65b23a4e5c39c4267c5730833e70db"><td class="memItemLeft" align="right" valign="top"><a id="aed65b23a4e5c39c4267c5730833e70db"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_v_s1053_config.html#aed65b23a4e5c39c4267c5730833e70db">cs_pin</a> = VS1053_CS</td></tr>
|
|
<tr class="memdesc:aed65b23a4e5c39c4267c5730833e70db"><td class="mdescLeft"> </td><td class="mdescRight">set to false if it is a pcm stream <br /></td></tr>
|
|
<tr class="separator:aed65b23a4e5c39c4267c5730833e70db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79d91298ea62d38eea7ceb2a35ab9aab"><td class="memItemLeft" align="right" valign="top"><a id="a79d91298ea62d38eea7ceb2a35ab9aab"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><b>cs_sd_pin</b> = VS1053_CS_SD</td></tr>
|
|
<tr class="separator:a79d91298ea62d38eea7ceb2a35ab9aab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe7a71051633a5cfc0a4d2a30b6cad0d"><td class="memItemLeft" align="right" valign="top"><a id="abe7a71051633a5cfc0a4d2a30b6cad0d"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>dcs_pin</b> = VS1053_DCS</td></tr>
|
|
<tr class="separator:abe7a71051633a5cfc0a4d2a30b6cad0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fcaa7a3d2232ff499bff304da4fe29f"><td class="memItemLeft" align="right" valign="top"><a id="a0fcaa7a3d2232ff499bff304da4fe29f"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>dreq_pin</b> = VS1053_DREQ</td></tr>
|
|
<tr class="separator:a0fcaa7a3d2232ff499bff304da4fe29f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b14309e060b9f949aaf463b34c71b85"><td class="memItemLeft" align="right" valign="top"><a id="a7b14309e060b9f949aaf463b34c71b85"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_v_s1053_config.html#a7b14309e060b9f949aaf463b34c71b85">is_encoded_data</a> = false</td></tr>
|
|
<tr class="memdesc:a7b14309e060b9f949aaf463b34c71b85"><td class="mdescLeft"> </td><td class="mdescRight">The data is encoded as WAV, MPEG etc. By default this is false and supports PCM data. <br /></td></tr>
|
|
<tr class="separator:a7b14309e060b9f949aaf463b34c71b85"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea157fea730d2a87c178d1bc19c6868d"><td class="memItemLeft" align="right" valign="top"><a id="aea157fea730d2a87c178d1bc19c6868d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_v_s1053_config.html#aea157fea730d2a87c178d1bc19c6868d">is_midi</a> = false</td></tr>
|
|
<tr class="memdesc:aea157fea730d2a87c178d1bc19c6868d"><td class="mdescLeft"> </td><td class="mdescRight">set true for streaming midi <br /></td></tr>
|
|
<tr class="separator:aea157fea730d2a87c178d1bc19c6868d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2c844c92e04a703ca54d15d011630ab"><td class="memItemLeft" align="right" valign="top"><a id="aa2c844c92e04a703ca54d15d011630ab"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_v_s1053_config.html#aa2c844c92e04a703ca54d15d011630ab">is_start_spi</a> = true</td></tr>
|
|
<tr class="memdesc:aa2c844c92e04a703ca54d15d011630ab"><td class="mdescLeft"> </td><td class="mdescRight">SPI.begin is called by the driver (default setting) <br /></td></tr>
|
|
<tr class="separator:aa2c844c92e04a703ca54d15d011630ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca05ff9ab728526f003dc9eed9554ae3"><td class="memItemLeft" align="right" valign="top"><a id="aca05ff9ab728526f003dc9eed9554ae3"></a>
|
|
<a class="el" href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">RxTxMode</a> </td><td class="memItemRight" valign="bottom"><b>mode</b> = TX_MODE</td></tr>
|
|
<tr class="separator:aca05ff9ab728526f003dc9eed9554ae3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad40e44bf24326c37570a21fd2dcd9ac4"><td class="memItemLeft" align="right" valign="top"><a id="ad40e44bf24326c37570a21fd2dcd9ac4"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><b>reset_pin</b> = VS1053_RESET</td></tr>
|
|
<tr class="separator:ad40e44bf24326c37570a21fd2dcd9ac4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e86c53dfa0ad5dc0d2ecd0304fabc95"><td class="memItemLeft" align="right" valign="top"><a id="a0e86c53dfa0ad5dc0d2ecd0304fabc95"></a>
|
|
sample_rate_t </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"> </td><td class="mdescRight">Sample Rate: e.g 44100. <br /></td></tr>
|
|
<tr class="separator:a0e86c53dfa0ad5dc0d2ecd0304fabc95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Configuration for <a class="el" href="classaudio__tools_1_1_v_s1053_stream.html" title="VS1053 Output Interface which processes PCM data by default. If you want to write encoded data set is...">VS1053Stream</a>. </p>
|
|
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 </dd></dl>
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/AudioLibs/<a class="el" href="_v_s1053_stream_8h_source.html">VS1053Stream.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|