Skip to content

Commit 289f507

Browse files
committed
doxygen
1 parent 3aa7f87 commit 289f507

File tree

122 files changed

+1346
-1299
lines changed

Some content is hidden

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

122 files changed

+1346
-1299
lines changed

docs/html/_audio_board_8h_source.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -156,25 +156,25 @@
156156
<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a43d1eddbaad3e8e0f25004acb9c29efc"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a43d1eddbaad3e8e0f25004acb9c29efc">audio_driver::AudioDriver::setVolume</a></div><div class="ttdeci">virtual bool setVolume(int volume)=0</div><div class="ttdoc">Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100.</div></div>
157157
<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_aaf041a73009a07b13117c75c1d09f00c"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#aaf041a73009a07b13117c75c1d09f00c">audio_driver::AudioDriver::getVolume</a></div><div class="ttdeci">virtual int getVolume()=0</div></div>
158158
<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html">audio_driver::CodecConfig</a></div><div class="ttdoc">I2S configuration and defition of input and output with default values.</div><div class="ttdef"><b>Definition:</b> Driver.h:19</div></div>
159-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html">audio_driver::DriverPins</a></div><div class="ttdoc">All pins for i2s, spi, i2c and other pins.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:190</div></div>
160-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a50f45551c10ca30a0bc7f447e70188b1"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a50f45551c10ca30a0bc7f447e70188b1">audio_driver::DriverPins::begin</a></div><div class="ttdeci">virtual bool begin()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:278</div></div>
161-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#aaf81d3fdaf258088d7692fa70cece087">audio_driver::DriverPins::end</a></div><div class="ttdeci">void end()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:318</div></div>
162-
<div class="ttc" id="agroup__audio__driver_html_ga0f4a0dbd3aeea6d499d87a62293e012e"><div class="ttname"><a href="group__audio__driver.html#ga0f4a0dbd3aeea6d499d87a62293e012e">audio_driver::PinsLyratMini</a></div><div class="ttdeci">static PinsLyratMiniClass PinsLyratMini</div><div class="ttdef"><b>Definition:</b> DriverPins.h:552</div></div>
159+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html">audio_driver::DriverPins</a></div><div class="ttdoc">All pins for i2s, spi, i2c and other pins.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:200</div></div>
160+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a50f45551c10ca30a0bc7f447e70188b1"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a50f45551c10ca30a0bc7f447e70188b1">audio_driver::DriverPins::begin</a></div><div class="ttdeci">virtual bool begin()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:288</div></div>
161+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#aaf81d3fdaf258088d7692fa70cece087">audio_driver::DriverPins::end</a></div><div class="ttdeci">void end()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:323</div></div>
162+
<div class="ttc" id="agroup__audio__driver_html_ga0f4a0dbd3aeea6d499d87a62293e012e"><div class="ttname"><a href="group__audio__driver.html#ga0f4a0dbd3aeea6d499d87a62293e012e">audio_driver::PinsLyratMini</a></div><div class="ttdeci">static PinsLyratMiniClass PinsLyratMini</div><div class="ttdef"><b>Definition:</b> DriverPins.h:557</div></div>
163163
<div class="ttc" id="agroup__audio__driver_html_ga0ffdf5c889c7a240e72df4ce7e323478"><div class="ttname"><a href="group__audio__driver.html#ga0ffdf5c889c7a240e72df4ce7e323478">audio_driver::LyratV43</a></div><div class="ttdeci">static AudioBoard LyratV43</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:65</div></div>
164164
<div class="ttc" id="agroup__audio__driver_html_ga3c281a9dabe9c42b609f386a515d7082"><div class="ttname"><a href="group__audio__driver.html#ga3c281a9dabe9c42b609f386a515d7082">audio_driver::AudioDriverLyratMini</a></div><div class="ttdeci">static AudioDriverLyratMiniClass AudioDriverLyratMini</div><div class="ttdef"><b>Definition:</b> Driver.h:421</div></div>
165165
<div class="ttc" id="agroup__audio__driver_html_ga3ecb4bf2db338ccd232cad96a2e2341e"><div class="ttname"><a href="group__audio__driver.html#ga3ecb4bf2db338ccd232cad96a2e2341e">audio_driver::AudioKitEs8388V2</a></div><div class="ttdeci">static AudioBoard AudioKitEs8388V2</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:61</div></div>
166-
<div class="ttc" id="agroup__audio__driver_html_ga4c69c022bab026eb5d85877b0800771d"><div class="ttname"><a href="group__audio__driver.html#ga4c69c022bab026eb5d85877b0800771d">audio_driver::PinsLyrat42</a></div><div class="ttdeci">static PinsLyrat42Class PinsLyrat42</div><div class="ttdef"><b>Definition:</b> DriverPins.h:550</div></div>
167-
<div class="ttc" id="agroup__audio__driver_html_ga4de967e315821b064d50a78d01877d67"><div class="ttname"><a href="group__audio__driver.html#ga4de967e315821b064d50a78d01877d67">audio_driver::PinsAudioKitAC101</a></div><div class="ttdeci">static PinsAudioKitAC101Class PinsAudioKitAC101</div><div class="ttdef"><b>Definition:</b> DriverPins.h:558</div></div>
168-
<div class="ttc" id="agroup__audio__driver_html_ga61f7164942e4687d3136447ecc1fb78e"><div class="ttname"><a href="group__audio__driver.html#ga61f7164942e4687d3136447ecc1fb78e">audio_driver::PinsLyrat43</a></div><div class="ttdeci">static PinsLyrat43Class PinsLyrat43</div><div class="ttdef"><b>Definition:</b> DriverPins.h:548</div></div>
166+
<div class="ttc" id="agroup__audio__driver_html_ga4c69c022bab026eb5d85877b0800771d"><div class="ttname"><a href="group__audio__driver.html#ga4c69c022bab026eb5d85877b0800771d">audio_driver::PinsLyrat42</a></div><div class="ttdeci">static PinsLyrat42Class PinsLyrat42</div><div class="ttdef"><b>Definition:</b> DriverPins.h:555</div></div>
167+
<div class="ttc" id="agroup__audio__driver_html_ga4de967e315821b064d50a78d01877d67"><div class="ttname"><a href="group__audio__driver.html#ga4de967e315821b064d50a78d01877d67">audio_driver::PinsAudioKitAC101</a></div><div class="ttdeci">static PinsAudioKitAC101Class PinsAudioKitAC101</div><div class="ttdef"><b>Definition:</b> DriverPins.h:563</div></div>
168+
<div class="ttc" id="agroup__audio__driver_html_ga61f7164942e4687d3136447ecc1fb78e"><div class="ttname"><a href="group__audio__driver.html#ga61f7164942e4687d3136447ecc1fb78e">audio_driver::PinsLyrat43</a></div><div class="ttdeci">static PinsLyrat43Class PinsLyrat43</div><div class="ttdef"><b>Definition:</b> DriverPins.h:553</div></div>
169169
<div class="ttc" id="agroup__audio__driver_html_ga6e512f44cc6db0994d6b1617abcc93b0"><div class="ttname"><a href="group__audio__driver.html#ga6e512f44cc6db0994d6b1617abcc93b0">audio_driver::AudioDriverAC101</a></div><div class="ttdeci">static AudioDriverAC101Class AudioDriverAC101</div><div class="ttdef"><b>Definition:</b> Driver.h:413</div></div>
170170
<div class="ttc" id="agroup__audio__driver_html_ga9282e4e123ca2db202b817e95b4c4d6b"><div class="ttname"><a href="group__audio__driver.html#ga9282e4e123ca2db202b817e95b4c4d6b">audio_driver::AudioKitEs8388V1</a></div><div class="ttdeci">static AudioBoard AudioKitEs8388V1</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:59</div></div>
171171
<div class="ttc" id="agroup__audio__driver_html_ga98fa8fe4385c4198150679fddade5eef"><div class="ttname"><a href="group__audio__driver.html#ga98fa8fe4385c4198150679fddade5eef">audio_driver::LyratV42</a></div><div class="ttdeci">static AudioBoard LyratV42</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:67</div></div>
172-
<div class="ttc" id="agroup__audio__driver_html_gaac2b21f064b1a332b2ae9b35fa46484e"><div class="ttname"><a href="group__audio__driver.html#gaac2b21f064b1a332b2ae9b35fa46484e">audio_driver::PinsAudioKitEs8388v1</a></div><div class="ttdeci">static PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1</div><div class="ttdef"><b>Definition:</b> DriverPins.h:554</div></div>
172+
<div class="ttc" id="agroup__audio__driver_html_gaac2b21f064b1a332b2ae9b35fa46484e"><div class="ttname"><a href="group__audio__driver.html#gaac2b21f064b1a332b2ae9b35fa46484e">audio_driver::PinsAudioKitEs8388v1</a></div><div class="ttdeci">static PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1</div><div class="ttdef"><b>Definition:</b> DriverPins.h:559</div></div>
173173
<div class="ttc" id="agroup__audio__driver_html_gad1d9b3159991732b6af524c6c8e592f2"><div class="ttname"><a href="group__audio__driver.html#gad1d9b3159991732b6af524c6c8e592f2">audio_driver::LyratMini</a></div><div class="ttdeci">static AudioBoard LyratMini</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:69</div></div>
174174
<div class="ttc" id="agroup__audio__driver_html_gad404af509b8a5ae73c689d6faa3d54df"><div class="ttname"><a href="group__audio__driver.html#gad404af509b8a5ae73c689d6faa3d54df">audio_driver::AudioDriverES8388</a></div><div class="ttdeci">static AudioDriverES8388Class AudioDriverES8388</div><div class="ttdef"><b>Definition:</b> Driver.h:411</div></div>
175-
<div class="ttc" id="agroup__audio__driver_html_gae6031df2ec66c645dd42ae315b79e156"><div class="ttname"><a href="group__audio__driver.html#gae6031df2ec66c645dd42ae315b79e156">audio_driver::NoPins</a></div><div class="ttdeci">static DriverPins NoPins</div><div class="ttdoc">Pins need to be set up in the sketch.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:546</div></div>
175+
<div class="ttc" id="agroup__audio__driver_html_gae6031df2ec66c645dd42ae315b79e156"><div class="ttname"><a href="group__audio__driver.html#gae6031df2ec66c645dd42ae315b79e156">audio_driver::NoPins</a></div><div class="ttdeci">static DriverPins NoPins</div><div class="ttdoc">Pins need to be set up in the sketch.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:551</div></div>
176176
<div class="ttc" id="agroup__audio__driver_html_gaebae1c0395623b4715a91f2f8c64ad6c"><div class="ttname"><a href="group__audio__driver.html#gaebae1c0395623b4715a91f2f8c64ad6c">audio_driver::AudioKitAC101</a></div><div class="ttdeci">static AudioBoard AudioKitAC101</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:63</div></div>
177-
<div class="ttc" id="agroup__audio__driver_html_gaec73d289b40131bb320b17356793430e"><div class="ttname"><a href="group__audio__driver.html#gaec73d289b40131bb320b17356793430e">audio_driver::PinsAudioKitEs8388v2</a></div><div class="ttdeci">static PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2</div><div class="ttdef"><b>Definition:</b> DriverPins.h:556</div></div>
177+
<div class="ttc" id="agroup__audio__driver_html_gaec73d289b40131bb320b17356793430e"><div class="ttname"><a href="group__audio__driver.html#gaec73d289b40131bb320b17356793430e">audio_driver::PinsAudioKitEs8388v2</a></div><div class="ttdeci">static PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2</div><div class="ttdef"><b>Definition:</b> DriverPins.h:561</div></div>
178178
<div class="ttc" id="anamespaceaudio__driver_html"><div class="ttname"><a href="namespaceaudio__driver.html">audio_driver</a></div><div class="ttdef"><b>Definition:</b> AudioBoard.h:5</div></div>
179179
</div><!-- fragment --></div><!-- contents -->
180180
<!-- start footer part -->

