Skip to content

Commit

Permalink
Deploying to doxygen from @ 68f311e 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Oct 23, 2023
1 parent 953fe63 commit 3ca5bf7
Show file tree
Hide file tree
Showing 52 changed files with 828 additions and 822 deletions.
14 changes: 7 additions & 7 deletions _audio_kit_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -578,13 +578,13 @@
<div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_html_af38d1a10057f59d3374bcf400c1be036"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream.html#af38d1a10057f59d3374bcf400c1be036">audio_tools::AudioKitStream::readBytes</a></div><div class="ttdeci">size_t readBytes(uint8_t *data, size_t length) override</div><div class="ttdoc">Reads the audio data.</div><div class="ttdef"><b>Definition:</b> AudioKit.h:253</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_html_af7a84eb3e214370dec7d0767c96aa7b0"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream.html#af7a84eb3e214370dec7d0767c96aa7b0">audio_tools::AudioKitStream::pinAuxin</a></div><div class="ttdeci">int8_t pinAuxin()</div><div class="ttdoc">Get the gpio number for auxin detection.</div><div class="ttdef"><b>Definition:</b> AudioKit.h:455</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html">audio_tools::AudioStream</a></div><div class="ttdoc">Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:47</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_e_s_p32.html">audio_tools::I2SConfigESP32</a></div><div class="ttdoc">configuration for USE_ALT_PIN_SUPPORT i2s</div><div class="ttdef"><b>Definition:</b> I2SConfigESP32.h:31</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_e_s_p32_html_a31a454d24fb1f4d74779a0ff668d54cc"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_e_s_p32.html#a31a454d24fb1f4d74779a0ff668d54cc">audio_tools::I2SConfigESP32::rx_tx_mode</a></div><div class="ttdeci">RxTxMode rx_tx_mode</div><div class="ttdoc">public settings</div><div class="ttdef"><b>Definition:</b> I2SConfigESP32.h:67</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html">audio_tools::I2SStream</a></div><div class="ttdoc">We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...</div><div class="ttdef"><b>Definition:</b> I2SStream.h:32</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a2c47515c0bc629a2799a9cc22ea5e17e"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a2c47515c0bc629a2799a9cc22ea5e17e">audio_tools::I2SStream::readBytes</a></div><div class="ttdeci">virtual size_t readBytes(uint8_t *data, size_t length) override</div><div class="ttdoc">Reads the audio data.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:98</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a2ea68b231c423a554ea84d14f88e271e"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a2ea68b231c423a554ea84d14f88e271e">audio_tools::I2SStream::write</a></div><div class="ttdeci">virtual size_t write(const uint8_t *buffer, size_t size)</div><div class="ttdoc">Writes the audio data to I2S.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:92</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a87feead15897a49c7dccb043ac9fcddc"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a87feead15897a49c7dccb043ac9fcddc">audio_tools::I2SStream::setAudioInfo</a></div><div class="ttdeci">virtual void setAudioInfo(AudioInfo info)</div><div class="ttdoc">updates the sample rate dynamically</div><div class="ttdef"><b>Definition:</b> I2SStream.h:74</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#aaf81d3fdaf258088d7692fa70cece087">audio_tools::I2SStream::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Stops the I2S interface.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:67</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_e_s_p32.html">audio_tools::I2SConfigESP32</a></div><div class="ttdoc">configuration for USE_ALT_PIN_SUPPORT i2s</div><div class="ttdef"><b>Definition:</b> I2SConfigESP32.h:33</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_e_s_p32_html_a31a454d24fb1f4d74779a0ff668d54cc"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_e_s_p32.html#a31a454d24fb1f4d74779a0ff668d54cc">audio_tools::I2SConfigESP32::rx_tx_mode</a></div><div class="ttdeci">RxTxMode rx_tx_mode</div><div class="ttdoc">public settings</div><div class="ttdef"><b>Definition:</b> I2SConfigESP32.h:69</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html">audio_tools::I2SStream</a></div><div class="ttdoc">We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...</div><div class="ttdef"><b>Definition:</b> I2SStream.h:33</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a2c47515c0bc629a2799a9cc22ea5e17e"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a2c47515c0bc629a2799a9cc22ea5e17e">audio_tools::I2SStream::readBytes</a></div><div class="ttdeci">virtual size_t readBytes(uint8_t *data, size_t length) override</div><div class="ttdoc">Reads the audio data.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:99</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a2ea68b231c423a554ea84d14f88e271e"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a2ea68b231c423a554ea84d14f88e271e">audio_tools::I2SStream::write</a></div><div class="ttdeci">virtual size_t write(const uint8_t *buffer, size_t size)</div><div class="ttdoc">Writes the audio data to I2S.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:93</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a87feead15897a49c7dccb043ac9fcddc"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a87feead15897a49c7dccb043ac9fcddc">audio_tools::I2SStream::setAudioInfo</a></div><div class="ttdeci">virtual void setAudioInfo(AudioInfo info)</div><div class="ttdoc">updates the sample rate dynamically</div><div class="ttdef"><b>Definition:</b> I2SStream.h:75</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#aaf81d3fdaf258088d7692fa70cece087">audio_tools::I2SStream::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Stops the I2S interface.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:68</div></div>
<div class="ttc" id="agroup__basic_html_ga8c528baf37154d347366083f0f816846"><div class="ttname"><a href="group__basic.html#ga8c528baf37154d347366083f0f816846">stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Public generic methods.</div><div class="ttdef"><b>Definition:</b> AudioRuntime.h:12</div></div>
<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">Audio Source (TX_MODE) or Audio Sink (RX_MODE). RXTX_MODE is Source and Sink at the same time!</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:24</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> AnalogAudio.h:10</div></div>
Expand Down
8 changes: 4 additions & 4 deletions _audio_s_p_d_i_f_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,10 +298,10 @@
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html">audio_tools::AudioStream</a></div><div class="ttdoc">Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:47</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_e_s_p32.html">audio_tools::I2SConfigESP32</a></div><div class="ttdoc">configuration for USE_ALT_PIN_SUPPORT i2s</div><div class="ttdef"><b>Definition:</b> I2SConfigESP32.h:31</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html">audio_tools::I2SStream</a></div><div class="ttdoc">We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...</div><div class="ttdef"><b>Definition:</b> I2SStream.h:32</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a2ea68b231c423a554ea84d14f88e271e"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a2ea68b231c423a554ea84d14f88e271e">audio_tools::I2SStream::write</a></div><div class="ttdeci">virtual size_t write(const uint8_t *buffer, size_t size)</div><div class="ttdoc">Writes the audio data to I2S.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:92</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#aaf81d3fdaf258088d7692fa70cece087">audio_tools::I2SStream::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Stops the I2S interface.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:67</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_e_s_p32.html">audio_tools::I2SConfigESP32</a></div><div class="ttdoc">configuration for USE_ALT_PIN_SUPPORT i2s</div><div class="ttdef"><b>Definition:</b> I2SConfigESP32.h:33</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html">audio_tools::I2SStream</a></div><div class="ttdoc">We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...</div><div class="ttdef"><b>Definition:</b> I2SStream.h:33</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_a2ea68b231c423a554ea84d14f88e271e"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#a2ea68b231c423a554ea84d14f88e271e">audio_tools::I2SStream::write</a></div><div class="ttdeci">virtual size_t write(const uint8_t *buffer, size_t size)</div><div class="ttdoc">Writes the audio data to I2S.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:93</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_stream_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_stream.html#aaf81d3fdaf258088d7692fa70cece087">audio_tools::I2SStream::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Stops the I2S interface.</div><div class="ttdef"><b>Definition:</b> I2SStream.h:68</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_s_p_d_i_f_output_html"><div class="ttname"><a href="classaudio__tools_1_1_s_p_d_i_f_output.html">audio_tools::SPDIFOutput</a></div><div class="ttdoc">Output as 16 bit stereo SPDIF on the I2S data output pin.</div><div class="ttdef"><b>Definition:</b> AudioSPDIF.h:120</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_s_p_d_i_f_output_html_a4c9c41e75e159fa1bd88ab194dae85f8"><div class="ttname"><a href="classaudio__tools_1_1_s_p_d_i_f_output.html#a4c9c41e75e159fa1bd88ab194dae85f8">audio_tools::SPDIFOutput::defaultConfig</a></div><div class="ttdeci">SPDIFConfig defaultConfig()</div><div class="ttdoc">Provides the default configuration.</div><div class="ttdef"><b>Definition:</b> AudioSPDIF.h:206</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_s_p_d_i_f_output_html_a56be726241f8d4665f9521568b6776da"><div class="ttname"><a href="classaudio__tools_1_1_s_p_d_i_f_output.html#a56be726241f8d4665f9521568b6776da">audio_tools::SPDIFOutput::~SPDIFOutput</a></div><div class="ttdeci">virtual ~SPDIFOutput()</div><div class="ttdoc">destructor</div><div class="ttdef"><b>Definition:</b> AudioSPDIF.h:126</div></div>
Expand Down
28 changes: 11 additions & 17 deletions _i2_s_config_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,23 +73,17 @@
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &quot;AudioConfig.h&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#ifdef USE_I2S</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceaudio__tools.html">audio_tools</a> {</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;}</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#if defined(ESP32)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor"># if ESP_IDF_VERSION &lt; ESP_IDF_VERSION_VAL(5, 0 , 0)</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"># include &quot;I2SConfigESP32.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor"># else</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"># include &quot;I2SConfigESP32V1.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"># endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor"># include &quot;I2SConfigStd.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></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> AnalogAudio.h:10</div></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#if defined(ESP32)</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor"># if ESP_IDF_VERSION &lt; ESP_IDF_VERSION_VAL(5, 0 , 0)</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor"># include &quot;I2SConfigESP32.h&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"># else</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"># include &quot;I2SConfigESP32V1.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor"># endif</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"># include &quot;I2SConfigStd.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit 3ca5bf7

Please sign in to comment.