Skip to content

Commit 8afcba3

Browse files
committed
doxygen
1 parent 2ce1ccd commit 8afcba3

13 files changed

+201
-179
lines changed

docs/html/_a2_d_p_volume_control_8h_source.html

Lines changed: 112 additions & 119 deletions
Large diffs are not rendered by default.

docs/html/_bluetooth_a2_d_p_common_8h_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -377,8 +377,8 @@
377377
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160; </div>
378378
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="keyword">extern</span> <a class="code" href="class_bluetooth_a2_d_p_common.html">BluetoothA2DPCommon</a>* actual_bluetooth_a2dp_common;</div>
379379
<div class="ttc" id="a_bluetooth_a2_d_p_common_8h_html_a9bee258e477be3c0e70d6029ed86a019"><div class="ttname"><a href="_bluetooth_a2_d_p_common_8h.html#a9bee258e477be3c0e70d6029ed86a019">app_callback_t</a></div><div class="ttdeci">void(* app_callback_t)(uint16_t event, void *param)</div><div class="ttdoc">handler for the dispatched work</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPCommon.h:104</div></div>
380-
<div class="ttc" id="aclass_a2_d_p_default_volume_control_html"><div class="ttname"><a href="class_a2_d_p_default_volume_control.html">A2DPDefaultVolumeControl</a></div><div class="ttdoc">Default implementation for handling of the volume of the audio data.</div><div class="ttdef"><b>Definition:</b> A2DPVolumeControl.h:110</div></div>
381-
<div class="ttc" id="aclass_a2_d_p_volume_control_html"><div class="ttname"><a href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></div><div class="ttdoc">Abstract class for handling of the volume of the audio data.</div><div class="ttdef"><b>Definition:</b> A2DPVolumeControl.h:46</div></div>
380+
<div class="ttc" id="aclass_a2_d_p_default_volume_control_html"><div class="ttname"><a href="class_a2_d_p_default_volume_control.html">A2DPDefaultVolumeControl</a></div><div class="ttdoc">Default implementation for handling of the volume of the audio data.</div><div class="ttdef"><b>Definition:</b> A2DPVolumeControl.h:105</div></div>
381+
<div class="ttc" id="aclass_a2_d_p_volume_control_html"><div class="ttname"><a href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></div><div class="ttdoc">Abstract class for handling of the volume of the audio data.</div><div class="ttdef"><b>Definition:</b> A2DPVolumeControl.h:45</div></div>
382382
<div class="ttc" id="aclass_bluetooth_a2_d_p_common_html"><div class="ttname"><a href="class_bluetooth_a2_d_p_common.html">BluetoothA2DPCommon</a></div><div class="ttdoc">Common Bluetooth A2DP functions.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPCommon.h:144</div></div>
383383
<div class="ttc" id="aclass_bluetooth_a2_d_p_common_html_a04bc52a4279a503203084492fe20c32e"><div class="ttname"><a href="class_bluetooth_a2_d_p_common.html#a04bc52a4279a503203084492fe20c32e">BluetoothA2DPCommon::set_event_stack_size</a></div><div class="ttdeci">void set_event_stack_size(int size)</div><div class="ttdoc">Defines the stack size of the event task (in bytes)</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPCommon.h:253</div></div>
384384
<div class="ttc" id="aclass_bluetooth_a2_d_p_common_html_a0bab92d9317837ecaeacbfe26814e28c"><div class="ttname"><a href="class_bluetooth_a2_d_p_common.html#a0bab92d9317837ecaeacbfe26814e28c">BluetoothA2DPCommon::set_volume</a></div><div class="ttdeci">virtual void set_volume(uint8_t volume)</div><div class="ttdoc">Sets the volume (range 0 - 127)</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPCommon.h:181</div></div>

docs/html/class_a2_d_p_default_volume_control-members.html

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,18 @@
6969
<p>This is the complete list of members for <a class="el" href="class_a2_d_p_default_volume_control.html">A2DPDefaultVolumeControl</a>, including all inherited members.</p>
7070
<table class="directory">
7171
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>A2DPVolumeControl</b>() (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
72-
<tr bgcolor="#f0f0f0"><td class="entry"><b>get_volume_factor</b>() (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
73-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>get_volume_factor_max</b>() (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
74-
<tr bgcolor="#f0f0f0"><td class="entry"><b>is_volume_used</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
75-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>mono_downmix</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
76-
<tr bgcolor="#f0f0f0"><td class="entry"><b>set_enabled</b>(bool enabled) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
77-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>set_mono_downmix</b>(bool enabled) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
78-
<tr bgcolor="#f0f0f0"><td class="entry"><b>set_volume</b>(uint8_t volume) override (defined in <a class="el" href="class_a2_d_p_default_volume_control.html">A2DPDefaultVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_default_volume_control.html">A2DPDefaultVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
79-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>update_audio_data</b>(uint8_t *data, uint16_t byteCount) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
80-
<tr bgcolor="#f0f0f0"><td class="entry"><b>update_audio_data</b>(Frame *data, uint16_t frameCount) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
81-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>volumeFactor</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
82-
<tr bgcolor="#f0f0f0"><td class="entry"><b>volumeFactorMax</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
72+
<tr bgcolor="#f0f0f0"><td class="entry"><b>clip</b>(int32_t value) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
73+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>get_volume_factor</b>() (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
74+
<tr bgcolor="#f0f0f0"><td class="entry"><b>get_volume_factor_max</b>() (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
75+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>is_volume_used</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
76+
<tr bgcolor="#f0f0f0"><td class="entry"><b>mono_downmix</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
77+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>set_enabled</b>(bool enabled) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
78+
<tr bgcolor="#f0f0f0"><td class="entry"><b>set_mono_downmix</b>(bool enabled) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
79+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>set_volume</b>(uint8_t volume) override (defined in <a class="el" href="class_a2_d_p_default_volume_control.html">A2DPDefaultVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_default_volume_control.html">A2DPDefaultVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
80+
<tr bgcolor="#f0f0f0"><td class="entry"><b>update_audio_data</b>(uint8_t *data, uint16_t byteCount) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
81+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>update_audio_data</b>(Frame *data, uint16_t frameCount) (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
82+
<tr bgcolor="#f0f0f0"><td class="entry"><b>volumeFactor</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
83+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>volumeFactorMax</b> (defined in <a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a>)</td><td class="entry"><a class="el" href="class_a2_d_p_volume_control.html">A2DPVolumeControl</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
8384
</table></div><!-- contents -->
8485
<!-- start footer part -->
8586
<hr class="footer"/><address class="footer"><small>

docs/html/class_a2_d_p_default_volume_control.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,9 @@
108108
</table><table class="memberdecls">
109109
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
110110
Protected Member Functions</h2></td></tr>
111+
<tr class="memitem:a23700514ed3bb33151ea90033e8dcbea"><td class="memItemLeft" align="right" valign="top"><a id="a23700514ed3bb33151ea90033e8dcbea"></a>
112+
int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>clip</b> (int32_t value)</td></tr>
113+
<tr class="separator:a23700514ed3bb33151ea90033e8dcbea"><td class="memSeparator" colspan="2">&#160;</td></tr>
111114
<tr class="memitem:ad4d0b24a939feda229bde29eb0c985e1"><td class="memItemLeft" align="right" valign="top"><a id="ad4d0b24a939feda229bde29eb0c985e1"></a>
112115
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_volume</b> (uint8_t volume) override</td></tr>
113116
<tr class="separator:ad4d0b24a939feda229bde29eb0c985e1"><td class="memSeparator" colspan="2">&#160;</td></tr>

0 commit comments

Comments
 (0)