Skip to content

Commit 9124f6b

Browse files
committed
Deploying to doxygen from @ 950f9c6 🚀
1 parent d51cd3b commit 9124f6b

File tree

157 files changed

+4025
-4479
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+4025
-4479
lines changed

_audio_player_8h_source.html

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@
330330
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; fade.setFadeInActive(<span class="keyword">true</span>);</div>
331331
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; } <span class="keywordflow">else</span> {</div>
332332
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; fade.setFadeOutActive(<span class="keyword">true</span>);</div>
333-
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; copier.<a class="code" href="classaudio__tools_1_1_stream_copy.html#a226bbd7cd5d674fabacfb94711178728">copy</a>();</div>
333+
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; copier.<a class="code" href="classaudio__tools_1_1_stream_copy_t.html#aecb44a6d385121be2179187d45520331">copy</a>();</div>
334334
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <a class="code" href="classaudio__tools_1_1_audio_player.html#a141b42d2d12f5c7d841d06285d298180">writeSilence</a>(2048);</div>
335335
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; }</div>
336336
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; }</div>
@@ -418,7 +418,7 @@
418418
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160; volume_out.<a class="code" href="classaudio__tools_1_1_volume_stream.html#af563fb27e0137b006c62af82654083fb">setVolumeControl</a>(vc);</div>
419419
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; }</div>
420420
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160; </div>
421-
<div class="line"><a name="l00426"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_audio_player.html#af02fb17cf31766de2b594f189bdf498a"> 426</a></span>&#160; <a class="code" href="classaudio__tools_1_1_stream_copy.html">StreamCopy</a> &amp;<a class="code" href="classaudio__tools_1_1_audio_player.html#af02fb17cf31766de2b594f189bdf498a">getStreamCopy</a>() { <span class="keywordflow">return</span> copier; }</div>
421+
<div class="line"><a name="l00426"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_audio_player.html#af02fb17cf31766de2b594f189bdf498a"> 426</a></span>&#160; <a class="code" href="classaudio__tools_1_1_stream_copy_t.html">StreamCopy</a> &amp;<a class="code" href="classaudio__tools_1_1_audio_player.html#af02fb17cf31766de2b594f189bdf498a">getStreamCopy</a>() { <span class="keywordflow">return</span> copier; }</div>
422422
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160; </div>
423423
<div class="line"><a name="l00430"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_audio_player.html#a24f4ec11382e0812ee4e2711228fe94a"> 430</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_audio_player.html#a24f4ec11382e0812ee4e2711228fe94a">setSilenceOnInactive</a>(<span class="keywordtype">bool</span> active) { silence_on_inactive = active; }</div>
424424
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; </div>
@@ -457,7 +457,7 @@
457457
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>&#160; AudioOutput *p_final_print = <span class="keyword">nullptr</span>;</div>
458458
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>&#160; AudioStream *p_final_stream = <span class="keyword">nullptr</span>;</div>
459459
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>&#160; AudioInfoSupport *p_final_notify = <span class="keyword">nullptr</span>;</div>
460-
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160; StreamCopy copier; <span class="comment">// copies sound into i2s</span></div>
460+
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160; <a class="code" href="group__tools.html#gaa917267e241cc74cd4610bf8674a6e93">StreamCopy</a> copier; <span class="comment">// copies sound into i2s</span></div>
461461
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>&#160; AudioInfo info;</div>
462462
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>&#160; <span class="keywordtype">bool</span> meta_active = <span class="keyword">false</span>;</div>
463463
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>&#160; uint32_t timeout = 0;</div>
@@ -580,13 +580,13 @@
580580
<div class="ttc" id="aclassaudio__tools_1_1_fade_stream_html_ad1fdd56031f1195cb221ab855fb6a102"><div class="ttname"><a href="classaudio__tools_1_1_fade_stream.html#ad1fdd56031f1195cb221ab855fb6a102">audio_tools::FadeStream::setAudioInfo</a></div><div class="ttdeci">void setAudioInfo(AudioInfo info) override</div><div class="ttdoc">Defines the input AudioInfo.</div><div class="ttdef"><b>Definition:</b> Fade.h:267</div></div>
581581
<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:581</div></div>
582582
<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>
583-
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_html"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy.html">audio_tools::StreamCopy</a></div><div class="ttdoc">We provide the typeless StreamCopy as a subclass of StreamCopyT.</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:444</div></div>
584-
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_html_a226bbd7cd5d674fabacfb94711178728"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy.html#a226bbd7cd5d674fabacfb94711178728">audio_tools::StreamCopy::copy</a></div><div class="ttdeci">size_t copy(BaseConverter &amp;converter)</div><div class="ttdoc">copies the data from the source to the destination and applies the converter - the result is the proc...</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:469</div></div>
585-
<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:97</div></div>
586-
<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:302</div></div>
587-
<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:260</div></div>
588-
<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:54</div></div>
589-
<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:277</div></div>
583+
<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>
584+
<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:99</div></div>
585+
<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:306</div></div>
586+
<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:264</div></div>
587+
<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>
588+
<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:281</div></div>
589+
<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:87</div></div>
590590
<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>
591591
<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>
592592
<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>
@@ -597,6 +597,7 @@
597597
<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:205</div></div>
598598
<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>
599599
<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>
600+
<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:450</div></div>
600601
<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:796</div></div>
601602
<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>
602603
<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>

_audio_server_8h_source.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@
202202
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *content_type = <span class="keyword">nullptr</span>;</div>
203203
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; AudioServerDataCallback callback = <span class="keyword">nullptr</span>;</div>
204204
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; Stream *in = <span class="keyword">nullptr</span>;</div>
205-
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; StreamCopy copier;</div>
205+
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <a class="code" href="group__tools.html#gaa917267e241cc74cd4610bf8674a6e93">StreamCopy</a> copier;</div>
206206
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; BaseConverter *converter_ptr = <span class="keyword">nullptr</span>;</div>
207207
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; </div>
208208
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keywordtype">void</span> setupServer(<span class="keywordtype">int</span> port) {</div>
@@ -451,6 +451,7 @@
451451
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160;<span class="preprocessor">#endif</span></div>
452452
<div class="ttc" id="a_audio_tools_8h_html"><div class="ttname"><a href="_audio_tools_8h.html">AudioTools.h</a></div></div>
453453
<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>
454+
<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:450</div></div>
454455
<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:796</div></div>
455456
</div><!-- fragment --></div><!-- contents -->
456457
<!-- start footer part -->

0 commit comments

Comments
 (0)