Skip to content

Commit 76aa336

Browse files
pschatzmannpschatzmann
committed
doxygen
1 parent 488c16b commit 76aa336

File tree

184 files changed

+6021
-3138
lines changed

Some content is hidden

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

184 files changed

+6021
-3138
lines changed

‎docs/html/_audio_board_8h_source.html

Lines changed: 64 additions & 56 deletions
Large diffs are not rendered by default.

‎docs/html/_audio_driver_config_8h.html

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>arduino-audio-driver: src/AudioDriverConfig.h File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">arduino-audio-driver
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
<!-- window showing the filter options -->
49+
<div id="MSearchSelectWindow"
50+
onmouseover="return searchBox.OnSearchSelectShow()"
51+
onmouseout="return searchBox.OnSearchSelectHide()"
52+
onkeydown="return searchBox.OnSearchSelectKey(event)">
53+
</div>
54+
55+
<!-- iframe showing the search results (closed by default) -->
56+
<div id="MSearchResultsWindow">
57+
<iframe src="javascript:void(0)" frameborder="0"
58+
name="MSearchResults" id="MSearchResults">
59+
</iframe>
60+
</div>
61+
62+
<div id="nav-path" class="navpath">
63+
<ul>
64+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="summary">
69+
<a href="#define-members">Macros</a> </div>
70+
<div class="headertitle">
71+
<div class="title">AudioDriverConfig.h File Reference</div> </div>
72+
</div><!--header-->
73+
<div class="contents">
74+
75+
<p><a href="_audio_driver_config_8h_source.html">Go to the source code of this file.</a></p>
76+
<table class="memberdecls">
77+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
78+
Macros</h2></td></tr>
79+
<tr class="memitem:a97f42a9050aeb02705fa0bc7ad10aaef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a97f42a9050aeb02705fa0bc7ad10aaef">AI_THINKER_ES8388_VOLUME_HACK</a>&#160;&#160;&#160;1</td></tr>
80+
<tr class="separator:a97f42a9050aeb02705fa0bc7ad10aaef"><td class="memSeparator" colspan="2">&#160;</td></tr>
81+
<tr class="memitem:a2513e2bd0eb45a0ccefbbcd3f289ca47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a2513e2bd0eb45a0ccefbbcd3f289ca47">DRIVER_DEFAULT_VOLUME</a>&#160;&#160;&#160;70</td></tr>
82+
<tr class="separator:a2513e2bd0eb45a0ccefbbcd3f289ca47"><td class="memSeparator" colspan="2">&#160;</td></tr>
83+
<tr class="memitem:a14378984cebc3425ec1941bb1e0217ef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a14378984cebc3425ec1941bb1e0217ef">ES8388_DEFAULT_INPUT_GAIN</a>&#160;&#160;&#160;25</td></tr>
84+
<tr class="separator:a14378984cebc3425ec1941bb1e0217ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
85+
<tr class="memitem:a9407f00066bbd25c1bd46d20fa83ddb7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a9407f00066bbd25c1bd46d20fa83ddb7">ES8388_PA_LINE</a>&#160;&#160;&#160;1</td></tr>
86+
<tr class="separator:a9407f00066bbd25c1bd46d20fa83ddb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
87+
</table>
88+
<h2 class="groupheader">Macro Definition Documentation</h2>
89+
<a id="a97f42a9050aeb02705fa0bc7ad10aaef"></a>
90+
<h2 class="memtitle"><span class="permalink"><a href="#a97f42a9050aeb02705fa0bc7ad10aaef">&#9670;&nbsp;</a></span>AI_THINKER_ES8388_VOLUME_HACK</h2>
91+
92+
<div class="memitem">
93+
<div class="memproto">
94+
<table class="memname">
95+
<tr>
96+
<td class="memname">#define AI_THINKER_ES8388_VOLUME_HACK&#160;&#160;&#160;1</td>
97+
</tr>
98+
</table>
99+
</div><div class="memdoc">
100+
101+
</div>
102+
</div>
103+
<a id="a2513e2bd0eb45a0ccefbbcd3f289ca47"></a>
104+
<h2 class="memtitle"><span class="permalink"><a href="#a2513e2bd0eb45a0ccefbbcd3f289ca47">&#9670;&nbsp;</a></span>DRIVER_DEFAULT_VOLUME</h2>
105+
106+
<div class="memitem">
107+
<div class="memproto">
108+
<table class="memname">
109+
<tr>
110+
<td class="memname">#define DRIVER_DEFAULT_VOLUME&#160;&#160;&#160;70</td>
111+
</tr>
112+
</table>
113+
</div><div class="memdoc">
114+
115+
</div>
116+
</div>
117+
<a id="a14378984cebc3425ec1941bb1e0217ef"></a>
118+
<h2 class="memtitle"><span class="permalink"><a href="#a14378984cebc3425ec1941bb1e0217ef">&#9670;&nbsp;</a></span>ES8388_DEFAULT_INPUT_GAIN</h2>
119+
120+
<div class="memitem">
121+
<div class="memproto">
122+
<table class="memname">
123+
<tr>
124+
<td class="memname">#define ES8388_DEFAULT_INPUT_GAIN&#160;&#160;&#160;25</td>
125+
</tr>
126+
</table>
127+
</div><div class="memdoc">
128+
129+
</div>
130+
</div>
131+
<a id="a9407f00066bbd25c1bd46d20fa83ddb7"></a>
132+
<h2 class="memtitle"><span class="permalink"><a href="#a9407f00066bbd25c1bd46d20fa83ddb7">&#9670;&nbsp;</a></span>ES8388_PA_LINE</h2>
133+
134+
<div class="memitem">
135+
<div class="memproto">
136+
<table class="memname">
137+
<tr>
138+
<td class="memname">#define ES8388_PA_LINE&#160;&#160;&#160;1</td>
139+
</tr>
140+
</table>
141+
</div><div class="memdoc">
142+
143+
</div>
144+
</div>
145+
</div><!-- contents -->
146+
<!-- start footer part -->
147+
<hr class="footer"/><address class="footer"><small>
148+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
149+
</small></address>
150+
</body>
151+
</html>

