Deploying to doxygen from @ 873b7ff 🚀

_analog_driver_m_b_e_d_8h_source.html

@@ -238,10 +238,10 @@
 <div class="ttc" id="aclassaudio__tools_1_1_analog_driver_m_b_e_d_html_ae8b9b72550fdea4fd2fa6c8c2c9cb7f9"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_m_b_e_d.html#ae8b9b72550fdea4fd2fa6c8c2c9cb7f9">audio_tools::AnalogDriverMBED::writeBuffer</a></div><div class="ttdeci">size_t writeBuffer()</div><div class="ttdoc">The ringbuffer is used to make sure that we can write full SampleBuffers.</div><div class="ttdef"><b>Definition:</b> AnalogDriverMBED.h:140</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_analog_driver_m_b_e_d_html_aee7d4e900ce9123ab445485f8b62adf8"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_m_b_e_d.html#aee7d4e900ce9123ab445485f8b62adf8">audio_tools::AnalogDriverMBED::AnalogDriverMBED</a></div><div class="ttdeci">AnalogDriverMBED()=default</div><div class="ttdoc">Default constructor.</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html">audio_tools::RingBuffer&lt; Sample &gt;</a></div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a1b28d39faccd30992c1b64ddc6e21fe9"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a1b28d39faccd30992c1b64ddc6e21fe9">audio_tools::RingBuffer::read</a></div><div class="ttdeci">virtual T read()</div><div class="ttdoc">reads a single value</div><div class="ttdef"><b>Definition:</b> Buffers.h:302</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a762c87ce3d749ba209ff05e6af210be5"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a762c87ce3d749ba209ff05e6af210be5">audio_tools::RingBuffer::write</a></div><div class="ttdeci">virtual bool write(T data)</div><div class="ttdoc">write add an entry to the buffer</div><div class="ttdef"><b>Definition:</b> Buffers.h:340</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a7b0e029102ad38f4b814c6523aedb53d"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a7b0e029102ad38f4b814c6523aedb53d">audio_tools::RingBuffer::reset</a></div><div class="ttdeci">virtual void reset()</div><div class="ttdoc">clears the buffer</div><div class="ttdef"><b>Definition:</b> Buffers.h:352</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_aac0ab007845c29d8d4c9b96a3cbbe2c9"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#aac0ab007845c29d8d4c9b96a3cbbe2c9">audio_tools::RingBuffer::isFull</a></div><div class="ttdeci">virtual bool isFull()</div><div class="ttdoc">checks if the buffer is full</div><div class="ttdef"><b>Definition:</b> Buffers.h:335</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a1b28d39faccd30992c1b64ddc6e21fe9"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a1b28d39faccd30992c1b64ddc6e21fe9">audio_tools::RingBuffer::read</a></div><div class="ttdeci">virtual T read()</div><div class="ttdoc">reads a single value</div><div class="ttdef"><b>Definition:</b> Buffers.h:309</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a762c87ce3d749ba209ff05e6af210be5"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a762c87ce3d749ba209ff05e6af210be5">audio_tools::RingBuffer::write</a></div><div class="ttdeci">virtual bool write(T data)</div><div class="ttdoc">write add an entry to the buffer</div><div class="ttdef"><b>Definition:</b> Buffers.h:347</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a7b0e029102ad38f4b814c6523aedb53d"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a7b0e029102ad38f4b814c6523aedb53d">audio_tools::RingBuffer::reset</a></div><div class="ttdeci">virtual void reset()</div><div class="ttdoc">clears the buffer</div><div class="ttdef"><b>Definition:</b> Buffers.h:359</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_aac0ab007845c29d8d4c9b96a3cbbe2c9"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#aac0ab007845c29d8d4c9b96a3cbbe2c9">audio_tools::RingBuffer::isFull</a></div><div class="ttdeci">virtual bool isFull()</div><div class="ttdoc">checks if the buffer is full</div><div class="ttdef"><b>Definition:</b> Buffers.h:342</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_a91ca8c40ca55c1fbc577d0fa03ba527d"><div class="ttname"><a href="namespaceaudio__tools.html#a91ca8c40ca55c1fbc577d0fa03ba527d">audio_tools::AnalogDriver</a></div><div class="ttdeci">AnalogDriverArduino AnalogDriver</div><div class="ttdoc">AnalogAudioStream.</div><div class="ttdef"><b>Definition:</b> AnalogDriverArduino.h:48</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>

_audio_e_s_p8266_8h_source.html

