Deploying to doxygen from @ 91eea9f 🚀

Author: pschatzmann

_abstract_u_r_l_stream_8h_source.html

@@ -122,7 +122,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_abstract_u_r_l_stream_html_a87b51853b7bf1bc90d9efa9f3b8d4fea"><div class="ttname"><a href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a87b51853b7bf1bc90d9efa9f3b8d4fea">audio_tools::AbstractURLStream::availableForWrite</a></div><div class="ttdeci">int availableForWrite() override</div><div class="ttdoc">Writes are not supported.</div><div class="ttdef"><b>Definition</b> AbstractURLStream.h:27</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_abstract_u_r_l_stream_html_aa02fa47437f45ebe8b6d8e30daa9cb73"><div class="ttname"><a href="classaudio__tools_1_1_abstract_u_r_l_stream.html#aa02fa47437f45ebe8b6d8e30daa9cb73">audio_tools::AbstractURLStream::setClient</a></div><div class="ttdeci">virtual void setClient(Client &amp;clientPar)=0</div><div class="ttdoc">(Re-)defines the client</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> BaseStream.h:113</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_client_html"><div class="ttname"><a href="classaudio__tools_1_1_client.html">audio_tools::Client</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:139</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_client_html"><div class="ttname"><a href="classaudio__tools_1_1_client.html">audio_tools::Client</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:151</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_http_request_html"><div class="ttname"><a href="classaudio__tools_1_1_http_request.html">audio_tools::HttpRequest</a></div><div class="ttdoc">Simple API to process get, put, post, del http requests I tried to use Arduino HttpClient,...</div><div class="ttdef"><b>Definition</b> HttpRequest.h:26</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_vector_html"><div class="ttname"><a href="classaudio__tools_1_1_vector.html">audio_tools::Vector</a></div><div class="ttdoc">Vector implementation which provides the most important methods as defined by std::vector....</div><div class="ttdef"><b>Definition</b> Vector.h:21</div></div>
 <div class="ttc" id="agroup__metadata_html_ga6760f423085f8a63374b1e2db102a6d1"><div class="ttname"><a href="group__metadata.html#ga6760f423085f8a63374b1e2db102a6d1">audio_tools::MetaDataType</a></div><div class="ttdeci">MetaDataType</div><div class="ttdoc">Type of meta info.</div><div class="ttdef"><b>Definition</b> AbstractMetaData.h:11</div></div>

_analog_audio_arduino_8h_source.html

@@ -427,7 +427,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_base_buffer_html_aebd60457902debb30b07971a16f24ebd"><div class="ttname"><a href="classaudio__tools_1_1_base_buffer.html#aebd60457902debb30b07971a16f24ebd">audio_tools::BaseBuffer::available</a></div><div class="ttdeci">virtual int available()=0</div><div class="ttdoc">provides the number of entries that are available to read</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_vector_html"><div class="ttname"><a href="classaudio__tools_1_1_vector.html">audio_tools::Vector</a></div><div class="ttdoc">Vector implementation which provides the most important methods as defined by std::vector....</div><div class="ttdef"><b>Definition</b> Vector.h:21</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> AudioConfig.h:877</div></div>
-<div class="ttc" id="anamespaceaudio__tools_html_aada2d75bc8a8c6eb845bd940eadfa3fd"><div class="ttname"><a href="namespaceaudio__tools.html#aada2d75bc8a8c6eb845bd940eadfa3fd">audio_tools::map</a></div><div class="ttdeci">long map(long x, long in_min, long in_max, long out_min, long out_max)</div><div class="ttdoc">Maps input to output values.</div><div class="ttdef"><b>Definition</b> NoArduino.h:162</div></div>
+<div class="ttc" id="anamespaceaudio__tools_html_aada2d75bc8a8c6eb845bd940eadfa3fd"><div class="ttname"><a href="namespaceaudio__tools.html#aada2d75bc8a8c6eb845bd940eadfa3fd">audio_tools::map</a></div><div class="ttdeci">long map(long x, long in_min, long in_max, long out_min, long out_max)</div><div class="ttdoc">Maps input to output values.</div><div class="ttdef"><b>Definition</b> NoArduino.h:174</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:52</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:55</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:57</div></div>

_audio_actions_8h_source.html

@@ -360,7 +360,7 @@
 </div>
 <div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span> </div>
 <div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span>} <span class="comment">// namespace audio_tools</span></div>