‎docs/html/_audio_driver_config_8h_source.html

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>arduino-audio-driver: src/AudioDriverConfig.h Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">arduino-audio-driver
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.9.1 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
<!-- window showing the filter options -->
49+
<div id="MSearchSelectWindow"
50+
onmouseover="return searchBox.OnSearchSelectShow()"
51+
onmouseout="return searchBox.OnSearchSelectHide()"
52+
onkeydown="return searchBox.OnSearchSelectKey(event)">
53+
</div>
54+
55+
<!-- iframe showing the search results (closed by default) -->
56+
<div id="MSearchResultsWindow">
57+
<iframe src="javascript:void(0)" frameborder="0"
58+
name="MSearchResults" id="MSearchResults">
59+
</iframe>
60+
</div>
61+
62+
<div id="nav-path" class="navpath">
63+
<ul>
64+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="headertitle">
69+
<div class="title">AudioDriverConfig.h</div> </div>
70+
</div><!--header-->
71+
<div class="contents">
72+
<a href="_audio_driver_config_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
73+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
74+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Default volume at startup</span></div>
75+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#ifndef DRIVER_DEFAULT_VOLUME</span></div>
76+
<div class="line"><a name="l00005"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a2513e2bd0eb45a0ccefbbcd3f289ca47"> 5</a></span>&#160;<span class="preprocessor"># define DRIVER_DEFAULT_VOLUME 70</span></div>
77+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#endif</span></div>
78+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
79+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
80+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// To increase the max volume e.g. for ai_thinker (ES8388) 2957 or A202 -&gt; set</span></div>
81+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// to 1 or 2 0 AUX volume is LINE level 1 you can control the AUX volume with</span></div>
82+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// setVolume()</span></div>
83+
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#ifndef AI_THINKER_ES8388_VOLUME_HACK</span></div>
84+
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a97f42a9050aeb02705fa0bc7ad10aaef"> 13</a></span>&#160;<span class="preprocessor"># define AI_THINKER_ES8388_VOLUME_HACK 1</span></div>
85+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#endif</span></div>
86+
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
87+
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// Define the default gain for the microphone amp (see values from</span></div>
88+
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// es_mic_gain_t) Alternativly you can call es8388_set_mic_gain(es_mic_gain_t</span></div>
89+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// gain) if you prefer to use value from an comprehensive enum</span></div>
90+
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef ES8388_DEFAULT_INPUT_GAIN</span></div>
91+
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a14378984cebc3425ec1941bb1e0217ef"> 20</a></span>&#160;<span class="preprocessor"># define ES8388_DEFAULT_INPUT_GAIN 25</span></div>
92+
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
93+
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
94+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
95+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// For AI Thinker Audiokit we mute the power amplifier if the line is defined;</span></div>
96+
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// set to -1 to deactivate this functionality</span></div>
97+
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#ifndef ES8388_PA_LINE </span></div>
98+
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a9407f00066bbd25c1bd46d20fa83ddb7"> 27</a></span>&#160;<span class="preprocessor"># define ES8388_PA_LINE 1</span></div>
99+
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
100+
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
101+
</div><!-- fragment --></div><!-- contents -->
102+
<!-- start footer part -->
103+
<hr class="footer"/><address class="footer"><small>
104+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
105+
</small></address>
106+
</body>
107+
</html>

0 commit comments

Comments
 (0)