|
1 | 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" lang="en-US"> |
| 2 | +<html xmlns="http://www.w3.org/1999/xhtml"> |
3 | 3 | <head> |
4 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
5 | | -<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
6 | | -<meta name="generator" content="Doxygen 1.9.5"/> |
| 5 | +<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | +<meta name="generator" content="Doxygen 1.9.1"/> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
8 | 8 | <title>arduino-audio-tools: src/AudioHttp/AbstractURLStream.h Source File</title> |
9 | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
19 | 19 | <div id="titlearea"> |
20 | 20 | <table cellspacing="0" cellpadding="0"> |
21 | 21 | <tbody> |
22 | | - <tr id="projectrow"> |
23 | | - <td id="projectalign"> |
| 22 | + <tr style="height: 56px;"> |
| 23 | + <td id="projectalign" style="padding-left: 0.5em;"> |
24 | 24 | <div id="projectname">arduino-audio-tools |
25 | 25 | </div> |
26 | 26 | </td> |
|
29 | 29 | </table> |
30 | 30 | </div> |
31 | 31 | <!-- end header part --> |
32 | | -<!-- Generated by Doxygen 1.9.5 --> |
| 32 | +<!-- Generated by Doxygen 1.9.1 --> |
33 | 33 | <script type="text/javascript"> |
34 | | -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
35 | | -var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| 34 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 35 | +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
36 | 36 | /* @license-end */ |
37 | 37 | </script> |
38 | 38 | <script type="text/javascript" src="menudata.js"></script> |
39 | 39 | <script type="text/javascript" src="menu.js"></script> |
40 | 40 | <script type="text/javascript"> |
41 | | -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 41 | +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
42 | 42 | $(function() { |
43 | 43 | initMenu('',true,false,'search.php','Search'); |
44 | 44 | $(document).ready(function() { init_search(); }); |
45 | 45 | }); |
46 | | -/* @license-end */ |
47 | | -</script> |
| 46 | +/* @license-end */</script> |
48 | 47 | <div id="main-nav"></div> |
49 | 48 | <!-- window showing the filter options --> |
50 | 49 | <div id="MSearchSelectWindow" |
|
55 | 54 |
|
56 | 55 | <!-- iframe showing the search results (closed by default) --> |
57 | 56 | <div id="MSearchResultsWindow"> |
58 | | -<div id="MSearchResults"> |
59 | | -<div class="SRPage"> |
60 | | -<div id="SRIndex"> |
61 | | -<div id="SRResults"></div> |
62 | | -<div class="SRStatus" id="Loading">Loading...</div> |
63 | | -<div class="SRStatus" id="Searching">Searching...</div> |
64 | | -<div class="SRStatus" id="NoMatches">No Matches</div> |
65 | | -</div> |
66 | | -</div> |
67 | | -</div> |
| 57 | +<iframe src="javascript:void(0)" frameborder="0" |
| 58 | + name="MSearchResults" id="MSearchResults"> |
| 59 | +</iframe> |
68 | 60 | </div> |
69 | 61 |
|
70 | 62 | <div id="nav-path" class="navpath"> |
|
73 | 65 | </div> |
74 | 66 | </div><!-- top --> |
75 | 67 | <div class="header"> |
76 | | - <div class="headertitle"><div class="title">AbstractURLStream.h</div></div> |
| 68 | + <div class="headertitle"> |
| 69 | +<div class="title">AbstractURLStream.h</div> </div> |
77 | 70 | </div><!--header--> |
78 | 71 | <div class="contents"> |
79 | | -<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div> |
80 | | -<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div> |
81 | | -<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceaudio__tools.html">audio_tools</a> {</div> |
82 | | -<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div> |
83 | | -<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_abstract_u_r_l_stream.html"> 10</a></span><span class="keyword">class </span><a class="code hl_class" href="classaudio__tools_1_1_abstract_u_r_l_stream.html">AbstractURLStream</a> : <span class="keyword">public</span> <a class="code hl_class" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a> {</div> |
84 | | -<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">public</span>:</div> |
85 | | -<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// executes the URL request</span></div> |
86 | | -<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> begin(<span class="keyword">const</span> <span class="keywordtype">char</span>* urlStr, <span class="keyword">const</span> <span class="keywordtype">char</span>* acceptMime=<span class="keyword">nullptr</span>, MethodID action=GET, <span class="keyword">const</span> <span class="keywordtype">char</span>* reqMime=<span class="stringliteral">""</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>*reqData=<span class="stringliteral">""</span>) = 0;</div> |
87 | | -<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// ends the request</span></div> |
88 | | -<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> end()=0;</div> |
89 | | -<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a69ba0ea9edc26f8967f32b33dc5c9ab5"> 17</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classaudio__tools_1_1_http_request.html">HttpRequest</a> &<a class="code hl_function" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a69ba0ea9edc26f8967f32b33dc5c9ab5">httpRequest</a>()=0;</div> |
90 | | -<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// only the ICYStream supports this</span></div> |
91 | | -<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> setMetadataCallback(<span class="keywordtype">void</span> (*fn)(<a class="code hl_enumeration" href="group__metadata.html#ga6760f423085f8a63374b1e2db102a6d1">MetaDataType</a> info, <span class="keyword">const</span> <span class="keywordtype">char</span>* str, <span class="keywordtype">int</span> len)) {</div> |
92 | | -<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> |
93 | | -<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> }</div> |
94 | | -<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a86aa7db83a28e2662e01c57a36681cb0"> 23</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a86aa7db83a28e2662e01c57a36681cb0">availableForWrite</a>() {</div> |
95 | | -<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> 0;</div> |
96 | | -<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div> |
97 | | -<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
98 | | -<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>};</div> |
99 | | -<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div> |
100 | | -<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>}</div> |
| 72 | +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div> |
| 73 | +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  </div> |
| 74 | +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="keyword">namespace </span><a class="code" href="namespaceaudio__tools.html">audio_tools</a> {</div> |
| 75 | +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div> |
| 76 | +<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_abstract_u_r_l_stream.html"> 10</a></span> <span class="keyword">class </span><a class="code" href="classaudio__tools_1_1_abstract_u_r_l_stream.html">AbstractURLStream</a> : <span class="keyword">public</span> <a class="code" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a> {</div> |
| 77 | +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="keyword">public</span>:</div> |
| 78 | +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="comment">// executes the URL request</span></div> |
| 79 | +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> begin(<span class="keyword">const</span> <span class="keywordtype">char</span>* urlStr, <span class="keyword">const</span> <span class="keywordtype">char</span>* acceptMime=<span class="keyword">nullptr</span>, MethodID action=GET, <span class="keyword">const</span> <span class="keywordtype">char</span>* reqMime=<span class="stringliteral">""</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>*reqData=<span class="stringliteral">""</span>) = 0;</div> |
| 80 | +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="comment">// ends the request</span></div> |
| 81 | +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> end()=0;</div> |
| 82 | +<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#afd650515e4fa72af032ea2aa53d18a35"> 17</a></span>  <span class="keyword">virtual</span> <a class="code" href="classaudio__tools_1_1_http_request.html">HttpRequest</a> &<a class="code" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#afd650515e4fa72af032ea2aa53d18a35">httpRequest</a>()=0;</div> |
| 83 | +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="comment">// only the ICYStream supports this</span></div> |
| 84 | +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> setMetadataCallback(<span class="keywordtype">void</span> (*fn)(<a class="code" href="group__metadata.html#ga6760f423085f8a63374b1e2db102a6d1">MetaDataType</a> info, <span class="keyword">const</span> <span class="keywordtype">char</span>* str, <span class="keywordtype">int</span> len)) {</div> |
| 85 | +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> |
| 86 | +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  }</div> |
| 87 | +<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a86aa7db83a28e2662e01c57a36681cb0"> 23</a></span>  <span class="keywordtype">int</span> <a class="code" href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a86aa7db83a28e2662e01c57a36681cb0">availableForWrite</a>() {</div> |
| 88 | +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordflow">return</span> 0;</div> |
| 89 | +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  }</div> |
| 90 | +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div> |
| 91 | +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> };</div> |
| 92 | +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| 93 | +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> }</div> |
101 | 94 | <div class="ttc" id="aclassaudio__tools_1_1_abstract_u_r_l_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_abstract_u_r_l_stream.html">audio_tools::AbstractURLStream</a></div><div class="ttdoc">Abstract Base class for all URLStream implementations.</div><div class="ttdef"><b>Definition:</b> AbstractURLStream.h:10</div></div> |
102 | | -<div class="ttc" id="aclassaudio__tools_1_1_abstract_u_r_l_stream_html_a69ba0ea9edc26f8967f32b33dc5c9ab5"><div class="ttname"><a href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a69ba0ea9edc26f8967f32b33dc5c9ab5">audio_tools::AbstractURLStream::httpRequest</a></div><div class="ttdeci">virtual HttpRequest & httpRequest()=0</div><div class="ttdoc">provides access to the HttpRequest</div></div> |
103 | 95 | <div class="ttc" id="aclassaudio__tools_1_1_abstract_u_r_l_stream_html_a86aa7db83a28e2662e01c57a36681cb0"><div class="ttname"><a href="classaudio__tools_1_1_abstract_u_r_l_stream.html#a86aa7db83a28e2662e01c57a36681cb0">audio_tools::AbstractURLStream::availableForWrite</a></div><div class="ttdeci">int availableForWrite()</div><div class="ttdoc">Writes are not supported.</div><div class="ttdef"><b>Definition:</b> AbstractURLStream.h:23</div></div> |
| 96 | +<div class="ttc" id="aclassaudio__tools_1_1_abstract_u_r_l_stream_html_afd650515e4fa72af032ea2aa53d18a35"><div class="ttname"><a href="classaudio__tools_1_1_abstract_u_r_l_stream.html#afd650515e4fa72af032ea2aa53d18a35">audio_tools::AbstractURLStream::httpRequest</a></div><div class="ttdeci">virtual HttpRequest & httpRequest()=0</div><div class="ttdoc">provides access to the HttpRequest</div></div> |
104 | 97 | <div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html">audio_tools::AudioStream</a></div><div class="ttdoc">Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:35</div></div> |
105 | 98 | <div class="ttc" id="aclassaudio__tools_1_1_http_request_html"><div class="ttname"><a href="classaudio__tools_1_1_http_request.html">audio_tools::HttpRequest</a></div><div class="ttdoc">Simple API to process get, put, post, del http requests I tried to use Arduino HttpClient,...</div><div class="ttdef"><b>Definition:</b> HttpRequest.h:30</div></div> |
106 | 99 | <div class="ttc" id="agroup__metadata_html_ga6760f423085f8a63374b1e2db102a6d1"><div class="ttname"><a href="group__metadata.html#ga6760f423085f8a63374b1e2db102a6d1">audio_tools::MetaDataType</a></div><div class="ttdeci">MetaDataType</div><div class="ttdoc">Type of meta info.</div><div class="ttdef"><b>Definition:</b> AbstractMetaData.h:11</div></div> |
107 | 100 | <div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:8</div></div> |
108 | 101 | </div><!-- fragment --></div><!-- contents --> |
109 | 102 | <!-- start footer part --> |
110 | 103 | <hr class="footer"/><address class="footer"><small> |
111 | | -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.5 |
| 104 | +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 |
112 | 105 | </small></address> |
113 | 106 | </body> |
114 | 107 | </html> |
0 commit comments