doxygen

Author: pschatzmann

docs/html/_audio_board_8h_source.html

@@ -175,39 +175,39 @@
 <div class="ttc" id="aclassaudio__driver_1_1_audio_board_html_ade3d888867e36d74b3cdc1cd3fe74c38"><div class="ttname"><a href="classaudio__driver_1_1_audio_board.html#ade3d888867e36d74b3cdc1cd3fe74c38">audio_driver::AudioBoard::setMute</a></div><div class="ttdeci">bool setMute(bool enable, int line)</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:55</div></div>
 <div class="ttc" id="aclassaudio__driver_1_1_audio_board_html_ae49803533e5ff17d6b9be477815f5c72"><div class="ttname"><a href="classaudio__driver_1_1_audio_board.html#ae49803533e5ff17d6b9be477815f5c72">audio_driver::AudioBoard::begin</a></div><div class="ttdeci">bool begin(CodecConfig cfg)</div><div class="ttdoc">Starts the processing.</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:39</div></div>
 <div class="ttc" id="aclassaudio__driver_1_1_audio_board_html_aec6b6a6470235a8500063be9a64dc380"><div class="ttname"><a href="classaudio__driver_1_1_audio_board.html#aec6b6a6470235a8500063be9a64dc380">audio_driver::AudioBoard::getPins</a></div><div class="ttdeci">DriverPins &amp; getPins()</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:61</div></div>
-<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html">audio_driver::AudioDriver</a></div><div class="ttdoc">Abstract Driver API for codec chips.</div><div class="ttdef"><b>Definition:</b> Driver.h:184</div></div>
+<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html">audio_driver::AudioDriver</a></div><div class="ttdoc">Abstract Driver API for codec chips.</div><div class="ttdef"><b>Definition:</b> Driver.h:186</div></div>
 <div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a0065b12757039a60467b6b12ccefc4ba"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a0065b12757039a60467b6b12ccefc4ba">audio_driver::AudioDriver::setMute</a></div><div class="ttdeci">virtual bool setMute(bool enable)=0</div></div>
-<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a063cb6038676fcc58f5a7cbc93ef27f1"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a063cb6038676fcc58f5a7cbc93ef27f1">audio_driver::AudioDriver::end</a></div><div class="ttdeci">virtual bool end(void)</div><div class="ttdef"><b>Definition:</b> Driver.h:222</div></div>
-<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a11bf855250acaa1afbe0b8251660800d"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a11bf855250acaa1afbe0b8251660800d">audio_driver::AudioDriver::setInputVolume</a></div><div class="ttdeci">virtual bool setInputVolume(int volume)</div><div class="ttdef"><b>Definition:</b> Driver.h:233</div></div>
-<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a1b3ee72f65915dcb4c875835d6e08aa1"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">audio_driver::AudioDriver::setPAPower</a></div><div class="ttdeci">bool setPAPower(bool enable)</div><div class="ttdoc">Sets the PA Power pin to active or inactive.</div><div class="ttdef"><b>Definition:</b> Driver.h:240</div></div>
-<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a2082348800b00b641ee937bc99c58e2a"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a2082348800b00b641ee937bc99c58e2a">audio_driver::AudioDriver::begin</a></div><div class="ttdeci">virtual bool begin(CodecConfig codecCfg, DriverPins &amp;pins)</div><div class="ttdef"><b>Definition:</b> Driver.h:186</div></div>
+<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a063cb6038676fcc58f5a7cbc93ef27f1"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a063cb6038676fcc58f5a7cbc93ef27f1">audio_driver::AudioDriver::end</a></div><div class="ttdeci">virtual bool end(void)</div><div class="ttdef"><b>Definition:</b> Driver.h:224</div></div>
+<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a11bf855250acaa1afbe0b8251660800d"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a11bf855250acaa1afbe0b8251660800d">audio_driver::AudioDriver::setInputVolume</a></div><div class="ttdeci">virtual bool setInputVolume(int volume)</div><div class="ttdef"><b>Definition:</b> Driver.h:235</div></div>
+<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a1b3ee72f65915dcb4c875835d6e08aa1"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">audio_driver::AudioDriver::setPAPower</a></div><div class="ttdeci">bool setPAPower(bool enable)</div><div class="ttdoc">Sets the PA Power pin to active or inactive.</div><div class="ttdef"><b>Definition:</b> Driver.h:242</div></div>
+<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a2082348800b00b641ee937bc99c58e2a"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a2082348800b00b641ee937bc99c58e2a">audio_driver::AudioDriver::begin</a></div><div class="ttdeci">virtual bool begin(CodecConfig codecCfg, DriverPins &amp;pins)</div><div class="ttdef"><b>Definition:</b> Driver.h:188</div></div>
 <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>
-<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a6442182dfc4c54fb16b002b6f15c86e4"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a6442182dfc4c54fb16b002b6f15c86e4">audio_driver::AudioDriver::setConfig</a></div><div class="ttdeci">virtual bool setConfig(CodecConfig codecCfg)</div><div class="ttdef"><b>Definition:</b> Driver.h:198</div></div>
+<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_a6442182dfc4c54fb16b002b6f15c86e4"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#a6442182dfc4c54fb16b002b6f15c86e4">audio_driver::AudioDriver::setConfig</a></div><div class="ttdeci">virtual bool setConfig(CodecConfig codecCfg)</div><div class="ttdef"><b>Definition:</b> Driver.h:200</div></div>
 <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>
 <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:35</div></div>
-<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html_ac585b3449d271276f8b679e8ab01b2ec"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html#ac585b3449d271276f8b679e8ab01b2ec">audio_driver::CodecConfig::sd_active</a></div><div class="ttdeci">bool sd_active</div><div class="ttdef"><b>Definition:</b> Driver.h:175</div></div>
+<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html_ac585b3449d271276f8b679e8ab01b2ec"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html#ac585b3449d271276f8b679e8ab01b2ec">audio_driver::CodecConfig::sd_active</a></div><div class="ttdeci">bool sd_active</div><div class="ttdef"><b>Definition:</b> Driver.h:177</div></div>
 <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:236</div></div>
 <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:345</div></div>
 <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:374</div></div>
 <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:388</div></div>
 <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:696</div></div>
 <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:85</div></div>
-<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:1192</div></div>
+<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:1194</div></div>
 <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:81</div></div>
-<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:1194</div></div>
+<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:1196</div></div>
 <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:95</div></div>
 <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:694</div></div>
 <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:702</div></div>
 <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:93</div></div>
 <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:692</div></div>
-<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:1170</div></div>
+<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:1172</div></div>
 <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:79</div></div>
-<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:1172</div></div>
+<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:1174</div></div>
 <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:87</div></div>
-<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:1188</div></div>
+<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:1190</div></div>
 <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:698</div></div>
 <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:89</div></div>
-<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:1186</div></div>
+<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:1188</div></div>
 <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:690</div></div>
 <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:83</div></div>
 <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:700</div></div>