Skip to content

Commit

Permalink
Deploying to doxygen from @ 4b49b99 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Oct 18, 2024
1 parent 4d36db1 commit bb563d3
Show file tree
Hide file tree
Showing 142 changed files with 4,342 additions and 4,320 deletions.
2 changes: 1 addition & 1 deletion _audio_encoded_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_encoded_audio_stream_html_a4ea3110016f67d3dcb9793fcae72288f"><div class="ttname"><a href="classaudio__tools_1_1_encoded_audio_stream.html#a4ea3110016f67d3dcb9793fcae72288f">audio_tools::EncodedAudioStream::setStream</a></div><div class="ttdeci">void setStream(Stream &amp;stream)</div><div class="ttdoc">Defines/Changes the input &amp; output.</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:322</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_encoded_audio_stream_html_a8b855aa8df6888b7ac4e64f3295d7b1a"><div class="ttname"><a href="classaudio__tools_1_1_encoded_audio_stream.html#a8b855aa8df6888b7ac4e64f3295d7b1a">audio_tools::EncodedAudioStream::setFrameSize</a></div><div class="ttdeci">void setFrameSize(int size)</div><div class="ttdoc">defines the size of the decoded frame in bytes</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:383</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_encoded_audio_stream_html_ae1220e7e3542f5a84c21fe2f7cef194c"><div class="ttname"><a href="classaudio__tools_1_1_encoded_audio_stream.html#ae1220e7e3542f5a84c21fe2f7cef194c">audio_tools::EncodedAudioStream::setOutput</a></div><div class="ttdeci">void setOutput(Print &amp;out)</div><div class="ttdoc">Defines/Changes the output target.</div><div class="ttdef"><b>Definition:</b> AudioEncoded.h:332</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_output_html"><div class="ttname"><a href="classaudio__tools_1_1_modifying_output.html">audio_tools::ModifyingOutput</a></div><div class="ttdoc">Abstract class: Objects can be put into a pipleline.</div><div class="ttdef"><b>Definition:</b> AudioOutput.h:96</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_output_html"><div class="ttname"><a href="classaudio__tools_1_1_modifying_output.html">audio_tools::ModifyingOutput</a></div><div class="ttdoc">Abstract class: Objects can be put into a pipleline.</div><div class="ttdef"><b>Definition:</b> AudioOutput.h:97</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_reformat_base_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html">audio_tools::ReformatBaseStream</a></div><div class="ttdoc">Base class for chained converting streams.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:142</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_reformat_base_stream_html_a19db610062b0771c616d6e31cddc5ddc"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html#a19db610062b0771c616d6e31cddc5ddc">audio_tools::ReformatBaseStream::addNotifyOnFirstWrite</a></div><div class="ttdeci">void addNotifyOnFirstWrite()</div><div class="ttdoc">Add notification on first call of write.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:204</div></div>
Expand Down
905 changes: 460 additions & 445 deletions _audio_i_o_8h_source.html

Large diffs are not rendered by default.

