-
-
Notifications
You must be signed in to change notification settings - Fork 255
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to doxygen from @ ef5696a 🚀
- Loading branch information
1 parent
0b13b44
commit 607f4da
Showing
2,275 changed files
with
306,599 additions
and
8 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> | ||
| <meta name="generator" content="Doxygen 1.9.1"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>arduino-audio-tools: src/AudioLibs/A2DPStream.h File Reference</title> | ||
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="dynsections.js"></script> | ||
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| </head> | ||
| <body> | ||
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | ||
| <div id="titlearea"> | ||
| <table cellspacing="0" cellpadding="0"> | ||
| <tbody> | ||
| <tr style="height: 56px;"> | ||
| <td id="projectalign" style="padding-left: 0.5em;"> | ||
| <div id="projectname">arduino-audio-tools | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.1 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| <script type="text/javascript" src="menudata.js"></script> | ||
| <script type="text/javascript" src="menu.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| $(function() { | ||
| initMenu('',true,false,'search.php','Search'); | ||
| $(document).ready(function() { init_search(); }); | ||
| }); | ||
| /* @license-end */</script> | ||
| <div id="main-nav"></div> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <iframe src="javascript:void(0)" frameborder="0" | ||
| name="MSearchResults" id="MSearchResults"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| <div id="nav-path" class="navpath"> | ||
| <ul> | ||
| <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_44f75d7a35fd4e33bdaab9f4bfdc7083.html">AudioLibs</a></li> </ul> | ||
| </div> | ||
| </div><!-- top --> | ||
| <div class="header"> | ||
| <div class="summary"> | ||
| <a href="#nested-classes">Classes</a> | | ||
| <a href="#namespaces">Namespaces</a> | | ||
| <a href="#enum-members">Enumerations</a> | | ||
| <a href="#func-members">Functions</a> | | ||
| <a href="#var-members">Variables</a> </div> | ||
| <div class="headertitle"> | ||
| <div class="title">A2DPStream.h File Reference</div> </div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
|
|
||
| <p>A2DP Support via Arduino Streams. | ||
| <a href="#details">More...</a></p> | ||
| <div class="textblock"><code>#include "AudioConfig.h"</code><br /> | ||
| <code>#include "<a class="el" href="_audio_tools_8h_source.html">AudioTools.h</a>"</code><br /> | ||
| <code>#include "BluetoothA2DPSink.h"</code><br /> | ||
| <code>#include "BluetoothA2DPSource.h"</code><br /> | ||
| <code>#include "AudioTools/AudioStreams.h"</code><br /> | ||
| <code>#include "Concurrency/BufferRTOS.h"</code><br /> | ||
| </div> | ||
| <p><a href="_a2_d_p_stream_8h_source.html">Go to the source code of this file.</a></p> | ||
| <table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> | ||
| Classes</h2></td></tr> | ||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_a2_d_p_config.html">A2DPConfig</a></td></tr> | ||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration for <a class="el" href="classaudio__tools_1_1_a2_d_p_stream.html" title="Stream support for A2DP using https://github.com/pschatzmann/ESP32-A2DP: begin(TX_MODE) opens a a2dp_...">A2DPStream</a>. <a href="classaudio__tools_1_1_a2_d_p_config.html#details">More...</a><br /></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_a2_d_p_stream.html">A2DPStream</a></td></tr> | ||
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> support for A2DP using <a href="https://github.com/pschatzmann/ESP32-A2DP:">https://github.com/pschatzmann/ESP32-A2DP:</a> begin(TX_MODE) opens a a2dp_source and begin(RX_MODE) a a2dp_sink. The data is in int16_t with 2 channels at 44100 hertz. We support only one instance of the class! Please note that this is a conveniance class that supports the stream api, however this is rather inefficient, beause quite a bit buffer needs to be allocated. It is recommended to use the API with the callbacks. Examples can be found in the examples-basic-api directory. <a href="classaudio__tools_1_1_a2_d_p_stream.html#details">More...</a><br /></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table><table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> | ||
| Namespaces</h2></td></tr> | ||
| <tr class="memitem:namespaceaudio__tools"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaudio__tools.html">audio_tools</a></td></tr> | ||
| <tr class="memdesc:namespaceaudio__tools"><td class="mdescLeft"> </td><td class="mdescRight">Generic Implementation of sound input and output for desktop environments using portaudio. <br /></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table><table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> | ||
| Enumerations</h2></td></tr> | ||
| <tr class="memitem:a1d4acd31001a6bca774a5d7f5eb98afa"><td class="memItemLeft" align="right" valign="top"><a id="a1d4acd31001a6bca774a5d7f5eb98afa"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaudio__tools.html#a1d4acd31001a6bca774a5d7f5eb98afa">A2DPNoData</a> { <b>A2DPSilence</b> | ||
| , <b>A2DPWhoosh</b> | ||
| }</td></tr> | ||
| <tr class="memdesc:a1d4acd31001a6bca774a5d7f5eb98afa"><td class="mdescLeft"> </td><td class="mdescRight">A2DP Action when there is no data. <br /></td></tr> | ||
| <tr class="separator:a1d4acd31001a6bca774a5d7f5eb98afa"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a2b5699409c82146721f7ed069d134dca"><td class="memItemLeft" align="right" valign="top"><a id="a2b5699409c82146721f7ed069d134dca"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaudio__tools.html#a2b5699409c82146721f7ed069d134dca">A2DPStartLogic</a> { <b>StartWhenBufferFull</b> | ||
| , <b>StartOnConnect</b> | ||
| }</td></tr> | ||
| <tr class="memdesc:a2b5699409c82146721f7ed069d134dca"><td class="mdescLeft"> </td><td class="mdescRight">A2DP Startup Logic. <br /></td></tr> | ||
| <tr class="separator:a2b5699409c82146721f7ed069d134dca"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table><table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> | ||
| Functions</h2></td></tr> | ||
| <tr class="memitem:a617391bdaaaa3fd418ff3a10e7428d63"><td class="memItemLeft" align="right" valign="top"><a id="a617391bdaaaa3fd418ff3a10e7428d63"></a> | ||
| void </td><td class="memItemRight" valign="bottom"><b>a2dp_stream_sink_sound_data</b> (const uint8_t *data, uint32_t len)</td></tr> | ||
| <tr class="separator:a617391bdaaaa3fd418ff3a10e7428d63"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:aa1ece901456a47e0104f93a9daba8c9f"><td class="memItemLeft" align="right" valign="top"><a id="aa1ece901456a47e0104f93a9daba8c9f"></a> | ||
| int32_t </td><td class="memItemRight" valign="bottom"><b>a2dp_stream_source_sound_data</b> (Frame *data, int32_t len)</td></tr> | ||
| <tr class="separator:aa1ece901456a47e0104f93a9daba8c9f"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table><table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> | ||
| Variables</h2></td></tr> | ||
| <tr class="memitem:a142a50ac852c3b35cdb5a39b10d7a53b"><td class="memItemLeft" align="right" valign="top"><a id="a142a50ac852c3b35cdb5a39b10d7a53b"></a> | ||
| static BufferRTOS< uint8_t > </td><td class="memItemRight" valign="bottom"><b>a2dp_buffer</b> {0, A2DP_BUFFER_SIZE, portMAX_DELAY, portMAX_DELAY}</td></tr> | ||
| <tr class="separator:a142a50ac852c3b35cdb5a39b10d7a53b"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:ae49dcee0fc374b24fca8634e3f50a8a6"><td class="memItemLeft" align="right" valign="top"><a id="ae49dcee0fc374b24fca8634e3f50a8a6"></a> | ||
| static A2DPStream * </td><td class="memItemRight" valign="bottom"><b>A2DPStream_self</b> =nullptr</td></tr> | ||
| <tr class="separator:ae49dcee0fc374b24fca8634e3f50a8a6"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a2392d2cf9f9fd71dde3fb54fe41c843f"><td class="memItemLeft" align="right" valign="top"><a id="a2392d2cf9f9fd71dde3fb54fe41c843f"></a> | ||
| static bool </td><td class="memItemRight" valign="bottom"><b>is_a2dp_active</b> = false</td></tr> | ||
| <tr class="separator:a2392d2cf9f9fd71dde3fb54fe41c843f"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table> | ||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | ||
| <div class="textblock"><p>A2DP Support via Arduino Streams. </p> | ||
| <dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl> | ||
| <dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 </dd></dl> | ||
| </div></div><!-- contents --> | ||
| <!-- start footer part --> | ||
| <hr class="footer"/><address class="footer"><small> | ||
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 | ||
| </small></address> | ||
| </body> | ||
| </html> |
Oops, something went wrong.