Deploying to doxygen from @ 22e457c 🚀

_audio_types_8h_source.html

@@ -94,9 +94,9 @@
 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160; </div>
 <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="group__basic.html#ga462bfa9dfea81692463ecb192183dd01">   33</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__basic.html#ga462bfa9dfea81692463ecb192183dd01">MemoryType</a> {RAM, PS_RAM, FLASH_RAM};</div>
 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160; </div>
-<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespaceaudio__tools.html#acaae0b7e00d518ef0cb903f6c65a20ce">   38</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="namespaceaudio__tools.html#acaae0b7e00d518ef0cb903f6c65a20ce">RxTxModeNames</a>[]={<span class="stringliteral">&quot;UNDEFINED_MODE&quot;</span>,<span class="stringliteral">&quot;TX_MODE&quot;</span>,<span class="stringliteral">&quot;RX_MODE&quot;</span>,<span class="stringliteral">&quot;RXTX_MODE&quot;</span> };</div>
+<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespaceaudio__tools.html#a488e5410a2317335bc89c65de90ab41b">   38</a></span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="namespaceaudio__tools.html#a488e5410a2317335bc89c65de90ab41b">RxTxModeNames</a>[4]={<span class="stringliteral">&quot;UNDEFINED_MODE&quot;</span>,<span class="stringliteral">&quot;TX_MODE&quot;</span>,<span class="stringliteral">&quot;RX_MODE&quot;</span>,<span class="stringliteral">&quot;RXTX_MODE&quot;</span> };</div>
 <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="group__basic.html#gadd9fe45e09605eee3e4a39c8a5c4476d">   43</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__basic.html#gadd9fe45e09605eee3e4a39c8a5c4476d">TimeUnit</a> {MS, US, HZ};</div>
-<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* TimeUnitStr[] {<span class="stringliteral">&quot;MS&quot;</span>,<span class="stringliteral">&quot;US&quot;</span>,<span class="stringliteral">&quot;HZ&quot;</span>};</div>
+<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* TimeUnitStr[3] {<span class="stringliteral">&quot;MS&quot;</span>,<span class="stringliteral">&quot;US&quot;</span>,<span class="stringliteral">&quot;HZ&quot;</span>};</div>
 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160; </div>
 <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structaudio__tools_1_1_audio_info.html">   50</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> {</div>
 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
@@ -521,10 +521,10 @@
 <div class="ttc" id="anamespaceaudio__tools_html_a1d3846b210a1698eaf7cdb7258fcc3e1"><div class="ttname"><a href="namespaceaudio__tools.html#a1d3846b210a1698eaf7cdb7258fcc3e1">audio_tools::I2SSignalType</a></div><div class="ttdeci">I2SSignalType</div><div class="ttdoc">I2S Signal Types: Digital, Analog, PDM.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:406</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a2320e2f14f2ac363a4eb3fafd8c5afa7"><div class="ttname"><a href="namespaceaudio__tools.html#a2320e2f14f2ac363a4eb3fafd8c5afa7">audio_tools::mapFloat</a></div><div class="ttdeci">float mapFloat(float x, float in_min, float in_max, float out_min, float out_max)</div><div class="ttdoc">Similar to Arduino map function but using floats.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:484</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a3961afb9c2a414e91d5687346be60285"><div class="ttname"><a href="namespaceaudio__tools.html#a3961afb9c2a414e91d5687346be60285">audio_tools::mime_pcm</a></div><div class="ttdeci">static const char * mime_pcm</div><div class="ttdoc">Mime type for PCM.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:489</div></div>