@@ -163,7 +163,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_buffered_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_buffered_stream.html">audio_tools::BufferedStream</a></div><div class="ttdoc">The Arduino Stream supports operations on single characters. This is usually not the best way to push...</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:471</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_e_s_p3288_audio_output_html"><div class="ttname"><a href="classaudio__tools_1_1_e_s_p3288_audio_output.html">audio_tools::ESP3288AudioOutput</a></div><div class="ttdoc">Stream Adapter for ESP8288-Audio AudioOutput.</div><div class="ttdef"><b>Definition:</b> AudioESP8266.h:77</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_n_buffer_html"><div class="ttname"><a href="classaudio__tools_1_1_n_buffer.html">audio_tools::NBuffer&lt; Frame &gt;</a></div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_n_buffer_html_a5a7b764c471a4ddcd2ffc3893769c874"><div class="ttname"><a href="classaudio__tools_1_1_n_buffer.html#a5a7b764c471a4ddcd2ffc3893769c874">audio_tools::NBuffer::write</a></div><div class="ttdeci">bool write(T data)</div><div class="ttdoc">write add an entry to the buffer</div><div class="ttdef"><b>Definition:</b> Buffers.h:588</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_n_buffer_html_a5a7b764c471a4ddcd2ffc3893769c874"><div class="ttname"><a href="classaudio__tools_1_1_n_buffer.html#a5a7b764c471a4ddcd2ffc3893769c874">audio_tools::NBuffer::write</a></div><div class="ttdeci">bool write(T data)</div><div class="ttdoc">write add an entry to the buffer</div><div class="ttdef"><b>Definition:</b> Buffers.h:595</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><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->

_audio_f_f_t_8h_source.html

@@ -540,10 +540,10 @@
 <div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa83040da5c51151a9bd3286ecfcfe413"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">audio_tools::NumberConverter::maxValue</a></div><div class="ttdeci">static int64_t maxValue(int value_bits_per_sample)</div><div class="ttdoc">provides the biggest number for the indicated number of bits</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:325</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_ring_buffer_html"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html">audio_tools::RingBuffer&lt; uint8_t &gt;</a></div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a1b28d39faccd30992c1b64ddc6e21fe9"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a1b28d39faccd30992c1b64ddc6e21fe9">audio_tools::RingBuffer::read</a></div><div class="ttdeci">virtual T read()</div><div class="ttdoc">reads a single value</div><div class="ttdef"><b>Definition:</b> Buffers.h:302</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a473a08fbb41a997860a55213bc367d44"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a473a08fbb41a997860a55213bc367d44">audio_tools::RingBuffer::availableForWrite</a></div><div class="ttdeci">virtual int availableForWrite()</div><div class="ttdoc">provides the number of entries that are available to write</div><div class="ttdef"><b>Definition:</b> Buffers.h:362</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a512cfced3ab951dde7a9a78f1274fe63"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a512cfced3ab951dde7a9a78f1274fe63">audio_tools::RingBuffer::available</a></div><div class="ttdeci">virtual int available()</div><div class="ttdoc">provides the number of entries that are available to read</div><div class="ttdef"><b>Definition:</b> Buffers.h:359</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_aa2c7fffd280ddcd6500a065785df0950"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#aa2c7fffd280ddcd6500a065785df0950">audio_tools::RingBuffer::size</a></div><div class="ttdeci">virtual size_t size()</div><div class="ttdoc">Returns the maximum capacity of the buffer.</div><div class="ttdef"><b>Definition:</b> Buffers.h:376</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a1b28d39faccd30992c1b64ddc6e21fe9"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a1b28d39faccd30992c1b64ddc6e21fe9">audio_tools::RingBuffer::read</a></div><div class="ttdeci">virtual T read()</div><div class="ttdoc">reads a single value</div><div class="ttdef"><b>Definition:</b> Buffers.h:309</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a473a08fbb41a997860a55213bc367d44"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a473a08fbb41a997860a55213bc367d44">audio_tools::RingBuffer::availableForWrite</a></div><div class="ttdeci">virtual int availableForWrite()</div><div class="ttdoc">provides the number of entries that are available to write</div><div class="ttdef"><b>Definition:</b> Buffers.h:369</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a512cfced3ab951dde7a9a78f1274fe63"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a512cfced3ab951dde7a9a78f1274fe63">audio_tools::RingBuffer::available</a></div><div class="ttdeci">virtual int available()</div><div class="ttdoc">provides the number of entries that are available to read</div><div class="ttdef"><b>Definition:</b> Buffers.h:366</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_aa2c7fffd280ddcd6500a065785df0950"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#aa2c7fffd280ddcd6500a065785df0950">audio_tools::RingBuffer::size</a></div><div class="ttdeci">virtual size_t size()</div><div class="ttdoc">Returns the maximum capacity of the buffer.</div><div class="ttdef"><b>Definition:</b> Buffers.h:383</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_window_function_html"><div class="ttname"><a href="classaudio__tools_1_1_window_function.html">audio_tools::WindowFunction</a></div><div class="ttdoc">FFT Window Function.</div><div class="ttdef"><b>Definition:</b> FFTWindows.h:23</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_window_function_html_a838612f9ae4330b86d40ebbd7018b8a3"><div class="ttname"><a href="classaudio__tools_1_1_window_function.html#a838612f9ae4330b86d40ebbd7018b8a3">audio_tools::WindowFunction::begin</a></div><div class="ttdeci">virtual void begin(int samples)</div><div class="ttdoc">Setup the window function providing the fft length.</div><div class="ttdef"><b>Definition:</b> FFTWindows.h:28</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_window_function_html_ac8161847fa3a2b56a5119bcf6964e1ff"><div class="ttname"><a href="classaudio__tools_1_1_window_function.html#ac8161847fa3a2b56a5119bcf6964e1ff">audio_tools::WindowFunction::factor</a></div><div class="ttdeci">float factor(int idx)</div><div class="ttdoc">Provides the multipication factor at the indicated position. The result is symetirically mirrored aro...</div><div class="ttdef"><b>Definition:</b> FFTWindows.h:35</div></div>