-<div class="ttc" id="a_no_arduino_8h_html_ad805b2ceb0c0efd0f7c0d98d2564f103"><div class="ttname"><a href="_no_arduino_8h.html#ad805b2ceb0c0efd0f7c0d98d2564f103">digitalRead</a></div><div class="ttdeci">static int digitalRead(int pin)</div><div class="ttdoc">e.g. for AudioActions</div><div class="ttdef"><b>Definition</b> NoArduino.h:206</div></div>
+<div class="ttc" id="a_no_arduino_8h_html_ad805b2ceb0c0efd0f7c0d98d2564f103"><div class="ttname"><a href="_no_arduino_8h.html#ad805b2ceb0c0efd0f7c0d98d2564f103">digitalRead</a></div><div class="ttdeci">static int digitalRead(int pin)</div><div class="ttdoc">e.g. for AudioActions</div><div class="ttdef"><b>Definition</b> NoArduino.h:218</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html">audio_tools::AudioActions</a></div><div class="ttdoc">A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...</div><div class="ttdef"><b>Definition</b> AudioActions.h:29</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a11375230bb8ca843f9b90d23c752a52e"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a11375230bb8ca843f9b90d23c752a52e">audio_tools::AudioActions::findActionIdx</a></div><div class="ttdeci">int findActionIdx(int id)</div><div class="ttdoc">Determines the action for the pin/id.</div><div class="ttdef"><b>Definition</b> AudioActions.h:210</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a1d7cd121704e98b29cfcdd323b4bd6da"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a1d7cd121704e98b29cfcdd323b4bd6da">audio_tools::AudioActions::AudioActions</a></div><div class="ttdeci">AudioActions(bool useInterrupt=false)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition</b> AudioActions.h:122</div></div>

_audio_board_stream_8h_source.html

@@ -393,7 +393,7 @@
 </div>
 <div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span> </div>
 <div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span>}  <span class="comment">// namespace audio_tools</span></div>
-<div class="ttc" id="a_no_arduino_8h_html_ad805b2ceb0c0efd0f7c0d98d2564f103"><div class="ttname"><a href="_no_arduino_8h.html#ad805b2ceb0c0efd0f7c0d98d2564f103">digitalRead</a></div><div class="ttdeci">static int digitalRead(int pin)</div><div class="ttdoc">e.g. for AudioActions</div><div class="ttdef"><b>Definition</b> NoArduino.h:206</div></div>
+<div class="ttc" id="a_no_arduino_8h_html_ad805b2ceb0c0efd0f7c0d98d2564f103"><div class="ttname"><a href="_no_arduino_8h.html#ad805b2ceb0c0efd0f7c0d98d2564f103">digitalRead</a></div><div class="ttdeci">static int digitalRead(int pin)</div><div class="ttdoc">e.g. for AudioActions</div><div class="ttdef"><b>Definition</b> NoArduino.h:218</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html">audio_tools::AudioActions</a></div><div class="ttdoc">A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...</div><div class="ttdef"><b>Definition</b> AudioActions.h:29</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a7897359154057644b97714a13fc70581"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a7897359154057644b97714a13fc70581">audio_tools::AudioActions::processActions</a></div><div class="ttdeci">void processActions()</div><div class="ttdoc">Execute all actions if the corresponding pin is low To minimize the runtime: With each call we proces...</div><div class="ttdef"><b>Definition</b> AudioActions.h:180</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a894ef8143616eca07c59f1f2deea3955"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(Action &amp;action)</div><div class="ttdoc">Adds an Action.</div><div class="ttdef"><b>Definition</b> AudioActions.h:133</div></div>

_audio_cmsis_f_f_t_8h_source.html