+<div class="ttc" id="anamespaceaudio__tools_html_a488e5410a2317335bc89c65de90ab41b"><div class="ttname"><a href="namespaceaudio__tools.html#a488e5410a2317335bc89c65de90ab41b">audio_tools::RxTxModeNames</a></div><div class="ttdeci">static const char * RxTxModeNames[4]</div><div class="ttdoc">Text string (description) for RxTxMode.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:38</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a4ce58b1cf7c8f2758bd2f7ac29d8bd5d"><div class="ttname"><a href="namespaceaudio__tools.html#a4ce58b1cf7c8f2758bd2f7ac29d8bd5d">audio_tools::readSample</a></div><div class="ttdeci">T readSample(Stream *p_stream)</div><div class="ttdoc">guaranteed to return the requested data</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:419</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a5e3b5cd9da90a770b25160f8b0126982"><div class="ttname"><a href="namespaceaudio__tools.html#a5e3b5cd9da90a770b25160f8b0126982">audio_tools::millis</a></div><div class="ttdeci">uint32_t millis()</div><div class="ttdoc">Returns the milliseconds since the start.</div><div class="ttdef"><b>Definition:</b> Time.h:12</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a720616ce211566d808f3e441f9b18cda"><div class="ttname"><a href="namespaceaudio__tools.html#a720616ce211566d808f3e441f9b18cda">audio_tools::I2SFormat</a></div><div class="ttdeci">I2SFormat</div><div class="ttdoc">I2S Formats.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:391</div></div>
-<div class="ttc" id="anamespaceaudio__tools_html_acaae0b7e00d518ef0cb903f6c65a20ce"><div class="ttname"><a href="namespaceaudio__tools.html#acaae0b7e00d518ef0cb903f6c65a20ce">audio_tools::RxTxModeNames</a></div><div class="ttdeci">static const char * RxTxModeNames[]</div><div class="ttdoc">Text string (description) for RxTxMode.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:38</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_ae4bf1846916254f6051fdf1437159163"><div class="ttname"><a href="namespaceaudio__tools.html#ae4bf1846916254f6051fdf1437159163">audio_tools::writeSamples</a></div><div class="ttdeci">size_t writeSamples(Print *p_out, T *data, int samples, int maxSamples=512)</div><div class="ttdoc">guaranteed to return the requested data</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:461</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html">audio_tools::AudioInfo</a></div><div class="ttdoc">Basic Audio information which drives e.g. I2S.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:50</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html_a029ace15f5ede8def0a6ab5c97a81b25"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#a029ace15f5ede8def0a6ab5c97a81b25">audio_tools::AudioInfo::copyFrom</a></div><div class="ttdeci">void copyFrom(AudioInfo info)</div><div class="ttdoc">Same as set.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:105</div></div>

_i2_s_config_e_s_p32_8h_source.html

@@ -139,7 +139,7 @@
 <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160; </div>
 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keywordtype">void</span> logInfo(<span class="keyword">const</span> <span class="keywordtype">char</span>* source=<span class="stringliteral">&quot;&quot;</span>) {</div>
 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;      AudioInfo::logInfo(source);</div>
