Skip to content

Commit d4f4f6d

Browse files
pschatzmannpschatzmann
committed
doxygen
1 parent b38eb9a commit d4f4f6d

11 files changed

+616
-484
lines changed

‎docs/html/_audio_board_8h_source.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -177,29 +177,29 @@
177177
<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>
178178
<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 definition of input and output with default values.</div><div class="ttdef"><b>Definition:</b> Driver.h:31</div></div>
179179
<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:234</div></div>
180-
<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:337</div></div>
181-
<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:366</div></div>
182-
<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:688</div></div>
180+
<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="ttdoc">Sets up all pins e.g. by calling pinMode()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:343</div></div>
181+
<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:372</div></div>
182+
<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:694</div></div>
183183
<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:79</div></div>
184184
<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:999</div></div>
185185
<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:75</div></div>
186186
<div class="ttc" id="agroup__audio__driver_html_ga3fee80a3a7d33b4cd0af36720e919be4"><div class="ttname"><a href="group__audio__driver.html#ga3fee80a3a7d33b4cd0af36720e919be4">audio_driver::NoDriver</a></div><div class="ttdeci">static NoDriverClass NoDriver</div><div class="ttdef"><b>Definition:</b> Driver.h:1001</div></div>
187187
<div class="ttc" id="agroup__audio__driver_html_ga469170589e8c1dde2c640c0aadfffd02"><div class="ttname"><a href="group__audio__driver.html#ga469170589e8c1dde2c640c0aadfffd02">audio_driver::GenericCS43l22</a></div><div class="ttdeci">static AudioBoard GenericCS43l22</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:89</div></div>
188-
<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:686</div></div>
189-
<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:694</div></div>
188+
<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:692</div></div>
189+
<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:700</div></div>
190190
<div class="ttc" id="agroup__audio__driver_html_ga5ad99d7c81a4486004d837287a8cf54b"><div class="ttname"><a href="group__audio__driver.html#ga5ad99d7c81a4486004d837287a8cf54b">audio_driver::GenericWM8960</a></div><div class="ttdeci">static AudioBoard GenericWM8960</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:87</div></div>
191-
<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:684</div></div>
191+
<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:690</div></div>
192192
<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:977</div></div>
193193
<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:73</div></div>
194194
<div class="ttc" id="agroup__audio__driver_html_ga9752ab43ee1dc1a25230ddfbd0916c15"><div class="ttname"><a href="group__audio__driver.html#ga9752ab43ee1dc1a25230ddfbd0916c15">audio_driver::AudioDriverCS43l22</a></div><div class="ttdeci">static AudioDriverCS43l22Class AudioDriverCS43l22</div><div class="ttdef"><b>Definition:</b> Driver.h:979</div></div>
195195
<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:81</div></div>
196196
<div class="ttc" id="agroup__audio__driver_html_ga9edaa629f0334ef75e1666c847bcb3c3"><div class="ttname"><a href="group__audio__driver.html#ga9edaa629f0334ef75e1666c847bcb3c3">audio_driver::AudioDriverWM8960</a></div><div class="ttdeci">static AudioDriverWM8960Class AudioDriverWM8960</div><div class="ttdef"><b>Definition:</b> Driver.h:995</div></div>
197-
<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:690</div></div>
197+
<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:696</div></div>
198198
<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:83</div></div>
199199
<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:993</div></div>
200-
<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:682</div></div>
200+
<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:688</div></div>
201201
<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:77</div></div>
202-
<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:692</div></div>
202+
<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:698</div></div>
203203
<div class="ttc" id="agroup__audio__driver_html_gafe3ab59f1104cea44d71beeb7fe5a48f"><div class="ttname"><a href="group__audio__driver.html#gafe3ab59f1104cea44d71beeb7fe5a48f">audio_driver::NoBoard</a></div><div class="ttdeci">static AudioBoard NoBoard</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:85</div></div>
204204
<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>
205205
</div><!-- fragment --></div><!-- contents -->