docs/html/_common_8h.html

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,6 @@
115115
</table><table class="memberdecls">
116116
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
117117
Enumerations</h2></td></tr>
118-
<tr class="memitem:ga3098d145f4ed28b89663ca540fd5cecb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__enumerations.html#ga3098d145f4ed28b89663ca540fd5cecb">ActiveLogic</a> { <a class="el" href="group__enumerations.html#ga3098d145f4ed28b89663ca540fd5cecbabb1989a0c0a96d4ac80e89f4f2c100ab">ActiveHigh</a>
119-
, <a class="el" href="group__enumerations.html#ga3098d145f4ed28b89663ca540fd5cecbaad92f9440c1f8bd2336f66cea2ce9da7">ActiveLow</a>
120-
, <a class="el" href="group__enumerations.html#ga3098d145f4ed28b89663ca540fd5cecba1339eefa20df2ffafefbdad13906641b">ActiveTouch</a>
121-
, <a class="el" href="group__enumerations.html#ga3098d145f4ed28b89663ca540fd5cecbad6bc64828ad09595ce57011f5a759871">ActiveUndefined</a>
122-
}</td></tr>
123-
<tr class="memdesc:ga3098d145f4ed28b89663ca540fd5cecb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select media hal codec mode. <a href="group__enumerations.html#ga3098d145f4ed28b89663ca540fd5cecb">More...</a><br /></td></tr>
124-
<tr class="separator:ga3098d145f4ed28b89663ca540fd5cecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
125118
<tr class="memitem:ga17701b70816c7d7342f1a4115f4a8de0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__driver.html#ga17701b70816c7d7342f1a4115f4a8de0">adc_input_t</a> { <br />
126119
&#160;&#160;<a class="el" href="group__audio__driver.html#ga17701b70816c7d7342f1a4115f4a8de0a8fe55a6d1ba4245831483d4f3f3763ec">ADC_INPUT_NONE</a> = 0x00
127120
, <a class="el" href="group__audio__driver.html#ga17701b70816c7d7342f1a4115f4a8de0ac054fb9ae14a618d0425ded7f7f17bed">ADC_INPUT_LINE1</a>

0 commit comments

Comments
 (0)