_audio_i_o_8h_source.html

@@ -787,7 +787,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_reformat_base_stream_html_a3175c90bb7d1186fc8eea5d5114a3766"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html#a3175c90bb7d1186fc8eea5d5114a3766">audio_tools::ReformatBaseStream::setStream</a></div><div class="ttdeci">virtual void setStream(Stream &amp;stream) override</div><div class="ttdoc">Defines/Changes the input &amp; output.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:144</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_reformat_base_stream_html_a481a4d7687bb4a88536fd7ebe16fdc91"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html#a481a4d7687bb4a88536fd7ebe16fdc91">audio_tools::ReformatBaseStream::setOutput</a></div><div class="ttdeci">virtual void setOutput(Print &amp;print) override</div><div class="ttdoc">Defines/Changes the output target.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:163</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_reformat_base_stream_html_a6040e2bfdadb06e8d62fafc03f7b3116"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html#a6040e2bfdadb06e8d62fafc03f7b3116">audio_tools::ReformatBaseStream::setNotifyOnOutput</a></div><div class="ttdeci">void setNotifyOnOutput(AudioInfoSupport &amp;info)</div><div class="ttdoc">Define potential notification.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:201</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_aa2c7fffd280ddcd6500a065785df0950"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#aa2c7fffd280ddcd6500a065785df0950">audio_tools::RingBuffer::size</a></div><div class="ttdeci">virtual size_t size()</div><div class="ttdoc">Returns the maximum capacity of the buffer.</div><div class="ttdef"><b>Definition:</b> Buffers.h:376</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_aa2c7fffd280ddcd6500a065785df0950"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#aa2c7fffd280ddcd6500a065785df0950">audio_tools::RingBuffer::size</a></div><div class="ttdeci">virtual size_t size()</div><div class="ttdoc">Returns the maximum capacity of the buffer.</div><div class="ttdef"><b>Definition:</b> Buffers.h:383</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_single_buffer_html"><div class="ttname"><a href="classaudio__tools_1_1_single_buffer.html">audio_tools::SingleBuffer&lt; uint8_t &gt;</a></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_timed_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_timed_stream.html">audio_tools::TimedStream</a></div><div class="ttdoc">AudioStream class that can define a start and (an optional) stop time Usually it is used to wrap an A...</div><div class="ttdef"><b>Definition:</b> AudioIO.h:408</div></div>

_audio_m_p34_d_t05_8h_source.html

@@ -176,7 +176,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_base_buffer_html_a163c69bc2b88421988d60f4efddb1f3f"><div class="ttname"><a href="classaudio__tools_1_1_base_buffer.html#a163c69bc2b88421988d60f4efddb1f3f">audio_tools::BaseBuffer::readArray</a></div><div class="ttdeci">virtual int readArray(T data[], int len)</div><div class="ttdoc">reads multiple values</div><div class="ttdef"><b>Definition:</b> Buffers.h:41</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_base_buffer_html_a2b6c561aac2af64aafac1946b6e46393"><div class="ttname"><a href="classaudio__tools_1_1_base_buffer.html#a2b6c561aac2af64aafac1946b6e46393">audio_tools::BaseBuffer::writeArray</a></div><div class="ttdeci">virtual int writeArray(const T data[], int len)</div><div class="ttdoc">Fills the buffer data.</div><div class="ttdef"><b>Definition:</b> Buffers.h:65</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_n_buffer_html"><div class="ttname"><a href="classaudio__tools_1_1_n_buffer.html">audio_tools::NBuffer&lt; uint8_t &gt;</a></div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_n_buffer_html_a4549a76725f2e4c013e4d57018366109"><div class="ttname"><a href="classaudio__tools_1_1_n_buffer.html#a4549a76725f2e4c013e4d57018366109">audio_tools::NBuffer::available</a></div><div class="ttdeci">int available()</div><div class="ttdoc">provides the number of entries that are available to read</div><div class="ttdef"><b>Definition:</b> Buffers.h:614</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_n_buffer_html_a4549a76725f2e4c013e4d57018366109"><div class="ttname"><a href="classaudio__tools_1_1_n_buffer.html#a4549a76725f2e4c013e4d57018366109">audio_tools::NBuffer::available</a></div><div class="ttdeci">int available()</div><div class="ttdoc">provides the number of entries that are available to read</div><div class="ttdef"><b>Definition:</b> Buffers.h:621</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="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>