Skip to content

Commit be1f11e

Browse files
committed
Deploying to doxygen from @ 595d8d0 🚀
1 parent c4f004a commit be1f11e

14 files changed

+901
-839
lines changed

_audio_player_8h_source.html

Lines changed: 406 additions & 386 deletions
Large diffs are not rendered by default.

_k_a_radio_protocol_8h_source.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -333,14 +333,14 @@
333333
</div>
334334
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span>} <span class="comment">// namespace audio_tools</span></div>
335335
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html">audio_tools::AudioPlayer</a></div><div class="ttdoc">High-level audio playback pipeline and controller.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:51</div></div>
336-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a1a96b8bdaed492d3a380658d381a87b2"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a1a96b8bdaed492d3a380658d381a87b2">audio_tools::AudioPlayer::audioSource</a></div><div class="ttdeci">AudioSource &amp; audioSource()</div><div class="ttdoc">Returns the active AudioSource.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:236</div></div>
337-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a645f14b9b646688d8e8c03f193ab0cf3"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a645f14b9b646688d8e8c03f193ab0cf3">audio_tools::AudioPlayer::setVolume</a></div><div class="ttdeci">bool setVolume(float volume) override</div><div class="ttdoc">Sets volume in range [0.0, 1.0]; updates VolumeStream.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:388</div></div>
336+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a1a96b8bdaed492d3a380658d381a87b2"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a1a96b8bdaed492d3a380658d381a87b2">audio_tools::AudioPlayer::audioSource</a></div><div class="ttdeci">AudioSource &amp; audioSource()</div><div class="ttdoc">Returns the active AudioSource.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:237</div></div>
337+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a645f14b9b646688d8e8c03f193ab0cf3"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a645f14b9b646688d8e8c03f193ab0cf3">audio_tools::AudioPlayer::setVolume</a></div><div class="ttdeci">bool setVolume(float volume) override</div><div class="ttdoc">Sets volume in range [0.0, 1.0]; updates VolumeStream.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:389</div></div>
338338
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a7496c69d3c2ca5144ed71f18e24520cb"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a7496c69d3c2ca5144ed71f18e24520cb">audio_tools::AudioPlayer::next</a></div><div class="ttdeci">bool next(int offset=1)</div><div class="ttdoc">Moves to the next/previous stream by offset (negative supported)</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:313</div></div>
339-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a75896c16336462449610b256c8313b4c"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a75896c16336462449610b256c8313b4c">audio_tools::AudioPlayer::volume</a></div><div class="ttdeci">float volume() override</div><div class="ttdoc">Returns the current volume [0.0, 1.0].</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:404</div></div>
340-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_aa1f512ab0fcc05612f8e3d6a4664ce9a"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#aa1f512ab0fcc05612f8e3d6a4664ce9a">audio_tools::AudioPlayer::isActive</a></div><div class="ttdeci">bool isActive()</div><div class="ttdoc">Checks whether playback is active.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:368</div></div>
339+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a75896c16336462449610b256c8313b4c"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a75896c16336462449610b256c8313b4c">audio_tools::AudioPlayer::volume</a></div><div class="ttdeci">float volume() override</div><div class="ttdoc">Returns the current volume [0.0, 1.0].</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:405</div></div>
340+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_aa1f512ab0fcc05612f8e3d6a4664ce9a"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#aa1f512ab0fcc05612f8e3d6a4664ce9a">audio_tools::AudioPlayer::isActive</a></div><div class="ttdeci">bool isActive()</div><div class="ttdoc">Checks whether playback is active.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:369</div></div>
341341
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_aa4ebe00d56357749257e6acafc945ae7"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#aa4ebe00d56357749257e6acafc945ae7">audio_tools::AudioPlayer::previous</a></div><div class="ttdeci">bool previous(int offset=1)</div><div class="ttdoc">Moves back by offset streams (defaults to 1)</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:340</div></div>
342342
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_ac28f81543d548d42d71ded1c5dfa912c"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#ac28f81543d548d42d71ded1c5dfa912c">audio_tools::AudioPlayer::setPath</a></div><div class="ttdeci">bool setPath(const char *path)</div><div class="ttdoc">Selects stream by path without changing the source iterator.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:331</div></div>
343-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_ad3efacc385ffaca8b3e0c8858971ae6f"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#ad3efacc385ffaca8b3e0c8858971ae6f">audio_tools::AudioPlayer::setActive</a></div><div class="ttdeci">void setActive(bool isActive)</div><div class="ttdoc">Toggles playback activity; triggers fade and optional silence.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:374</div></div>
343+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_ad3efacc385ffaca8b3e0c8858971ae6f"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#ad3efacc385ffaca8b3e0c8858971ae6f">audio_tools::AudioPlayer::setActive</a></div><div class="ttdeci">void setActive(bool isActive)</div><div class="ttdoc">Toggles playback activity; triggers fade and optional silence.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:375</div></div>
344344
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html">audio_tools::AudioPlayerProtocol</a></div><div class="ttdoc">Abstract class for protocol to control the audio player.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:11</div></div>
345345
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html_a71bda82938183043ae813edd2d3a2885"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html#a71bda82938183043ae813edd2d3a2885">audio_tools::AudioPlayerProtocol::processCommand</a></div><div class="ttdeci">virtual bool processCommand(const char *input, Print &amp;result)=0</div></div>
346346
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_protocol_html_a83d10b9dd3cc7fe7fbe5eaf2c1c3fc3b"><div class="ttname"><a href="classaudio__tools_1_1_audio_player_protocol.html#a83d10b9dd3cc7fe7fbe5eaf2c1c3fc3b">audio_tools::AudioPlayerProtocol::setPlayer</a></div><div class="ttdeci">virtual void setPlayer(AudioPlayer &amp;player)</div><div class="ttdoc">Defines the player.</div><div class="ttdef"><b>Definition</b> AudioPlayerProtocol.h:25</div></div>

