Skip to content

Commit

Permalink
Deploying to doxygen from @ f685b97 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Oct 3, 2023
1 parent 1079a58 commit 484b92c
Show file tree
Hide file tree
Showing 320 changed files with 7,195 additions and 6,648 deletions.
2 changes: 1 addition & 1 deletion _abstract_u_r_l_stream_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
<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_abstract_u_r_l_stream_html_afd650515e4fa72af032ea2aa53d18a35"><div class="ttname"><a href="classaudio__tools_1_1_abstract_u_r_l_stream.html#afd650515e4fa72af032ea2aa53d18a35">audio_tools::AbstractURLStream::httpRequest</a></div><div class="ttdeci">virtual HttpRequest &amp; httpRequest()=0</div><div class="ttdoc">provides access to the HttpRequest</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_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:127</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:138</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:33</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>
<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:9</div></div>
Expand Down
2 changes: 1 addition & 1 deletion _analog_audio_arduino_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_base_buffer_html_a9953a7c3a981eb3a83adb4f9ecfb9ac5"><div class="ttname"><a href="classaudio__tools_1_1_base_buffer.html#a9953a7c3a981eb3a83adb4f9ecfb9ac5">audio_tools::BaseBuffer::availableForWrite</a></div><div class="ttdeci">virtual int availableForWrite()=0</div><div class="ttdoc">provides the number of entries that are available to write</div></div>
<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="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:9</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a07f83b0475b1f3c98eccd9b1642dd1cb"><div class="ttname"><a href="namespaceaudio__tools.html#a07f83b0475b1f3c98eccd9b1642dd1cb">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:150</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a07f83b0475b1f3c98eccd9b1642dd1cb"><div class="ttname"><a href="namespaceaudio__tools.html#a07f83b0475b1f3c98eccd9b1642dd1cb">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:161</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a504241b61d3595ad9356f8fccef71c20"><div class="ttname"><a href="namespaceaudio__tools.html#a504241b61d3595ad9356f8fccef71c20">audio_tools::delay</a></div><div class="ttdeci">void delay(uint64_t ms)</div><div class="ttdoc">Waits for the indicated milliseconds.</div><div class="ttdef"><b>Definition:</b> Millis.h:10</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion _audio_actions_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;};</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="ttc" id="a_no_arduino_8h_html_ae1e3d979645a535a8ce49f935392d8bc"><div class="ttname"><a href="_no_arduino_8h.html#ae1e3d979645a535a8ce49f935392d8bc">digitalRead</a></div><div class="ttdeci">int digitalRead(int pin)</div><div class="ttdoc">e.g. for AudioActions</div><div class="ttdef"><b>Definition:</b> NoArduino.h:170</div></div>
<div class="ttc" id="a_no_arduino_8h_html_ae1e3d979645a535a8ce49f935392d8bc"><div class="ttname"><a href="_no_arduino_8h.html#ae1e3d979645a535a8ce49f935392d8bc">digitalRead</a></div><div class="ttdeci">int digitalRead(int pin)</div><div class="ttdoc">e.g. for AudioActions</div><div class="ttdef"><b>Definition:</b> NoArduino.h:181</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 Pins e.g. to implement a simple navigation control or volume co...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:23</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a251a13b88d6b778ec1f5babf5cf0a894"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a251a13b88d6b778ec1f5babf5cf0a894">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(int pin, void(*actionOn)(bool pinStatus, int pin, void *ref), ActiveLogic activeLogic=ActiveLow, void *ref=nullptr)</div><div class="ttdoc">Adds an action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:33</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a37349c713b77ec680e33fc9368ad8782"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a37349c713b77ec680e33fc9368ad8782">audio_tools::AudioActions::setTouchLimit</a></div><div class="ttdeci">void setTouchLimit(int value)</div><div class="ttdoc">Defines the touch limit (Default 20)</div><div class="ttdef"><b>Definition:</b> AudioActions.h:140</div></div>
Expand Down
2 changes: 1 addition & 1 deletion _audio_effect_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_variable_speed_ring_buffer_html_a97acc37c2fc08fa60479ac5b9c36e40a"><div class="ttname"><a href="classaudio__tools_1_1_variable_speed_ring_buffer.html#a97acc37c2fc08fa60479ac5b9c36e40a">audio_tools::VariableSpeedRingBuffer::read</a></div><div class="ttdeci">T read()</div><div class="ttdoc">reads a single value</div><div class="ttdef"><b>Definition:</b> PitchShift.h:238</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_variable_speed_ring_buffer_html_a9f7e466737f4b476929238c84dd6e923"><div class="ttname"><a href="classaudio__tools_1_1_variable_speed_ring_buffer.html#a9f7e466737f4b476929238c84dd6e923">audio_tools::VariableSpeedRingBuffer::write</a></div><div class="ttdeci">bool write(T sample)</div><div class="ttdoc">write add an entry to the buffer</div><div class="ttdef"><b>Definition:</b> PitchShift.h:255</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:9</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a07f83b0475b1f3c98eccd9b1642dd1cb"><div class="ttname"><a href="namespaceaudio__tools.html#a07f83b0475b1f3c98eccd9b1642dd1cb">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:150</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a07f83b0475b1f3c98eccd9b1642dd1cb"><div class="ttname"><a href="namespaceaudio__tools.html#a07f83b0475b1f3c98eccd9b1642dd1cb">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:161</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
4 changes: 2 additions & 2 deletions _audio_effects_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -525,9 +525,9 @@
<div class="ttc" id="aclassaudio__tools_1_1_audio_effects_html_acdb7c37a7d376b32348861f4a2cd8ee0"><div class="ttname"><a href="classaudio__tools_1_1_audio_effects.html#acdb7c37a7d376b32348861f4a2cd8ee0">audio_tools::AudioEffects::AudioEffects</a></div><div class="ttdeci">AudioEffects(Stream &amp;input, int channels=2, float volume=1.0)</div><div class="ttdef"><b>Definition:</b> AudioEffects.h:110</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_effects_html_ad2f617dbd463a6174cdaf6e12b13a214"><div class="ttname"><a href="classaudio__tools_1_1_audio_effects.html#ad2f617dbd463a6174cdaf6e12b13a214">audio_tools::AudioEffects::AudioEffects</a></div><div class="ttdeci">AudioEffects()=default</div><div class="ttdoc">Default constructor.</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_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:51</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_sound_generator_html"><div class="ttname"><a href="classaudio__tools_1_1_sound_generator.html">audio_tools::SoundGenerator</a></div><div class="ttdoc">Base class to define the abstract interface for the sound generating classes.</div><div class="ttdef"><b>Definition:</b> SoundGenerator.h:25</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:114</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_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:18</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:9</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:43</div></div>
Expand Down
4 changes: 2 additions & 2 deletions _audio_encoded_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -658,10 +658,10 @@
<div class="ttc" id="aclassaudio__tools_1_1_encoded_audio_stream_html_a281977f67359f85e429e51feecf7d9f0"><div class="ttname"><a href="classaudio__tools_1_1_encoded_audio_stream.html#a281977f67359f85e429e51feecf7d9f0">audio_tools::EncodedAudioStream::setStream</a></div><div class="ttdeci">void setStream(Stream *ioStream)</div><div class="ttdoc">Defines the input/output stream for decoding.</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:457</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_encoded_audio_stream_html_ada388d17b93c54a1a0f6edddbe0953ab"><div class="ttname"><a href="classaudio__tools_1_1_encoded_audio_stream.html#ada388d17b93c54a1a0f6edddbe0953ab">audio_tools::EncodedAudioStream::resize</a></div><div class="ttdeci">void resize(int size)</div><div class="ttdoc">Defines the buffer size.</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:474</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_encoded_audio_stream_html_af8124372afa43e8a096c4c63a2a99182"><div class="ttname"><a href="classaudio__tools_1_1_encoded_audio_stream.html#af8124372afa43e8a096c4c63a2a99182">audio_tools::EncodedAudioStream::setInput</a></div><div class="ttdeci">void setInput(Stream *ioStream)</div><div class="ttdoc">Same as setStream()</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:454</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:51</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_queue_stream_html_a4d2a8f208d69989c8676b0c632c9ea5c"><div class="ttname"><a href="classaudio__tools_1_1_queue_stream.html#a4d2a8f208d69989c8676b0c632c9ea5c">audio_tools::QueueStream::begin</a></div><div class="ttdeci">virtual bool begin() override</div><div class="ttdoc">Activates the output.</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:892</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:356</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:114</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_streaming_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_streaming_decoder.html">audio_tools::StreamingDecoder</a></div><div class="ttdoc">A Streaming Decoder where we provide both the input and output as streams.</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:141</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_streaming_decoder_html_a09b4fd0a2bd2c7c07c01fd12ae456c98"><div class="ttname"><a href="classaudio__tools_1_1_streaming_decoder.html#a09b4fd0a2bd2c7c07c01fd12ae456c98">audio_tools::StreamingDecoder::copy</a></div><div class="ttdeci">virtual bool copy()=0</div><div class="ttdoc">Process a single read operation - to be called in the loop.</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_streaming_decoder_html_a74fb348e7fbaed39364af8869fb05231"><div class="ttname"><a href="classaudio__tools_1_1_streaming_decoder.html#a74fb348e7fbaed39364af8869fb05231">audio_tools::StreamingDecoder::setOutput</a></div><div class="ttdeci">virtual void setOutput(AudioStream &amp;out_stream)</div><div class="ttdoc">Defines the output streams and register to be notified.</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:156</div></div>
Expand Down
2 changes: 1 addition & 1 deletion _audio_faust_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_faust_stream_html_afb17c26f4788c43eaeaea97bc935343d"><div class="ttname"><a href="classaudio__tools_1_1_faust_stream.html#afb17c26f4788c43eaeaea97bc935343d">audio_tools::FaustStream::write</a></div><div class="ttdeci">size_t write(const uint8_t *write_data, size_t len) override</div><div class="ttdoc">Used if FaustStream is used as audio sink or filter.</div><div class="ttdef"><b>Definition:</b> AudioFaust.h:146</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_faust_stream_html_afe681c8ec67cf8ba9eef6444024dec03"><div class="ttname"><a href="classaudio__tools_1_1_faust_stream.html#afe681c8ec67cf8ba9eef6444024dec03">audio_tools::FaustStream::setLabelValue</a></div><div class="ttdeci">virtual bool setLabelValue(const char *label, FAUSTFLOAT value)</div><div class="ttdoc">Defines the value of a parameter.</div><div class="ttdef"><b>Definition:</b> AudioFaust.h:177</div></div>
<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:241</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:51</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="aclassdsp__memory__manager_html"><div class="ttname"><a href="classdsp__memory__manager.html">dsp_memory_manager</a></div><div class="ttdoc">Memory manager which uses psram when it is available.</div><div class="ttdef"><b>Definition:</b> AudioFaustDSP.h:180</div></div>
<div class="ttc" id="aclassdsp_html"><div class="ttname"><a href="classdsp.html">dsp</a></div><div class="ttdoc">minimal dsp base class needed by Faust</div><div class="ttdef"><b>Definition:</b> AudioFaustDSP.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:9</div></div>
Expand Down
Loading

0 comments on commit 484b92c

Please sign in to comment.