mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
301 lines
28 KiB
HTML
301 lines
28 KiB
HTML
<!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: BufferedTaskStream Class 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="namespaceaudio__tools.html">audio_tools</a></li><li class="navelem"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html">BufferedTaskStream</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classaudio__tools_1_1_buffered_task_stream-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">BufferedTaskStream Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A FreeRTOS task is filling the buffer from the indicated stream. Only to be used on the ESP32.
|
|
<a href="classaudio__tools_1_1_buffered_task_stream.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_u_r_l_stream_buffered_8h_source.html">URLStreamBuffered.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BufferedTaskStream:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaudio__tools_1_1_buffered_task_stream.png" usemap="#BufferedTaskStream_map" alt=""/>
|
|
<map id="BufferedTaskStream_map" name="BufferedTaskStream_map">
|
|
<area href="classaudio__tools_1_1_audio_stream.html" title="Base class for all Audio Streams. It support the boolean operator to test if the object is ready with..." alt="AudioStream" shape="rect" coords="136,168,262,192"/>
|
|
<area href="classaudio__tools_1_1_base_stream.html" title="Base class for all Streams. It relies on write(const uint8_t *buffer, size_t size) and readBytes(uint..." alt="BaseStream" shape="rect" coords="0,112,126,136"/>
|
|
<area href="classaudio__tools_1_1_audio_info_support.html" title="Supports changes to the sampling rate, bits and channels." alt="AudioInfoSupport" shape="rect" coords="136,112,262,136"/>
|
|
<area href="classaudio__tools_1_1_audio_info_source.html" title="Supports the subscription to audio change notifications." alt="AudioInfoSource" shape="rect" coords="272,112,398,136"/>
|
|
<area href="classaudio__tools_1_1_stream.html" alt="Stream" shape="rect" coords="0,56,126,80"/>
|
|
<area href="classaudio__tools_1_1_print.html" alt="Print" shape="rect" coords="0,0,126,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a266f4b17f8f3efa6032f9556f26fe930"><td class="memItemLeft" align="right" valign="top"><a id="a266f4b17f8f3efa6032f9556f26fe930"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BufferedTaskStream</b> (<a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a> &input)</td></tr>
|
|
<tr class="separator:a266f4b17f8f3efa6032f9556f26fe930"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a727a24459787e1eeeb7a37ba888394a6"><td class="memItemLeft" align="right" valign="top"><a id="a727a24459787e1eeeb7a37ba888394a6"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a727a24459787e1eeeb7a37ba888394a6">addNotifyAudioChange</a> (<a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> &bi)</td></tr>
|
|
<tr class="memdesc:a727a24459787e1eeeb7a37ba888394a6"><td class="mdescLeft"> </td><td class="mdescRight">Adds target to be notified about audio changes. <br /></td></tr>
|
|
<tr class="separator:a727a24459787e1eeeb7a37ba888394a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aececda97cff151859a8695d30896dd20"><td class="memItemLeft" align="right" valign="top"><a id="aececda97cff151859a8695d30896dd20"></a>
|
|
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#aececda97cff151859a8695d30896dd20">audioInfo</a> () override</td></tr>
|
|
<tr class="memdesc:aececda97cff151859a8695d30896dd20"><td class="mdescLeft"> </td><td class="mdescRight">provides the actual input <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> <br /></td></tr>
|
|
<tr class="separator:aececda97cff151859a8695d30896dd20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memItemLeft" align="right" valign="top"><a id="a1c77cb3dbe910c765ea439d103bdcbb9"></a>
|
|
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_support.html#a1c77cb3dbe910c765ea439d103bdcbb9">audioInfoOut</a> ()</td></tr>
|
|
<tr class="memdesc:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="mdescLeft"> </td><td class="mdescRight">provides the actual output <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a>: this is usually the same as <a class="el" href="classaudio__tools_1_1_audio_info_support.html#ae0d5f156b0564368220fa8d328db3880" title="provides the actual input AudioInfo">audioInfo()</a> unless we use a transforming stream <br /></td></tr>
|
|
<tr class="separator:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbb59a2f946191d7cf2a5c0a00b29ec2"><td class="memItemLeft" align="right" valign="top"><a id="afbb59a2f946191d7cf2a5c0a00b29ec2"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html#afbb59a2f946191d7cf2a5c0a00b29ec2">available</a> () override</td></tr>
|
|
<tr class="memdesc:afbb59a2f946191d7cf2a5c0a00b29ec2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the available bytes in the buffer: to be avoided. <br /></td></tr>
|
|
<tr class="separator:afbb59a2f946191d7cf2a5c0a00b29ec2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ff0d6d1b0f3f9b652c9d5298ed0863c"><td class="memItemLeft" align="right" valign="top"><a id="a6ff0d6d1b0f3f9b652c9d5298ed0863c"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>availableForWrite</b> () override</td></tr>
|
|
<tr class="separator:a6ff0d6d1b0f3f9b652c9d5298ed0863c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50f45551c10ca30a0bc7f447e70188b1"><td class="memItemLeft" align="right" valign="top"><a id="a50f45551c10ca30a0bc7f447e70188b1"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
|
|
<tr class="separator:a50f45551c10ca30a0bc7f447e70188b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdecf46062aa24cce4e4865d2d3d2888"><td class="memItemLeft" align="right" valign="top"><a id="afdecf46062aa24cce4e4865d2d3d2888"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>begin</b> (bool wait=true)</td></tr>
|
|
<tr class="separator:afdecf46062aa24cce4e4865d2d3d2888"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affd15675a5e391c34cccefa7181354bb"><td class="memItemLeft" align="right" valign="top"><a id="affd15675a5e391c34cccefa7181354bb"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#affd15675a5e391c34cccefa7181354bb">clearNotifyAudioChange</a> ()</td></tr>
|
|
<tr class="memdesc:affd15675a5e391c34cccefa7181354bb"><td class="mdescLeft"> </td><td class="mdescRight">Deletes all change notify subscriptions. <br /></td></tr>
|
|
<tr class="separator:affd15675a5e391c34cccefa7181354bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc34417a19a7b70626d19c41072d72a5"><td class="memItemLeft" align="right" valign="top"><a id="adc34417a19a7b70626d19c41072d72a5"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
|
|
<tr class="separator:adc34417a19a7b70626d19c41072d72a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af654b48544c195ab99fe27e7bc3ed5fe"><td class="memItemLeft" align="right" valign="top"><a id="af654b48544c195ab99fe27e7bc3ed5fe"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html#af654b48544c195ab99fe27e7bc3ed5fe">flush</a> () override</td></tr>
|
|
<tr class="memdesc:af654b48544c195ab99fe27e7bc3ed5fe"><td class="mdescLeft"> </td><td class="mdescRight">empties the buffer <br /></td></tr>
|
|
<tr class="separator:af654b48544c195ab99fe27e7bc3ed5fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="memItemLeft" align="right" valign="top"><a id="a475bc9908ea8a1d67e5cc1c1f67a71b2"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a475bc9908ea8a1d67e5cc1c1f67a71b2">isNotifyActive</a> ()</td></tr>
|
|
<tr class="memdesc:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the automatic <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> update is active. <br /></td></tr>
|
|
<tr class="separator:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d52c0ed98e047d782054fa126b281e5"><td class="memItemLeft" align="right" valign="top"><a id="a0d52c0ed98e047d782054fa126b281e5"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
|
|
<tr class="separator:a0d52c0ed98e047d782054fa126b281e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9bb6daa18ee5d207a6f2e1899eaadcf3"><td class="memItemLeft" align="right" valign="top"><a id="a9bb6daa18ee5d207a6f2e1899eaadcf3"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html#a9bb6daa18ee5d207a6f2e1899eaadcf3">peek</a> () override</td></tr>
|
|
<tr class="memdesc:a9bb6daa18ee5d207a6f2e1899eaadcf3"><td class="mdescLeft"> </td><td class="mdescRight">peeks a byte - to be avoided <br /></td></tr>
|
|
<tr class="separator:a9bb6daa18ee5d207a6f2e1899eaadcf3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31e8f8111a9c57b7a2be72337ab07e0e"><td class="memItemLeft" align="right" valign="top"><a id="a31e8f8111a9c57b7a2be72337ab07e0e"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html#a31e8f8111a9c57b7a2be72337ab07e0e">read</a> () override</td></tr>
|
|
<tr class="memdesc:a31e8f8111a9c57b7a2be72337ab07e0e"><td class="mdescLeft"> </td><td class="mdescRight">reads a byte - to be avoided <br /></td></tr>
|
|
<tr class="separator:a31e8f8111a9c57b7a2be72337ab07e0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6406b16cb31ad79201459cb48b1ad6f0"><td class="memItemLeft" align="right" valign="top"><a id="a6406b16cb31ad79201459cb48b1ad6f0"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html#a6406b16cb31ad79201459cb48b1ad6f0">readBytes</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a6406b16cb31ad79201459cb48b1ad6f0"><td class="mdescLeft"> </td><td class="mdescRight">Use this method !! <br /></td></tr>
|
|
<tr class="separator:a6406b16cb31ad79201459cb48b1ad6f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36e26f40121eda38b0042dcba026ab82"><td class="memItemLeft" align="right" valign="top"><a id="a36e26f40121eda38b0042dcba026ab82"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#a36e26f40121eda38b0042dcba026ab82">readSilence</a> (uint8_t *buffer, size_t length)</td></tr>
|
|
<tr class="memdesc:a36e26f40121eda38b0042dcba026ab82"><td class="mdescLeft"> </td><td class="mdescRight">Source to generate silence: just sets the buffer to 0. <br /></td></tr>
|
|
<tr class="separator:a36e26f40121eda38b0042dcba026ab82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="memItemLeft" align="right" valign="top"><a id="aa5b1cdb06807ff2dc37acbaff63410b9"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#aa5b1cdb06807ff2dc37acbaff63410b9">removeNotifyAudioChange</a> (<a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> &bi)</td></tr>
|
|
<tr class="memdesc:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="mdescLeft"> </td><td class="mdescRight">Removes a target in order not to be notified about audio changes. <br /></td></tr>
|
|
<tr class="separator:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbaca7240bc555603b0da5b7ca11ce10"><td class="memItemLeft" align="right" valign="top"><a id="acbaca7240bc555603b0da5b7ca11ce10"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#acbaca7240bc555603b0da5b7ca11ce10">setAudioInfo</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> newInfo) override</td></tr>
|
|
<tr class="memdesc:acbaca7240bc555603b0da5b7ca11ce10"><td class="mdescLeft"> </td><td class="mdescRight">Defines the input <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a>. <br /></td></tr>
|
|
<tr class="separator:acbaca7240bc555603b0da5b7ca11ce10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae31474505d93752ef5a1c4b79e9b653b"><td class="memItemLeft" align="right" valign="top"><a id="ae31474505d93752ef5a1c4b79e9b653b"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>setInput</b> (<a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a> &input)</td></tr>
|
|
<tr class="separator:ae31474505d93752ef5a1c4b79e9b653b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a909f118906f9cf7024baae224dcd90a7"><td class="memItemLeft" align="right" valign="top"><a id="a909f118906f9cf7024baae224dcd90a7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a909f118906f9cf7024baae224dcd90a7">setNotifyActive</a> (bool flag)</td></tr>
|
|
<tr class="memdesc:a909f118906f9cf7024baae224dcd90a7"><td class="mdescLeft"> </td><td class="mdescRight">Deactivate/Reactivate automatic <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> updates: (default is active) <br /></td></tr>
|
|
<tr class="separator:a909f118906f9cf7024baae224dcd90a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a016bb39af201e717c1975551b7ecc1b3"><td class="memItemLeft" align="right" valign="top"><a id="a016bb39af201e717c1975551b7ecc1b3"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html#a016bb39af201e717c1975551b7ecc1b3">write</a> (const uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a016bb39af201e717c1975551b7ecc1b3"><td class="mdescLeft"> </td><td class="mdescRight">Use this method: write an array. <br /></td></tr>
|
|
<tr class="separator:a016bb39af201e717c1975551b7ecc1b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf33c44b7e9ab693bc5e2f5f501f4747"><td class="memItemLeft" align="right" valign="top"><a id="aaf33c44b7e9ab693bc5e2f5f501f4747"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_buffered_task_stream.html#aaf33c44b7e9ab693bc5e2f5f501f4747">write</a> (uint8_t c) override</td></tr>
|
|
<tr class="memdesc:aaf33c44b7e9ab693bc5e2f5f501f4747"><td class="mdescLeft"> </td><td class="mdescRight">writes a byte to the buffer <br /></td></tr>
|
|
<tr class="separator:aaf33c44b7e9ab693bc5e2f5f501f4747"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad89418aeb557f65a8f1a0aed755633b1"><td class="memItemLeft" align="right" valign="top"><a id="ad89418aeb557f65a8f1a0aed755633b1"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#ad89418aeb557f65a8f1a0aed755633b1">writeSilence</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:ad89418aeb557f65a8f1a0aed755633b1"><td class="mdescLeft"> </td><td class="mdescRight">Writes len bytes of silence (=0). <br /></td></tr>
|
|
<tr class="separator:ad89418aeb557f65a8f1a0aed755633b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:afc00b141650b11fe19d4c7055d96a075"><td class="memItemLeft" align="right" valign="top"><a id="afc00b141650b11fe19d4c7055d96a075"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>not_supported</b> (int out, const char *msg="")</td></tr>
|
|
<tr class="separator:afc00b141650b11fe19d4c7055d96a075"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a9a665a387a8c4fbf7fed14bbbfc093"><td class="memItemLeft" align="right" valign="top"><a id="a6a9a665a387a8c4fbf7fed14bbbfc093"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>notifyAudioChange</b> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
|
|
<tr class="separator:a6a9a665a387a8c4fbf7fed14bbbfc093"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a896bed4f07ac8bb1e9dab993551dc193"><td class="memItemLeft" align="right" valign="top"><a id="a896bed4f07ac8bb1e9dab993551dc193"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>processTask</b> ()</td></tr>
|
|
<tr class="separator:a896bed4f07ac8bb1e9dab993551dc193"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5caf99a24686511722c4c9f94c4ec52e"><td class="memItemLeft" align="right" valign="top"><a id="a5caf99a24686511722c4c9f94c4ec52e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>refillReadBuffer</b> ()</td></tr>
|
|
<tr class="separator:a5caf99a24686511722c4c9f94c4ec52e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:aa66a35e5edf58ce00047afcd1d4f455e"><td class="memItemLeft" align="right" valign="top"><a id="aa66a35e5edf58ce00047afcd1d4f455e"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>_timeout</b> = 10</td></tr>
|
|
<tr class="separator:aa66a35e5edf58ce00047afcd1d4f455e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memItemLeft" align="right" valign="top"><a id="a03c996f9fcf0e10baeb3e700be0c409a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>active</b> = false</td></tr>
|
|
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe3955ff0cbc3a3cafaf450a49162c54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaudio__tools_1_1_synchronized_n_buffer.html">SynchronizedNBuffer</a>< uint8_t > </td><td class="memItemRight" valign="bottom"><b>buffers</b></td></tr>
|
|
<tr class="separator:abe3955ff0cbc3a3cafaf450a49162c54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47385aa19435f5fca9d3083a748258c5"><td class="memItemLeft" align="right" valign="top"><a id="a47385aa19435f5fca9d3083a748258c5"></a>
|
|
<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><b>info</b></td></tr>
|
|
<tr class="separator:a47385aa19435f5fca9d3083a748258c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeaba7fcedcb403536c79ee7f04de17fc"><td class="memItemLeft" align="right" valign="top"><a id="aeaba7fcedcb403536c79ee7f04de17fc"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>is_notify_active</b> = true</td></tr>
|
|
<tr class="separator:aeaba7fcedcb403536c79ee7f04de17fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad35c4e2ef458c36e8d36676958cc9cd3"><td class="memItemLeft" align="right" valign="top"><a id="ad35c4e2ef458c36e8d36676958cc9cd3"></a>
|
|
<a class="el" href="classaudio__tools_1_1_vector.html">Vector</a>< <a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> * > </td><td class="memItemRight" valign="bottom"><b>notify_vector</b></td></tr>
|
|
<tr class="separator:ad35c4e2ef458c36e8d36676958cc9cd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e7b72b967f1cbc12e11736ff25e66b7"><td class="memItemLeft" align="right" valign="top"><a id="a8e7b72b967f1cbc12e11736ff25e66b7"></a>
|
|
<a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a> * </td><td class="memItemRight" valign="bottom"><b>p_stream</b> = nullptr</td></tr>
|
|
<tr class="separator:a8e7b72b967f1cbc12e11736ff25e66b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65cf7d7f8e531611b245355ab91fd749"><td class="memItemLeft" align="right" valign="top"><a id="a65cf7d7f8e531611b245355ab91fd749"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ready</b> = false</td></tr>
|
|
<tr class="separator:a65cf7d7f8e531611b245355ab91fd749"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8bcc572b9d73774627be66dd46aa61a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaudio__tools_1_1_task.html">Task</a> </td><td class="memItemRight" valign="bottom"><b>task</b></td></tr>
|
|
<tr class="separator:a8bcc572b9d73774627be66dd46aa61a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf64bd29ec689f2d7574efbb63f440bb"><td class="memItemLeft" align="right" valign="top"><a id="adf64bd29ec689f2d7574efbb63f440bb"></a>
|
|
<a class="el" href="classaudio__tools_1_1_ring_buffer.html">RingBuffer</a>< uint8_t > </td><td class="memItemRight" valign="bottom"><b>tmp_in</b> {0}</td></tr>
|
|
<tr class="separator:adf64bd29ec689f2d7574efbb63f440bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add363d597c7d8108a5350406105d158d"><td class="memItemLeft" align="right" valign="top"><a id="add363d597c7d8108a5350406105d158d"></a>
|
|
<a class="el" href="classaudio__tools_1_1_ring_buffer.html">RingBuffer</a>< uint8_t > </td><td class="memItemRight" valign="bottom"><b>tmp_out</b> {0}</td></tr>
|
|
<tr class="separator:add363d597c7d8108a5350406105d158d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A FreeRTOS task is filling the buffer from the indicated stream. Only to be used on the ESP32. </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><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="abe3955ff0cbc3a3cafaf450a49162c54"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe3955ff0cbc3a3cafaf450a49162c54">◆ </a></span>buffers</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaudio__tools_1_1_synchronized_n_buffer.html">SynchronizedNBuffer</a><uint8_t> buffers</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">{DEFAULT_BUFFER_SIZE,</div>
|
|
<div class="line"> 10 }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a8bcc572b9d73774627be66dd46aa61a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8bcc572b9d73774627be66dd46aa61a8">◆ </a></span>task</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaudio__tools_1_1_task.html">Task</a> task</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">{<span class="stringliteral">"BufferedTaskStream"</span>, 30000 , 2 ,</div>
|
|
<div class="line"> 0 }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/AudioHttp/<a class="el" href="_u_r_l_stream_buffered_8h_source.html">URLStreamBuffered.h</a></li>
|
|
</ul>
|
|
</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>
|