Skip to content

Commit

Permalink
Deploying to doxygen from @ f684307 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Dec 8, 2024
1 parent 3c6ece6 commit 20d955a
Show file tree
Hide file tree
Showing 139 changed files with 3,732 additions and 3,722 deletions.
14 changes: 7 additions & 7 deletions _audio_player_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -575,12 +575,12 @@
<div class="ttc" id="aclassaudio__tools_1_1_meta_data_i_d3_html_a8b8471dbbdc5527cdf9bfd31612cc973"><div class="ttname"><a href="classaudio__tools_1_1_meta_data_i_d3.html#a8b8471dbbdc5527cdf9bfd31612cc973">audio_tools::MetaDataID3::write</a></div><div class="ttdeci">virtual size_t write(const uint8_t *data, size_t len)</div><div class="ttdoc">Provide tha audio data to the API to parse for Meta Data.</div><div class="ttdef"><b>Definition:</b> MetaDataID3.h:579</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_copy_t_html"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html">audio_tools::StreamCopyT&lt; uint8_t &gt;</a></div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a3993f8f9a06bac4f0a79961887086cc5"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a3993f8f9a06bac4f0a79961887086cc5">audio_tools::StreamCopyT::copyBytes</a></div><div class="ttdeci">size_t copyBytes(size_t bytes)</div><div class="ttdoc">copies the inicated number of bytes from the source to the destination and returns the processed numb...</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:101</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a6038284a43db2e3e343c6f517171e8fe"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a6038284a43db2e3e343c6f517171e8fe">audio_tools::StreamCopyT::resize</a></div><div class="ttdeci">void resize(int len)</div><div class="ttdoc">resizes the copy buffer</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:308</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a7575750492ee545b18faf84cdada3caa"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a7575750492ee545b18faf84cdada3caa">audio_tools::StreamCopyT::setCallbackOnWrite</a></div><div class="ttdeci">void setCallbackOnWrite(void(*onWrite)(void *obj, void *buffer, size_t len), void *obj)</div><div class="ttdoc">Defines a callback that is notified with the wirtten data.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:266</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_ab0bdf5cca484fb2ba637c39384b27fb2"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#ab0bdf5cca484fb2ba637c39384b27fb2">audio_tools::StreamCopyT::begin</a></div><div class="ttdeci">void begin()</div><div class="ttdoc">(Re)starts the processing</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:45</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_ab30bc84f9ea0a116951f3ad2a281c54f"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#ab30bc84f9ea0a116951f3ad2a281c54f">audio_tools::StreamCopyT::bufferSize</a></div><div class="ttdeci">int bufferSize()</div><div class="ttdoc">Provides the buffer size.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:283</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_aecb44a6d385121be2179187d45520331"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#aecb44a6d385121be2179187d45520331">audio_tools::StreamCopyT::copy</a></div><div class="ttdeci">size_t copy()</div><div class="ttdoc">copies the data from the source to the destination and returns the processed number of bytes</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:89</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a3993f8f9a06bac4f0a79961887086cc5"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a3993f8f9a06bac4f0a79961887086cc5">audio_tools::StreamCopyT::copyBytes</a></div><div class="ttdeci">size_t copyBytes(size_t bytes)</div><div class="ttdoc">copies the inicated number of bytes from the source to the destination and returns the processed numb...</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:108</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a6038284a43db2e3e343c6f517171e8fe"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a6038284a43db2e3e343c6f517171e8fe">audio_tools::StreamCopyT::resize</a></div><div class="ttdeci">void resize(int len)</div><div class="ttdoc">resizes the copy buffer</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:315</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a7575750492ee545b18faf84cdada3caa"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a7575750492ee545b18faf84cdada3caa">audio_tools::StreamCopyT::setCallbackOnWrite</a></div><div class="ttdeci">void setCallbackOnWrite(void(*onWrite)(void *obj, void *buffer, size_t len), void *obj)</div><div class="ttdoc">Defines a callback that is notified with the wirtten data.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:273</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_ab0bdf5cca484fb2ba637c39384b27fb2"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#ab0bdf5cca484fb2ba637c39384b27fb2">audio_tools::StreamCopyT::begin</a></div><div class="ttdeci">void begin()</div><div class="ttdoc">(Re)starts the processing</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:49</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_ab30bc84f9ea0a116951f3ad2a281c54f"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#ab30bc84f9ea0a116951f3ad2a281c54f">audio_tools::StreamCopyT::bufferSize</a></div><div class="ttdeci">int bufferSize()</div><div class="ttdoc">Provides the buffer size.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:290</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_aecb44a6d385121be2179187d45520331"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#aecb44a6d385121be2179187d45520331">audio_tools::StreamCopyT::copy</a></div><div class="ttdeci">size_t copy()</div><div class="ttdoc">copies the data from the source to the destination and returns the processed number of bytes</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:96</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_volume_control_html"><div class="ttname"><a href="classaudio__tools_1_1_volume_control.html">audio_tools::VolumeControl</a></div><div class="ttdoc">Abstract class for handling of the linear input volume to determine the multiplication factor which s...</div><div class="ttdef"><b>Definition:</b> VolumeControl.h:17</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_volume_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_volume_stream.html">audio_tools::VolumeStream</a></div><div class="ttdoc">Adjust the volume of the related input or output: To work properly the class needs to know the bits p...</div><div class="ttdef"><b>Definition:</b> VolumeStream.h:34</div></div>
Expand All @@ -591,7 +591,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_volume_support_html"><div class="ttname"><a href="classaudio__tools_1_1_volume_support.html">audio_tools::VolumeSupport</a></div><div class="ttdoc">Supports the setting and getting of the volume.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:207</div></div>
<div class="ttc" id="agroup__metadata_html_ga27477aa4d162c65da12c7ffd964f5779"><div class="ttname"><a href="group__metadata.html#ga27477aa4d162c65da12c7ffd964f5779">audio_tools::ID3TypeSelection</a></div><div class="ttdeci">ID3TypeSelection</div><div class="ttdoc">Enum to filter by type of metadata.</div><div class="ttdef"><b>Definition:</b> AbstractMetaData.h:8</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="agroup__tools_html_gaa917267e241cc74cd4610bf8674a6e93"><div class="ttname"><a href="group__tools.html#gaa917267e241cc74cd4610bf8674a6e93">audio_tools::StreamCopy</a></div><div class="ttdeci">StreamCopyT&lt; uint8_t &gt; StreamCopy</div><div class="ttdoc">We provide the typeless StreamCopy.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:453</div></div>
<div class="ttc" id="agroup__tools_html_gaa917267e241cc74cd4610bf8674a6e93"><div class="ttname"><a href="group__tools.html#gaa917267e241cc74cd4610bf8674a6e93">audio_tools::StreamCopy</a></div><div class="ttdeci">StreamCopyT&lt; uint8_t &gt; StreamCopy</div><div class="ttdoc">We provide the typeless StreamCopy.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:460</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:868</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a5e3b5cd9da90a770b25160f8b0126982"><div class="ttname"><a href="namespaceaudio__tools.html#a5e3b5cd9da90a770b25160f8b0126982">audio_tools::millis</a></div><div class="ttdeci">uint32_t millis()</div><div class="ttdoc">Returns the milliseconds since the start.</div><div class="ttdef"><b>Definition:</b> Time.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:52</div></div>
Expand Down
2 changes: 1 addition & 1 deletion _audio_server_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="a_audio_tools_8h_html"><div class="ttname"><a href="_audio_tools_8h.html">AudioTools.h</a></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:27</div></div>
<div class="ttc" id="agroup__tools_html_gaa917267e241cc74cd4610bf8674a6e93"><div class="ttname"><a href="group__tools.html#gaa917267e241cc74cd4610bf8674a6e93">audio_tools::StreamCopy</a></div><div class="ttdeci">StreamCopyT&lt; uint8_t &gt; StreamCopy</div><div class="ttdoc">We provide the typeless StreamCopy.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:453</div></div>
<div class="ttc" id="agroup__tools_html_gaa917267e241cc74cd4610bf8674a6e93"><div class="ttname"><a href="group__tools.html#gaa917267e241cc74cd4610bf8674a6e93">audio_tools::StreamCopy</a></div><div class="ttdeci">StreamCopyT&lt; uint8_t &gt; StreamCopy</div><div class="ttdoc">We provide the typeless StreamCopy.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:460</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:868</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
4 changes: 2 additions & 2 deletions _h_l_s_stream_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -766,8 +766,8 @@
<div class="ttc" id="aclassaudio__tools_1_1_str_view_html_a4c78c47ce1c204f9d233485b8036ac0e"><div class="ttname"><a href="classaudio__tools_1_1_str_view.html#a4c78c47ce1c204f9d233485b8036ac0e">audio_tools::StrView::length</a></div><div class="ttdeci">virtual int length()</div><div class="ttdef"><b>Definition:</b> StrView.h:383</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_str_view_html_a9ccdbd62a9a4ce6642622d748894728e"><div class="ttname"><a href="classaudio__tools_1_1_str_view.html#a9ccdbd62a9a4ce6642622d748894728e">audio_tools::StrView::c_str</a></div><div class="ttdeci">virtual const char * c_str()</div><div class="ttdoc">provides the string value as const char*</div><div class="ttdef"><b>Definition:</b> StrView.h:379</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html">audio_tools::StreamCopyT&lt; uint8_t &gt;</a></div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a81c4dd3919c1824540306c995521c89a"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a81c4dd3919c1824540306c995521c89a">audio_tools::StreamCopyT::copyAll</a></div><div class="ttdeci">size_t copyAll(int retryCount=5, int retryWaitMs=200)</div><div class="ttdoc">copies all data - returns the number of processed bytes</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:204</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_ab0bdf5cca484fb2ba637c39384b27fb2"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#ab0bdf5cca484fb2ba637c39384b27fb2">audio_tools::StreamCopyT::begin</a></div><div class="ttdeci">void begin()</div><div class="ttdoc">(Re)starts the processing</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:45</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_a81c4dd3919c1824540306c995521c89a"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#a81c4dd3919c1824540306c995521c89a">audio_tools::StreamCopyT::copyAll</a></div><div class="ttdeci">size_t copyAll(int retryCount=5, int retryWaitMs=200)</div><div class="ttdoc">copies all data - returns the number of processed bytes</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:211</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html_ab0bdf5cca484fb2ba637c39384b27fb2"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html#ab0bdf5cca484fb2ba637c39384b27fb2">audio_tools::StreamCopyT::begin</a></div><div class="ttdeci">void begin()</div><div class="ttdoc">(Re)starts the processing</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:49</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_u_r_l_history_html"><div class="ttname"><a href="classaudio__tools_1_1_u_r_l_history.html">audio_tools::URLHistory</a></div><div class="ttdef"><b>Definition:</b> HLSStream.h:244</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_u_r_l_loader_h_l_s_base_html"><div class="ttname"><a href="classaudio__tools_1_1_u_r_l_loader_h_l_s_base.html">audio_tools::URLLoaderHLSBase</a></div><div class="ttdoc">Abstract API for URLLoaderHLS.</div><div class="ttdef"><b>Definition:</b> HLSStream.h:17</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_u_r_l_loader_h_l_s_html"><div class="ttname"><a href="classaudio__tools_1_1_u_r_l_loader_h_l_s.html">audio_tools::URLLoaderHLS</a></div><div class="ttdef"><b>Definition:</b> HLSStream.h:67</div></div>
Expand Down
Loading

0 comments on commit 20d955a

Please sign in to comment.