Skip to content

Commit

Permalink
doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Dec 11, 2024
1 parent 9ec847c commit 5b50fe0
Show file tree
Hide file tree
Showing 71 changed files with 566 additions and 378 deletions.
31 changes: 18 additions & 13 deletions docs/html/_bluetooth_a2_d_p_common_8h_source.html
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/html/_bluetooth_a2_d_p_sink_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_sink.html#af65219e635fadbbc90f4663b33abd3e0">set_on_data_received</a>(<span class="keywordtype">void</span> (*callBack)());</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; </div>
<div class="line"><a name="l00265"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_sink.html#ad25155f02bad11da6c130aae00c8ab9c"> 265</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_sink.html#ad25155f02bad11da6c130aae00c8ab9c">set_address_validator</a>(</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160; <span class="keywordtype">bool</span> (*callBack)(esp_bd_addr_t remote_bda)) {</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160; <span class="keywordtype">bool</span> (*callBack)(<a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> remote_bda)) {</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160; address_validator = callBack;</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160; }</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; </div>
Expand Down Expand Up @@ -328,7 +328,7 @@
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; try_reconnect_max_count = count;</div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; }</div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; </div>
<div class="line"><a name="l00345"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_sink.html#ac08fff859e0ccfbb12cbb6b119dba438"> 345</a></span>&#160; <span class="keyword">virtual</span> esp_bd_addr_t *<a class="code" href="class_bluetooth_a2_d_p_sink.html#ac08fff859e0ccfbb12cbb6b119dba438">get_current_peer_address</a>() { <span class="keywordflow">return</span> &amp;peer_bd_addr; }</div>
<div class="line"><a name="l00345"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_sink.html#ac08fff859e0ccfbb12cbb6b119dba438"> 345</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> *<a class="code" href="class_bluetooth_a2_d_p_sink.html#ac08fff859e0ccfbb12cbb6b119dba438">get_current_peer_address</a>() { <span class="keywordflow">return</span> &amp;peer_bd_addr; }</div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160; </div>
<div class="line"><a name="l00348"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_sink.html#a452b509a46930ab1ed58188a4181c67b"> 348</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_sink.html#a452b509a46930ab1ed58188a4181c67b">set_rssi_active</a>(<span class="keywordtype">bool</span> active) { rssi_active = active; }</div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; </div>
Expand Down Expand Up @@ -411,7 +411,7 @@
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; uint32_t notif_interval_s = 10;</div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; void (*avrc_rn_volchg_complete_callback)(int) = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; bool (*address_validator)(esp_bd_addr_t remote_bda) = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; bool (*address_validator)(<a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> remote_bda) = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; void (*sample_rate_callback)(uint16_t rate) = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; <span class="keywordtype">bool</span> swap_left_right = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160; <span class="keywordtype">int</span> try_reconnect_max_count = AUTOCONNECT_TRY_NUM;</div>
Expand Down Expand Up @@ -507,7 +507,7 @@
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> bt_i2s_task_start_up(<span class="keywordtype">void</span>) {}</div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> bt_i2s_task_shut_down(<span class="keywordtype">void</span>) {}</div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160; </div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; <span class="keyword">virtual</span> esp_err_t esp_a2d_connect(esp_bd_addr_t peer) {</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; <span class="keyword">virtual</span> esp_err_t esp_a2d_connect(<a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> peer) {</div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160; <span class="keywordflow">return</span> esp_a2d_sink_connect(peer);</div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>&#160; }</div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160; </div>
Expand Down Expand Up @@ -603,6 +603,7 @@
<div class="ttc" id="aclass_bluetooth_a2_d_p_sink_html_afdc2f08c0547393704fd6fb56bde204f"><div class="ttname"><a href="class_bluetooth_a2_d_p_sink.html#afdc2f08c0547393704fd6fb56bde204f">BluetoothA2DPSink::i2s_task_handler</a></div><div class="ttdeci">virtual void i2s_task_handler(void *arg)</div><div class="ttdoc">dummy functions needed for BluetoothA2DPSinkQueued</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSink.h:540</div></div>
<div class="ttc" id="agroup__a2dp_html_ga0af05e9d744ec14ee33e345d678e8ade"><div class="ttname"><a href="group__a2dp.html#ga0af05e9d744ec14ee33e345d678e8ade">esp_avrc_rn_event_ids_t</a></div><div class="ttdeci">esp_avrc_rn_event_ids_t</div><div class="ttdoc">AVRC event notification ids.</div><div class="ttdef"><b>Definition:</b> external_lists.h:50</div></div>
<div class="ttc" id="agroup__a2dp_html_ga89fdf5fb26b1ea6f33d36cc0eebca4fb"><div class="ttname"><a href="group__a2dp.html#ga89fdf5fb26b1ea6f33d36cc0eebca4fb">esp_avrc_playback_stat_t</a></div><div class="ttdeci">esp_avrc_playback_stat_t</div><div class="ttdoc">AVRCP current status of playback.</div><div class="ttdef"><b>Definition:</b> external_lists.h:72</div></div>
<div class="ttc" id="agroup__a2dp_html_gae1f72542f04666cd97c26732366bf109"><div class="ttname"><a href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a></div><div class="ttdeci">uint8_t esp_bd_addr_t[ESP_BD_ADDR_LEN]</div><div class="ttdoc">Bluetooth address.</div><div class="ttdef"><b>Definition:</b> external_lists.h:107</div></div>
<div class="ttc" id="astructbt__app__msg__t_html"><div class="ttname"><a href="structbt__app__msg__t.html">bt_app_msg_t</a></div><div class="ttdoc">Internal message to be sent for BluetoothA2DPSink and BluetoothA2DPSource.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPCommon.h:107</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
9 changes: 5 additions & 4 deletions docs/html/_bluetooth_a2_d_p_source_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; this-&gt;reconnect_status = active ? AutoReconnect:NoReconnect;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_source.html#ab94a0596fd595994f3ae4d2d6d2e5a5b"> 111</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_source.html#ab94a0596fd595994f3ae4d2d6d2e5a5b">set_auto_reconnect</a>(esp_bd_addr_t addr){</div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_source.html#ab94a0596fd595994f3ae4d2d6d2e5a5b"> 111</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_source.html#ab94a0596fd595994f3ae4d2d6d2e5a5b">set_auto_reconnect</a>(<a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> addr){</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <a class="code" href="class_bluetooth_a2_d_p_source.html#a65ac6f2b0777c97874ee358119de3790">set_auto_reconnect</a>(<span class="keyword">true</span>);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; memcpy(last_connection,addr,ESP_BD_ADDR_LEN);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</div>
Expand Down Expand Up @@ -203,7 +203,7 @@
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <span class="keyword">virtual</span> int32_t <a class="code" href="class_bluetooth_a2_d_p_source.html#ab199a1240a5850a43738f3872805c9ba">get_data_default</a>(uint8_t *data, int32_t len);</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; </div>
<div class="line"><a name="l00187"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_source.html#a6ba5496831ff64bdd515fc2ad811d76d"> 187</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_source.html#a6ba5496831ff64bdd515fc2ad811d76d">set_ssid_callback</a>(<span class="keywordtype">bool</span>(*callback)(<span class="keyword">const</span> <span class="keywordtype">char</span>*ssid, esp_bd_addr_t address, <span class="keywordtype">int</span> rrsi)){</div>
<div class="line"><a name="l00187"></a><span class="lineno"><a class="line" href="class_bluetooth_a2_d_p_source.html#a6ba5496831ff64bdd515fc2ad811d76d"> 187</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_source.html#a6ba5496831ff64bdd515fc2ad811d76d">set_ssid_callback</a>(<span class="keywordtype">bool</span>(*callback)(<span class="keyword">const</span> <span class="keywordtype">char</span>*ssid, <a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> address, <span class="keywordtype">int</span> rrsi)){</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; ssid_callback = callback;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; }</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; </div>
Expand Down Expand Up @@ -253,7 +253,7 @@
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="keywordtype">bool</span> discovery_active = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; uint16_t valid_cod_services = ESP_BT_COD_SRVC_RENDERING | ESP_BT_COD_SRVC_AUDIO | ESP_BT_COD_SRVC_TELEPHONY;</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; </div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; bool(*ssid_callback)(<span class="keyword">const</span> <span class="keywordtype">char</span>*ssid, esp_bd_addr_t address, <span class="keywordtype">int</span> rrsi) = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; bool(*ssid_callback)(<span class="keyword">const</span> <span class="keywordtype">char</span>*ssid, <a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> address, <span class="keywordtype">int</span> rrsi) = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; void(*discovery_mode_callback)(esp_bt_gap_discovery_state_t discoveryMode) = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; </div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;<span class="preprocessor">#if ESP_IDF_VERSION &gt;= ESP_IDF_VERSION_VAL(4, 0, 0)</span></div>
Expand Down Expand Up @@ -296,7 +296,7 @@
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_bluetooth_a2_d_p_source.html#a190c59464f53e2d4c3f121afbb7a3c21">reset_last_connection</a>();</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_bluetooth_a2_d_p_source.html#a51f93bebf73f8bf9b98fa3c5fc4fcb18">is_valid_cod_service</a>(uint32_t cod);</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; </div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; <span class="keyword">virtual</span> esp_err_t esp_a2d_connect(esp_bd_addr_t peer) {</div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; <span class="keyword">virtual</span> esp_err_t esp_a2d_connect(<a class="code" href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a> peer) {</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160; ESP_LOGI(BT_AV_TAG, <span class="stringliteral">&quot;a2dp connecting to: %s&quot;</span>, <a class="code" href="class_bluetooth_a2_d_p_common.html#a2b78346084e12feeea035d006e7cf07a">to_str</a>(peer));</div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; <span class="keywordflow">return</span> esp_a2d_source_connect(peer);</div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160; }</div>
Expand Down Expand Up @@ -352,6 +352,7 @@
<div class="ttc" id="aclass_bluetooth_a2_d_p_source_html_af29d19e53e3585446fc294a3213a06af"><div class="ttname"><a href="class_bluetooth_a2_d_p_source.html#af29d19e53e3585446fc294a3213a06af">BluetoothA2DPSource::is_discovery_active</a></div><div class="ttdeci">virtual bool is_discovery_active()</div><div class="ttdoc">Provides the current discovery state: returns true when the discovery is in progress.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSource.h:197</div></div>
<div class="ttc" id="aclass_sound_data_html"><div class="ttname"><a href="class_sound_data.html">SoundData</a></div><div class="ttdoc">Sound data as byte stream. We support TwoChannelSoundData (uint16_t + uint16_t) and OneChannelSoundDa...</div><div class="ttdef"><b>Definition:</b> SoundData.h:72</div></div>
<div class="ttc" id="agroup__a2dp_html_gabf9f46a0805b93eedaeccb8e512ef7fa"><div class="ttname"><a href="group__a2dp.html#gabf9f46a0805b93eedaeccb8e512ef7fa">APP_AV_STATE</a></div><div class="ttdeci">APP_AV_STATE</div><div class="ttdoc">Buetooth A2DP global state.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPSource.h:51</div></div>
<div class="ttc" id="agroup__a2dp_html_gae1f72542f04666cd97c26732366bf109"><div class="ttname"><a href="group__a2dp.html#gae1f72542f04666cd97c26732366bf109">esp_bd_addr_t</a></div><div class="ttdeci">uint8_t esp_bd_addr_t[ESP_BD_ADDR_LEN]</div><div class="ttdoc">Bluetooth address.</div><div class="ttdef"><b>Definition:</b> external_lists.h:107</div></div>
<div class="ttc" id="astructbt__app__msg__t_html"><div class="ttname"><a href="structbt__app__msg__t.html">bt_app_msg_t</a></div><div class="ttdoc">Internal message to be sent for BluetoothA2DPSink and BluetoothA2DPSource.</div><div class="ttdef"><b>Definition:</b> BluetoothA2DPCommon.h:107</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit 5b50fe0

Please sign in to comment.