1,133 changes: 567 additions & 566 deletions _audio_output_8h_source.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions _pipeline_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,12 +385,12 @@
<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:109</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html_acbaca7240bc555603b0da5b7ca11ce10"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html#acbaca7240bc555603b0da5b7ca11ce10">audio_tools::AudioStream::setAudioInfo</a></div><div class="ttdeci">virtual void setAudioInfo(AudioInfo newInfo) override</div><div class="ttdoc">Defines the input AudioInfo.</div><div class="ttdef"><b>Definition:</b> BaseStream.h:117</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html_aececda97cff151859a8695d30896dd20"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html#aececda97cff151859a8695d30896dd20">audio_tools::AudioStream::audioInfo</a></div><div class="ttdeci">virtual AudioInfo audioInfo() override</div><div class="ttdoc">provides the actual input AudioInfo</div><div class="ttdef"><b>Definition:</b> BaseStream.h:140</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_output_html"><div class="ttname"><a href="classaudio__tools_1_1_modifying_output.html">audio_tools::ModifyingOutput</a></div><div class="ttdoc">Abstract class: Objects can be put into a pipleline.</div><div class="ttdef"><b>Definition:</b> AudioOutput.h:96</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_output_html"><div class="ttname"><a href="classaudio__tools_1_1_modifying_output.html">audio_tools::ModifyingOutput</a></div><div class="ttdoc">Abstract class: Objects can be put into a pipleline.</div><div class="ttdef"><b>Definition:</b> AudioOutput.h:97</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_output_html_ac68081867afc8798c70a2e83599098e6"><div class="ttname"><a href="classaudio__tools_1_1_modifying_output.html#ac68081867afc8798c70a2e83599098e6">audio_tools::ModifyingOutput::setOutput</a></div><div class="ttdeci">virtual void setOutput(Print &amp;out)=0</div><div class="ttdoc">Defines/Changes the output target.</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_modifying_stream.html">audio_tools::ModifyingStream</a></div><div class="ttdoc">Abstract class: Objects can be put into a pipleline.</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:69</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_stream_html_a8e1c65fb30e954338cc81330d1e2b0c3"><div class="ttname"><a href="classaudio__tools_1_1_modifying_stream.html#a8e1c65fb30e954338cc81330d1e2b0c3">audio_tools::ModifyingStream::setStream</a></div><div class="ttdeci">virtual void setStream(Stream &amp;in)=0</div><div class="ttdoc">Defines/Changes the input &amp; output.</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_modifying_stream_html_ac68081867afc8798c70a2e83599098e6"><div class="ttname"><a href="classaudio__tools_1_1_modifying_stream.html#ac68081867afc8798c70a2e83599098e6">audio_tools::ModifyingStream::setOutput</a></div><div class="ttdeci">virtual void setOutput(Print &amp;out)=0</div><div class="ttdoc">Defines/Changes the output target.</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_multi_output_html"><div class="ttname"><a href="classaudio__tools_1_1_multi_output.html">audio_tools::MultiOutput</a></div><div class="ttdoc">Replicates the output to multiple destinations.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:304</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_multi_output_html"><div class="ttname"><a href="classaudio__tools_1_1_multi_output.html">audio_tools::MultiOutput</a></div><div class="ttdoc">Replicates the output to multiple destinations.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:317</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_pipeline_html"><div class="ttname"><a href="classaudio__tools_1_1_pipeline.html">audio_tools::Pipeline</a></div><div class="ttdoc">We can build a input or an output chain: an input chain starts with setInput(); followed by add() an ...</div><div class="ttdef"><b>Definition:</b> Pipeline.h:16</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_pipeline_html_a095e05973ce76113c2f37c36ec7d6f9b"><div class="ttname"><a href="classaudio__tools_1_1_pipeline.html#a095e05973ce76113c2f37c36ec7d6f9b">audio_tools::Pipeline::operator[]</a></div><div class="ttdeci">ModifyingStream &amp; operator[](int idx)</div><div class="ttdoc">Access to the components by index.</div><div class="ttdef"><b>Definition:</b> Pipeline.h:257</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_pipeline_html_a0fdc695c579f1437908d8a898e7c276a"><div class="ttname"><a href="classaudio__tools_1_1_pipeline.html#a0fdc695c579f1437908d8a898e7c276a">audio_tools::Pipeline::setOutput</a></div><div class="ttdeci">bool setOutput(AudioStream &amp;out)</div><div class="ttdoc">Defines the output for an output pipeline: must be last call after add()</div><div class="ttdef"><b>Definition:</b> Pipeline.h:84</div></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,17 @@
<tr bgcolor="#f0f0f0"><td class="entry"><b>AdapterAudioOutputToAudioStream</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>AdapterAudioOutputToAudioStream</b>(AudioOutput &amp;stream) (defined in <a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a727a24459787e1eeeb7a37ba888394a6">addNotifyAudioChange</a>(AudioInfoSupport &amp;bi)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html#aececda97cff151859a8695d30896dd20">audioInfo</a>() override</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html#aed4bf0d5ce93f27242be485943d0b37d">audioInfo</a>() override</td><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_support.html#a1c77cb3dbe910c765ea439d103bdcbb9">audioInfoOut</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>AudioStream</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>AudioStream</b>(AudioStream const &amp;)=delete (defined in <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>available</b>() override (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>availableForWrite</b>() override (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>BaseStream</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>BaseStream</b>(BaseStream const &amp;)=delete (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>begin</b>() (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>begin</b>() override (defined in <a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#affd15675a5e391c34cccefa7181354bb">clearNotifyAudioChange</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>end</b>() (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>end</b>() override (defined in <a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>flush</b>() override (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>info</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>is_notify_active</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
Expand All @@ -95,7 +95,7 @@
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>not_supported</b>(int out, const char *msg=&quot;&quot;) (defined in <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>notify_vector</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>notifyAudioChange</b>(AudioInfo info) (defined in <a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_info_source.html">AudioInfoSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>operator bool</b>() (defined in <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>operator bool</b>() override (defined in <a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator=</b>(AudioStream const &amp;)=delete (defined in <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>operator=</b>(BaseStream const &amp;)=delete (defined in <a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_stream.html">BaseStream</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>p_stream</b> (defined in <a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html">AdapterAudioOutputToAudioStream</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
Expand Down
Loading

0 comments on commit bb563d3

Please sign in to comment.