_m4_a_file_sample_size_buffer_8h_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@
169169
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
170170
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span>} <span class="comment">// namespace audio_tools</span></div>
171171
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html">audio_tools::AudioPlayer</a></div><div class="ttdoc">High-level audio playback pipeline and controller.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:51</div></div>
172-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a2e7b2d0d8c3da2999e876602d5efa09f"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a2e7b2d0d8c3da2999e876602d5efa09f">audio_tools::AudioPlayer::setOnStreamChangeCallback</a></div><div class="ttdeci">void setOnStreamChangeCallback(void(*callback)(Stream *stream_ptr, void *reference))</div><div class="ttdoc">Defines a callback that is called when the stream is changed.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:521</div></div>
173-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a99d57924ad8bf6c8765005de08b3a214"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a99d57924ad8bf6c8765005de08b3a214">audio_tools::AudioPlayer::setReference</a></div><div class="ttdeci">void setReference(void *ref)</div><div class="ttdoc">Sets a user reference passed to the stream-change callback.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:500</div></div>
172+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a2e7b2d0d8c3da2999e876602d5efa09f"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a2e7b2d0d8c3da2999e876602d5efa09f">audio_tools::AudioPlayer::setOnStreamChangeCallback</a></div><div class="ttdeci">void setOnStreamChangeCallback(void(*callback)(Stream *stream_ptr, void *reference))</div><div class="ttdoc">Defines a callback that is called when the stream is changed.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:531</div></div>
173+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a99d57924ad8bf6c8765005de08b3a214"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a99d57924ad8bf6c8765005de08b3a214">audio_tools::AudioPlayer::setReference</a></div><div class="ttdeci">void setReference(void *ref)</div><div class="ttdoc">Sets a user reference passed to the stream-change callback.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:510</div></div>
174174
<div class="ttc" id="aclassaudio__tools_1_1_base_buffer_html"><div class="ttname"><a href="classaudio__tools_1_1_base_buffer.html">audio_tools::BaseBuffer</a></div><div class="ttdoc">Shared functionality of all buffers.</div><div class="ttdef"><b>Definition</b> Buffers.h:22</div></div>
175175
<div class="ttc" id="aclassaudio__tools_1_1_container_m4_a_html"><div class="ttname"><a href="classaudio__tools_1_1_container_m4_a.html">audio_tools::ContainerM4A</a></div><div class="ttdoc">M4A Demuxer that extracts audio from M4A/MP4 containers. The audio is decoded into pcm with the help ...</div><div class="ttdef"><b>Definition</b> ContainerM4A.h:17</div></div>
176176
<div class="ttc" id="aclassaudio__tools_1_1_m4_a_audio_file_demuxer_html"><div class="ttname"><a href="classaudio__tools_1_1_m4_a_audio_file_demuxer.html">audio_tools::M4AAudioFileDemuxer</a></div><div class="ttdoc">Demuxer for M4A/MP4 files to extract audio data using an Arduino File. This class locates the mdat an...</div><div class="ttdef"><b>Definition</b> M4AAudioFileDemuxer.h:25</div></div>