-<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;      LOGI(<span class="stringliteral">&quot;rx/tx mode: %s&quot;</span>, <a class="code" href="namespaceaudio__tools.html#acaae0b7e00d518ef0cb903f6c65a20ce">RxTxModeNames</a>[<a class="code" href="classaudio__tools_1_1_i2_s_config_e_s_p32.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>]);</div>
+<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;      LOGI(<span class="stringliteral">&quot;rx/tx mode: %s&quot;</span>, <a class="code" href="namespaceaudio__tools.html#a488e5410a2317335bc89c65de90ab41b">RxTxModeNames</a>[<a class="code" href="classaudio__tools_1_1_i2_s_config_e_s_p32.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>]);</div>
 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;      LOGI(<span class="stringliteral">&quot;port_no: %d&quot;</span>, port_no);</div>
 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;      LOGI(<span class="stringliteral">&quot;is_master: %s&quot;</span>, is_master ? <span class="stringliteral">&quot;Master&quot;</span>:<span class="stringliteral">&quot;Slave&quot;</span>);</div>
 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;      LOGI(<span class="stringliteral">&quot;sample rate: %d&quot;</span>, <a class="code" href="structaudio__tools_1_1_audio_info.html#a0e86c53dfa0ad5dc0d2ecd0304fabc95">sample_rate</a>);</div>
@@ -185,8 +185,8 @@
 <div class="ttc" id="agroup__basic_html_ga8cbd91a8bac9b5ab425112be1620eb49"><div class="ttname"><a href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">audio_tools::RxTxMode</a></div><div class="ttdeci">RxTxMode</div><div class="ttdoc">The Microcontroller is the Audio Source (TX_MODE) or Audio Sink (RX_MODE). RXTX_MODE is Source and Si...</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:26</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:12</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a1d3846b210a1698eaf7cdb7258fcc3e1"><div class="ttname"><a href="namespaceaudio__tools.html#a1d3846b210a1698eaf7cdb7258fcc3e1">audio_tools::I2SSignalType</a></div><div class="ttdeci">I2SSignalType</div><div class="ttdoc">I2S Signal Types: Digital, Analog, PDM.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:406</div></div>
+<div class="ttc" id="anamespaceaudio__tools_html_a488e5410a2317335bc89c65de90ab41b"><div class="ttname"><a href="namespaceaudio__tools.html#a488e5410a2317335bc89c65de90ab41b">audio_tools::RxTxModeNames</a></div><div class="ttdeci">static const char * RxTxModeNames[4]</div><div class="ttdoc">Text string (description) for RxTxMode.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:38</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a720616ce211566d808f3e441f9b18cda"><div class="ttname"><a href="namespaceaudio__tools.html#a720616ce211566d808f3e441f9b18cda">audio_tools::I2SFormat</a></div><div class="ttdeci">I2SFormat</div><div class="ttdoc">I2S Formats.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:391</div></div>
-<div class="ttc" id="anamespaceaudio__tools_html_acaae0b7e00d518ef0cb903f6c65a20ce"><div class="ttname"><a href="namespaceaudio__tools.html#acaae0b7e00d518ef0cb903f6c65a20ce">audio_tools::RxTxModeNames</a></div><div class="ttdeci">static const char * RxTxModeNames[]</div><div class="ttdoc">Text string (description) for RxTxMode.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:38</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html">audio_tools::AudioInfo</a></div><div class="ttdoc">Basic Audio information which drives e.g. I2S.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:50</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html_a0e86c53dfa0ad5dc0d2ecd0304fabc95"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#a0e86c53dfa0ad5dc0d2ecd0304fabc95">audio_tools::AudioInfo::sample_rate</a></div><div class="ttdeci">sample_rate_t sample_rate</div><div class="ttdoc">Sample Rate: e.g 44100.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:53</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html_a1ac7822956f57069d76da865d6b33c55"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#a1ac7822956f57069d76da865d6b33c55">audio_tools::AudioInfo::channels</a></div><div class="ttdeci">uint16_t channels</div><div class="ttdoc">Number of channels: 2=stereo, 1=mono.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:55</div></div>

_i2_s_config_e_s_p32_v1_8h_source.html

@@ -128,7 +128,7 @@
 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160; </div>
 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="keywordtype">void</span> logInfo(<span class="keyword">const</span> <span class="keywordtype">char</span>* source=<span class="stringliteral">&quot;&quot;</span>) {</div>
 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;      AudioInfo::logInfo(source);</div>
-<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;      LOGI(<span class="stringliteral">&quot;rx/tx mode: %s&quot;</span>, <a class="code" href="namespaceaudio__tools.html#acaae0b7e00d518ef0cb903f6c65a20ce">RxTxModeNames</a>[<a class="code" href="classaudio__tools_1_1_i2_s_config_e_s_p32_v1.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>]);</div>
+<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;      LOGI(<span class="stringliteral">&quot;rx/tx mode: %s&quot;</span>, <a class="code" href="namespaceaudio__tools.html#a488e5410a2317335bc89c65de90ab41b">RxTxModeNames</a>[<a class="code" href="classaudio__tools_1_1_i2_s_config_e_s_p32_v1.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>]);</div>
 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;      LOGI(<span class="stringliteral">&quot;port_no: %d&quot;</span>, port_no);</div>
 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;      LOGI(<span class="stringliteral">&quot;is_master: %s&quot;</span>, is_master ? <span class="stringliteral">&quot;Master&quot;</span>:<span class="stringliteral">&quot;Slave&quot;</span>);</div>
 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;      LOGI(<span class="stringliteral">&quot;sample rate: %d&quot;</span>, (<span class="keywordtype">int</span>) <a class="code" href="structaudio__tools_1_1_audio_info.html#a0e86c53dfa0ad5dc0d2ecd0304fabc95">sample_rate</a>);</div>
@@ -173,9 +173,9 @@
 <div class="ttc" id="agroup__basic_html_ga8cbd91a8bac9b5ab425112be1620eb49"><div class="ttname"><a href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">audio_tools::RxTxMode</a></div><div class="ttdeci">RxTxMode</div><div class="ttdoc">The Microcontroller is the Audio Source (TX_MODE) or Audio Sink (RX_MODE). RXTX_MODE is Source and Si...</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:26</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:12</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a1d3846b210a1698eaf7cdb7258fcc3e1"><div class="ttname"><a href="namespaceaudio__tools.html#a1d3846b210a1698eaf7cdb7258fcc3e1">audio_tools::I2SSignalType</a></div><div class="ttdeci">I2SSignalType</div><div class="ttdoc">I2S Signal Types: Digital, Analog, PDM.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:406</div></div>
+<div class="ttc" id="anamespaceaudio__tools_html_a488e5410a2317335bc89c65de90ab41b"><div class="ttname"><a href="namespaceaudio__tools.html#a488e5410a2317335bc89c65de90ab41b">audio_tools::RxTxModeNames</a></div><div class="ttdeci">static const char * RxTxModeNames[4]</div><div class="ttdoc">Text string (description) for RxTxMode.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:38</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_a720616ce211566d808f3e441f9b18cda"><div class="ttname"><a href="namespaceaudio__tools.html#a720616ce211566d808f3e441f9b18cda">audio_tools::I2SFormat</a></div><div class="ttdeci">I2SFormat</div><div class="ttdoc">I2S Formats.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:391</div></div>
 <div class="ttc" id="anamespaceaudio__tools_html_ac7e19a69c5927b90d045e091376d1119"><div class="ttname"><a href="namespaceaudio__tools.html#ac7e19a69c5927b90d045e091376d1119">audio_tools::I2SChannelSelect</a></div><div class="ttdeci">I2SChannelSelect</div><div class="ttdoc">Select left or right channel when number of channels = 1.</div><div class="ttdef"><b>Definition:</b> I2SConfigESP32V1.h:12</div></div>
-<div class="ttc" id="anamespaceaudio__tools_html_acaae0b7e00d518ef0cb903f6c65a20ce"><div class="ttname"><a href="namespaceaudio__tools.html#acaae0b7e00d518ef0cb903f6c65a20ce">audio_tools::RxTxModeNames</a></div><div class="ttdeci">static const char * RxTxModeNames[]</div><div class="ttdoc">Text string (description) for RxTxMode.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:38</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html">audio_tools::AudioInfo</a></div><div class="ttdoc">Basic Audio information which drives e.g. I2S.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:50</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html_a0e86c53dfa0ad5dc0d2ecd0304fabc95"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#a0e86c53dfa0ad5dc0d2ecd0304fabc95">audio_tools::AudioInfo::sample_rate</a></div><div class="ttdeci">sample_rate_t sample_rate</div><div class="ttdoc">Sample Rate: e.g 44100.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:53</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_audio_info_html_a1ac7822956f57069d76da865d6b33c55"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#a1ac7822956f57069d76da865d6b33c55">audio_tools::AudioInfo::channels</a></div><div class="ttdeci">uint16_t channels</div><div class="ttdoc">Number of channels: 2=stereo, 1=mono.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:55</div></div>