@@ -221,8 +221,8 @@
 <div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>}</div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_cmsis_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_cmsis_f_f_t.html">audio_tools::AudioCmsisFFT</a></div><div class="ttdoc">AudioFFT for ARM processors that provided Cmsis DSP.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:112</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_cmsis_f_f_t_html_a2b5e1c6a270a54d6711fb0a83866efb8"><div class="ttname"><a href="classaudio__tools_1_1_audio_cmsis_f_f_t.html#a2b5e1c6a270a54d6711fb0a83866efb8">audio_tools::AudioCmsisFFT::array</a></div><div class="ttdeci">float * array()</div><div class="ttdoc">Provides the result array returned by CMSIS FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:117</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data privded by write() and/or an inverse FFT where the samples are made ava...</div><div class="ttdef"><b>Definition</b> AudioFFT.h:190</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a78331df1a4e6bd150c2be32ae74b7b29"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a78331df1a4e6bd150c2be32ae74b7b29">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdef"><b>Definition</b> AudioFFT.h:390</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data privded by write() and/or an inverse FFT where the samples are made ava...</div><div class="ttdef"><b>Definition</b> AudioFFT.h:191</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a78331df1a4e6bd150c2be32ae74b7b29"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a78331df1a4e6bd150c2be32ae74b7b29">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdef"><b>Definition</b> AudioFFT.h:392</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html">audio_tools::FFTDriverCmsisFFT</a></div><div class="ttdoc">Driver for Cmsis-FFT see https://arm-software.github.io/CMSIS_5/DSP.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:23</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_a01f7d08ca15b0ebd7bb4d17101ba8d72"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#a01f7d08ca15b0ebd7bb4d17101ba8d72">audio_tools::FFTDriverCmsisFFT::magnitudeFast</a></div><div class="ttdeci">float magnitudeFast(int idx) override</div><div class="ttdoc">same as magnitude</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:72</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_a11592af256fefabe7c1e1cc9b8b516b6"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#a11592af256fefabe7c1e1cc9b8b516b6">audio_tools::FFTDriverCmsisFFT::setValue</a></div><div class="ttdeci">void setValue(int idx, float value) override</div><div class="ttdoc">Sets the real value.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:50</div></div>
@@ -233,7 +233,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_ab08cf2f66075519cfdaddedcce92527f"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#ab08cf2f66075519cfdaddedcce92527f">audio_tools::FFTDriverCmsisFFT::fft</a></div><div class="ttdeci">void fft() override</div><div class="ttdoc">Perform FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:54</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_add3df8e9c88c438537a87be3415ef2ba"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#add3df8e9c88c438537a87be3415ef2ba">audio_tools::FFTDriverCmsisFFT::rfft</a></div><div class="ttdeci">void rfft() override</div><div class="ttdoc">Calculate reverse FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:63</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_aec550aae099c1a4afec6a9df3512ad21"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#aec550aae099c1a4afec6a9df3512ad21">audio_tools::FFTDriverCmsisFFT::getValue</a></div><div class="ttdeci">float getValue(int idx) override</div><div class="ttdoc">Get result value from Reverse FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:76</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:155</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:156</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_vector_html"><div class="ttname"><a href="classaudio__tools_1_1_vector.html">audio_tools::Vector</a></div><div class="ttdoc">Vector implementation which provides the most important methods as defined by std::vector....</div><div class="ttdef"><b>Definition</b> Vector.h:21</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> AudioConfig.h:877</div></div>
 <div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:65</div></div>

_audio_codecs_base_8h_source.html

@@ -325,7 +325,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_codec_n_o_p_html_ada56eff2516fb0a4f5091ce06805411a"><div class="ttname"><a href="classaudio__tools_1_1_codec_n_o_p.html#ada56eff2516fb0a4f5091ce06805411a">audio_tools::CodecNOP::audioInfo</a></div><div class="ttdeci">virtual AudioInfo audioInfo()</div><div class="ttdoc">provides the actual input AudioInfo</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:131</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_container_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_container_decoder.html">audio_tools::ContainerDecoder</a></div><div class="ttdoc">Parent class for all container formats.</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:74</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_print_html"><div class="ttname"><a href="classaudio__tools_1_1_print.html">audio_tools::Print</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:58</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_stream.html">audio_tools::Stream</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:125</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_stream.html">audio_tools::Stream</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:137</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_streaming_decoder_adapter_html"><div class="ttname"><a href="classaudio__tools_1_1_streaming_decoder_adapter.html">audio_tools::StreamingDecoderAdapter</a></div><div class="ttdoc">Converts any AudioDecoder to a StreamingDecoder.</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:205</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_streaming_decoder_adapter_html_a065fe4c0d3543644ab523a5d9b5fb9c0"><div class="ttname"><a href="classaudio__tools_1_1_streaming_decoder_adapter.html#a065fe4c0d3543644ab523a5d9b5fb9c0">audio_tools::StreamingDecoderAdapter::setOutput</a></div><div class="ttdeci">void setOutput(Print &amp;out_stream) override</div><div class="ttdoc">Defines the output Stream.</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:219</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_streaming_decoder_adapter_html_a1e35ffebeb993132bafcd30e9529b807"><div class="ttname"><a href="classaudio__tools_1_1_streaming_decoder_adapter.html#a1e35ffebeb993132bafcd30e9529b807">audio_tools::StreamingDecoderAdapter::copy</a></div><div class="ttdeci">virtual bool copy()</div><div class="ttdoc">Process a single read operation - to be called in the loop.</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:230</div></div>