_r_c_audio_player_o_s_c_8h_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,8 +280,8 @@
280280
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> </div>
281281
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span>} <span class="comment">// namespace audio_tools</span></div>
282282
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html">audio_tools::AudioPlayer</a></div><div class="ttdoc">High-level audio playback pipeline and controller.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:51</div></div>
283-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a645f14b9b646688d8e8c03f193ab0cf3"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a645f14b9b646688d8e8c03f193ab0cf3">audio_tools::AudioPlayer::setVolume</a></div><div class="ttdeci">bool setVolume(float volume) override</div><div class="ttdoc">Sets volume in range [0.0, 1.0]; updates VolumeStream.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:388</div></div>
284-
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a6d58098c6cf63c241ed03bc797256bb1"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a6d58098c6cf63c241ed03bc797256bb1">audio_tools::AudioPlayer::play</a></div><div class="ttdeci">void play()</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:277</div></div>
283+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a645f14b9b646688d8e8c03f193ab0cf3"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a645f14b9b646688d8e8c03f193ab0cf3">audio_tools::AudioPlayer::setVolume</a></div><div class="ttdeci">bool setVolume(float volume) override</div><div class="ttdoc">Sets volume in range [0.0, 1.0]; updates VolumeStream.</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:389</div></div>
284+
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a6d58098c6cf63c241ed03bc797256bb1"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a6d58098c6cf63c241ed03bc797256bb1">audio_tools::AudioPlayer::play</a></div><div class="ttdeci">void play()</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:278</div></div>
285285
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a7496c69d3c2ca5144ed71f18e24520cb"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a7496c69d3c2ca5144ed71f18e24520cb">audio_tools::AudioPlayer::next</a></div><div class="ttdeci">bool next(int offset=1)</div><div class="ttdoc">Moves to the next/previous stream by offset (negative supported)</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:313</div></div>
286286
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_a8c528baf37154d347366083f0f816846"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#a8c528baf37154d347366083f0f816846">audio_tools::AudioPlayer::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Halts playback; equivalent to setActive(false)</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:307</div></div>
287287
<div class="ttc" id="aclassaudio__tools_1_1_audio_player_html_aa4ebe00d56357749257e6acafc945ae7"><div class="ttname"><a href="classaudio__tools_1_1_audio_player.html#aa4ebe00d56357749257e6acafc945ae7">audio_tools::AudioPlayer::previous</a></div><div class="ttdeci">bool previous(int offset=1)</div><div class="ttdoc">Moves back by offset streams (defaults to 1)</div><div class="ttdef"><b>Definition</b> AudioPlayer.h:340</div></div>

0 commit comments

Comments
 (0)