Skip to content

Commit fafa2be

Browse files
committed
Deploying to doxygen from @ a54b1bb 🚀
1 parent f57dee2 commit fafa2be

File tree

43 files changed

+978
-815
lines changed

Some content is hidden

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

43 files changed

+978
-815
lines changed

_audio_source_8h_source.html

Lines changed: 644 additions & 640 deletions
Large diffs are not rendered by default.

_k_a_radio_protocol_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@
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>
347347
<div class="ttc" id="aclassaudio__tools_1_1_audio_source_html_a05d9a9704b4cdd7447cd163af9e07788"><div class="ttname"><a href="classaudio__tools_1_1_audio_source.html#a05d9a9704b4cdd7447cd163af9e07788">audio_tools::AudioSource::index</a></div><div class="ttdeci">virtual int index()</div><div class="ttdoc">Returns the actual index of the stream.</div><div class="ttdef"><b>Definition</b> AudioSource.h:38</div></div>
348-
<div class="ttc" id="aclassaudio__tools_1_1_audio_source_html_abcb5a6731b503dec41bf6e3052dc73e6"><div class="ttname"><a href="classaudio__tools_1_1_audio_source.html#abcb5a6731b503dec41bf6e3052dc73e6">audio_tools::AudioSource::toStr</a></div><div class="ttdeci">virtual const char * toStr()</div><div class="ttdoc">provides the actual stream (e.g. file) name or url</div><div class="ttdef"><b>Definition</b> AudioSource.h:69</div></div>
348+
<div class="ttc" id="aclassaudio__tools_1_1_audio_source_html_abcb5a6731b503dec41bf6e3052dc73e6"><div class="ttname"><a href="classaudio__tools_1_1_audio_source.html#abcb5a6731b503dec41bf6e3052dc73e6">audio_tools::AudioSource::toStr</a></div><div class="ttdeci">virtual const char * toStr()</div><div class="ttdoc">provides the actual stream (e.g. file) name or url</div><div class="ttdef"><b>Definition</b> AudioSource.h:72</div></div>
349349
<div class="ttc" id="aclassaudio__tools_1_1_k_a_radio_protocol_html"><div class="ttname"><a href="classaudio__tools_1_1_k_a_radio_protocol.html">audio_tools::KARadioProtocol</a></div><div class="ttdoc">KA-Radio Protocol: We can use the KA-Radio protocol to control the audio player provided by the audio...</div><div class="ttdef"><b>Definition</b> KARadioProtocol.h:26</div></div>
350350
<div class="ttc" id="aclassaudio__tools_1_1_k_a_radio_protocol_html_a019749328da42c4814af71d3e3b647ad"><div class="ttname"><a href="classaudio__tools_1_1_k_a_radio_protocol.html#a019749328da42c4814af71d3e3b647ad">audio_tools::KARadioProtocol::index</a></div><div class="ttdeci">int index()</div><div class="ttdoc">Provides the actual index.</div><div class="ttdef"><b>Definition</b> KARadioProtocol.h:214</div></div>
351351
<div class="ttc" id="aclassaudio__tools_1_1_k_a_radio_protocol_html_a050649f9f226f963a0bcec4d310f11ca"><div class="ttname"><a href="classaudio__tools_1_1_k_a_radio_protocol.html#a050649f9f226f963a0bcec4d310f11ca">audio_tools::KARadioProtocol::KARadioProtocol</a></div><div class="ttdeci">KARadioProtocol(AudioPlayer &amp;player)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition</b> KARadioProtocol.h:140</div></div>