‎docs/html/_driver_8h_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1162,9 +1162,9 @@
11621162
<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html_ad7fff9aeffbd30c2bf93c8c597b2ede6"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">audio_driver::CodecConfig::setRateNumeric</a></div><div class="ttdeci">int setRateNumeric(int rateNum)</div><div class="ttdoc">sets the sample rate as number</div><div class="ttdef"><b>Definition:</b> Driver.h:94</div></div>
11631163
<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html_afb4dc267068aaa494327923fecec6b41"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html#afb4dc267068aaa494327923fecec6b41">audio_driver::CodecConfig::getBitsNumeric</a></div><div class="ttdeci">int getBitsNumeric()</div><div class="ttdoc">Returns bits per sample as number.</div><div class="ttdef"><b>Definition:</b> Driver.h:46</div></div>
11641164
<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:234</div></div>
1165-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a1bec8cca54681dc1e21f9a5281642dc7"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a1bec8cca54681dc1e21f9a5281642dc7">audio_driver::DriverPins::getPinID</a></div><div class="ttdeci">GpioPin getPinID(PinFunction function, int pos=0)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:304</div></div>
1166-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_ac657931b192113cc4f0dfa5854dd2f84"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#ac657931b192113cc4f0dfa5854dd2f84">audio_driver::DriverPins::setSPIActiveForSD</a></div><div class="ttdeci">void setSPIActiveForSD(bool active)</div><div class="ttdoc">Defines if SPI for SD should be started (by default true)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:380</div></div>
1167-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_af382590cdb877d99a5af985d56dfacdb"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#af382590cdb877d99a5af985d56dfacdb">audio_driver::DriverPins::getI2CPins</a></div><div class="ttdeci">Optional&lt; PinsI2C &gt; getI2CPins(PinFunction function)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:310</div></div>
1165+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a1bec8cca54681dc1e21f9a5281642dc7"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a1bec8cca54681dc1e21f9a5281642dc7">audio_driver::DriverPins::getPinID</a></div><div class="ttdeci">GpioPin getPinID(PinFunction function, int pos=0)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:307</div></div>
1166+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_ac657931b192113cc4f0dfa5854dd2f84"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#ac657931b192113cc4f0dfa5854dd2f84">audio_driver::DriverPins::setSPIActiveForSD</a></div><div class="ttdeci">void setSPIActiveForSD(bool active)</div><div class="ttdoc">Defines if SPI for SD should be started (by default true)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:386</div></div>
1167+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_af382590cdb877d99a5af985d56dfacdb"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#af382590cdb877d99a5af985d56dfacdb">audio_driver::DriverPins::getI2CPins</a></div><div class="ttdeci">Optional&lt; PinsI2C &gt; getI2CPins(PinFunction function)</div><div class="ttdoc">Finds the I2C pin info with the help of the function.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:314</div></div>
11681168
<div class="ttc" id="aclassaudio__driver_1_1_no_driver_class_html"><div class="ttname"><a href="classaudio__driver_1_1_no_driver_class.html">audio_driver::NoDriverClass</a></div><div class="ttdoc">Dummy Driver which does nothing.</div><div class="ttdef"><b>Definition:</b> Driver.h:263</div></div>
11691169
<div class="ttc" id="aclassaudio__driver_1_1_no_driver_class_html_a02060cfd35162a9112de61ebc3d5b974"><div class="ttname"><a href="classaudio__driver_1_1_no_driver_class.html#a02060cfd35162a9112de61ebc3d5b974">audio_driver::NoDriverClass::isInputVolumeSupported</a></div><div class="ttdeci">virtual bool isInputVolumeSupported()</div><div class="ttdef"><b>Definition:</b> Driver.h:276</div></div>
11701170
<div class="ttc" id="aclassaudio__driver_1_1_no_driver_class_html_a063cb6038676fcc58f5a7cbc93ef27f1"><div class="ttname"><a href="classaudio__driver_1_1_no_driver_class.html#a063cb6038676fcc58f5a7cbc93ef27f1">audio_driver::NoDriverClass::end</a></div><div class="ttdeci">virtual bool end(void)</div><div class="ttdef"><b>Definition:</b> Driver.h:270</div></div>

0 commit comments

Comments
 (0)