classaudio__tools_1_1_audio_source-members.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,14 @@
8181
<table class="directory">
8282
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#ae8a0d9ca63f8bb3de100e347c3f3bca4">begin</a>()=0</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
8383
<tr class="odd"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a05d9a9704b4cdd7447cd163af9e07788">index</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
84-
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#aa1a2ebc04c10e3b7c5704943dc22b1cb">isAutoNext</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
85-
<tr class="odd"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#ab68bdb48a6153114da10becc8d14267a">nextStream</a>(int offset)=0</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
86-
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#ae6f94ab5bac42f3054d5d23b24219ec9">operator[]</a>(int idx)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
87-
<tr class="odd"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a7e7c50ff51ba2532b70cabc39fbdd768">previousStream</a>(int offset)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
88-
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a56a7cb68f0abb8dc30e48d13f9624746">selectStream</a>(int index)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
89-
<tr class="odd"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a1718d4bbd3f6a1c533bf86d202aeda90">selectStream</a>(const char *path)=0</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
84+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>is_auto_next</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
85+
<tr class="odd"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#aa1a2ebc04c10e3b7c5704943dc22b1cb">isAutoNext</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
86+
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#ab68bdb48a6153114da10becc8d14267a">nextStream</a>(int offset)=0</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
87+
<tr class="odd"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#ae6f94ab5bac42f3054d5d23b24219ec9">operator[]</a>(int idx)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
88+
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a7e7c50ff51ba2532b70cabc39fbdd768">previousStream</a>(int offset)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
89+
<tr class="odd"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a56a7cb68f0abb8dc30e48d13f9624746">selectStream</a>(int index)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
90+
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a1718d4bbd3f6a1c533bf86d202aeda90">selectStream</a>(const char *path)=0</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
91+
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>setAutoNext</b>(bool flag) (defined in <a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
9092
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a95d0bdc3b24e374ecc10df9af1af7333">setIndex</a>(int index)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
9193
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>setMetadataCallback</b>(void(*fn)(MetaDataType info, const char *str, int len), ID3TypeSelection sel=SELECT_ICY) (defined in <a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
9294
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html#a23e18762a56c2865cfb8abb1f3361af8">setTimeout</a>(int millisec)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_source.html">AudioSource</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>

classaudio__tools_1_1_audio_source.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,9 @@
136136
<tr class="separator:a1718d4bbd3f6a1c533bf86d202aeda90"><td class="memSeparator" colspan="2">&#160;</td></tr>
137137
<tr class="memitem:a56a7cb68f0abb8dc30e48d13f9624746" id="r_a56a7cb68f0abb8dc30e48d13f9624746"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_source.html#a56a7cb68f0abb8dc30e48d13f9624746">selectStream</a> (int <a class="el" href="classaudio__tools_1_1_audio_source.html#a05d9a9704b4cdd7447cd163af9e07788">index</a>)</td></tr>
138138
<tr class="separator:a56a7cb68f0abb8dc30e48d13f9624746"><td class="memSeparator" colspan="2">&#160;</td></tr>
139+
<tr class="memitem:a6ab8295fdd7c303ed2495e628d521c1e" id="r_a6ab8295fdd7c303ed2495e628d521c1e"><td class="memItemLeft" align="right" valign="top"><a id="a6ab8295fdd7c303ed2495e628d521c1e" name="a6ab8295fdd7c303ed2495e628d521c1e"></a>
140+
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setAutoNext</b> (bool flag)</td></tr>
141+
<tr class="separator:a6ab8295fdd7c303ed2495e628d521c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
139142
<tr class="memitem:a95d0bdc3b24e374ecc10df9af1af7333" id="r_a95d0bdc3b24e374ecc10df9af1af7333"><td class="memItemLeft" align="right" valign="top"><a id="a95d0bdc3b24e374ecc10df9af1af7333" name="a95d0bdc3b24e374ecc10df9af1af7333"></a>
140143
virtual <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>setIndex</b> (int <a class="el" href="classaudio__tools_1_1_audio_source.html#a05d9a9704b4cdd7447cd163af9e07788">index</a>)</td></tr>
141144
<tr class="memdesc:a95d0bdc3b24e374ecc10df9af1af7333"><td class="mdescLeft">&#160;</td><td class="mdescRight">same as selectStream - I just prefer this name <br /></td></tr>
@@ -158,6 +161,9 @@
158161
</table><table class="memberdecls">
159162
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
160163
Protected Attributes</h2></td></tr>
164+
<tr class="memitem:ac88ac2eaea8d71127bcad6887f95f3d4" id="r_ac88ac2eaea8d71127bcad6887f95f3d4"><td class="memItemLeft" align="right" valign="top"><a id="ac88ac2eaea8d71127bcad6887f95f3d4" name="ac88ac2eaea8d71127bcad6887f95f3d4"></a>
165+
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_auto_next</b> = true</td></tr>
166+
<tr class="separator:ac88ac2eaea8d71127bcad6887f95f3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
161167
<tr class="memitem:ac7062b1e31e4db9ec0ba01f27e7ebc67" id="r_ac7062b1e31e4db9ec0ba01f27e7ebc67"><td class="memItemLeft" align="right" valign="top"><a id="ac7062b1e31e4db9ec0ba01f27e7ebc67" name="ac7062b1e31e4db9ec0ba01f27e7ebc67"></a>
162168
int&#160;</td><td class="memItemRight" valign="bottom"><b>timeout_auto_next_value</b> = 500</td></tr>
163169
<tr class="separator:ac7062b1e31e4db9ec0ba01f27e7ebc67"><td class="memSeparator" colspan="2">&#160;</td></tr>

0 commit comments

Comments
 (0)