mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
908 lines
74 KiB
HTML
908 lines
74 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: AudioBoardStream 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_audio_board_stream.html">AudioBoardStream</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static 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_audio_board_stream-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">AudioBoardStream Class Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> » <a class="el" href="group__io.html">IO</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>New functionality which replaces the <a class="el" href="classaudio__tools_1_1_audio_kit_stream.html" title="AudioKit Stream which uses the https://github.com/pschatzmann/arduino-audiokit library.">AudioKitStream</a> that is based on the legacy AudioKit library. This functionality uses the new arduino-audio-driver library! It is the same as <a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html" title="I2S Stream which also sets up a codec chip and i2s.">I2SCodecStream</a> extended by some <a class="el" href="classaudio__tools_1_1_audio_actions.html" title="A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...">AudioActions</a> and some method calls to determine defined pin values. See <a href="https://github.com/pschatzmann/arduino-audio-driver">https://github.com/pschatzmann/arduino-audio-driver</a>.
|
|
<a href="classaudio__tools_1_1_audio_board_stream.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_audio_board_stream_8h_source.html">AudioBoardStream.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for AudioBoardStream:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaudio__tools_1_1_audio_board_stream.png" usemap="#AudioBoardStream_map" alt=""/>
|
|
<map id="AudioBoardStream_map" name="AudioBoardStream_map">
|
|
<area href="classaudio__tools_1_1_i2_s_codec_stream.html" title="I2S Stream which also sets up a codec chip and i2s." alt="I2SCodecStream" shape="rect" coords="192,224,310,248"/>
|
|
<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="128,168,246,192"/>
|
|
<area href="classaudio__tools_1_1_volume_support.html" title="Supports the setting and getting of the volume." alt="VolumeSupport" shape="rect" coords="256,168,374,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,118,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="128,112,246,136"/>
|
|
<area href="classaudio__tools_1_1_audio_info_source.html" title="Supports the subscription to audio change notifications." alt="AudioInfoSource" shape="rect" coords="256,112,374,136"/>
|
|
<area href="classaudio__tools_1_1_stream.html" alt="Stream" shape="rect" coords="0,56,118,80"/>
|
|
<area href="classaudio__tools_1_1_print.html" alt="Print" shape="rect" coords="0,0,118,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:a90a2f381b162843ef3ae04e0ccba03a8"><td class="memItemLeft" align="right" valign="top"><a id="a90a2f381b162843ef3ae04e0ccba03a8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a90a2f381b162843ef3ae04e0ccba03a8">AudioBoardStream</a> (audio_driver::AudioBoard &<a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a6a896ab86ed22240433abf907dc6bd89">board</a>)</td></tr>
|
|
<tr class="memdesc:a90a2f381b162843ef3ae04e0ccba03a8"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor: for available AudioBoard values check the audioboard variables in <a href="https://pschatzmann.github.io/arduino-audio-driver/html/group__audio__driver.html">https://pschatzmann.github.io/arduino-audio-driver/html/group__audio__driver.html</a> Further information can be found in <a href="https://github.com/pschatzmann/arduino-audio-driver/wiki">https://github.com/pschatzmann/arduino-audio-driver/wiki</a>. <br /></td></tr>
|
|
<tr class="separator:a90a2f381b162843ef3ae04e0ccba03a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24fac46b019688e1b0993569912128a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a24fac46b019688e1b0993569912128a1">addAction</a> (int pin, void(*action)(bool, int, void *), AudioActions::ActiveLogic activeLogic, void *ref=nullptr)</td></tr>
|
|
<tr class="memdesc:a24fac46b019688e1b0993569912128a1"><td class="mdescLeft"> </td><td class="mdescRight">Defines a new action that is executed when the indicated pin is active. <a href="classaudio__tools_1_1_audio_board_stream.html#a24fac46b019688e1b0993569912128a1">More...</a><br /></td></tr>
|
|
<tr class="separator:a24fac46b019688e1b0993569912128a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08e8001d4d1048b8fd9e13a5e968d453"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a08e8001d4d1048b8fd9e13a5e968d453">addAction</a> (int pin, void(*action)(bool, int, void *), void *ref=nullptr)</td></tr>
|
|
<tr class="memdesc:a08e8001d4d1048b8fd9e13a5e968d453"><td class="mdescLeft"> </td><td class="mdescRight">Defines a new action that is executed when the indicated pin is active. <a href="classaudio__tools_1_1_audio_board_stream.html#a08e8001d4d1048b8fd9e13a5e968d453">More...</a><br /></td></tr>
|
|
<tr class="separator:a08e8001d4d1048b8fd9e13a5e968d453"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8451639c179c52119e0fb39d86e5719f"><td class="memItemLeft" align="right" valign="top"><a id="a8451639c179c52119e0fb39d86e5719f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a8451639c179c52119e0fb39d86e5719f">addDefaultActions</a> ()</td></tr>
|
|
<tr class="memdesc:a8451639c179c52119e0fb39d86e5719f"><td class="mdescLeft"> </td><td class="mdescRight">Setup the supported default actions (volume, start/stop, headphone detection) <br /></td></tr>
|
|
<tr class="separator:a8451639c179c52119e0fb39d86e5719f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a997115f66b809b918d4adab4ab247515"><td class="memItemLeft" align="right" valign="top"><a id="a997115f66b809b918d4adab4ab247515"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a997115f66b809b918d4adab4ab247515">addHeadphonDetectionAction</a> ()</td></tr>
|
|
<tr class="memdesc:a997115f66b809b918d4adab4ab247515"><td class="mdescLeft"> </td><td class="mdescRight">Adds headphone determination. <br /></td></tr>
|
|
<tr class="separator:a997115f66b809b918d4adab4ab247515"><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:a9fdbf0fe2878957057a1c856aac1afb4"><td class="memItemLeft" align="right" valign="top"><a id="a9fdbf0fe2878957057a1c856aac1afb4"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a9fdbf0fe2878957057a1c856aac1afb4">addStartStopAction</a> ()</td></tr>
|
|
<tr class="memdesc:a9fdbf0fe2878957057a1c856aac1afb4"><td class="mdescLeft"> </td><td class="mdescRight">add start/stop on inputMode <br /></td></tr>
|
|
<tr class="separator:a9fdbf0fe2878957057a1c856aac1afb4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a6c8645266db32c2f6fd8257cc51f06"><td class="memItemLeft" align="right" valign="top"><a id="a9a6c8645266db32c2f6fd8257cc51f06"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a9a6c8645266db32c2f6fd8257cc51f06">addVolumeActions</a> ()</td></tr>
|
|
<tr class="memdesc:a9a6c8645266db32c2f6fd8257cc51f06"><td class="mdescLeft"> </td><td class="mdescRight">add volume up and volume down action <br /></td></tr>
|
|
<tr class="separator:a9a6c8645266db32c2f6fd8257cc51f06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4712eb0707514d26c1f17fc09575c6ff"><td class="memItemLeft" align="right" valign="top"><a id="a4712eb0707514d26c1f17fc09575c6ff"></a>
|
|
<a class="el" href="classaudio__tools_1_1_audio_actions.html">AudioActions</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a4712eb0707514d26c1f17fc09575c6ff">audioActions</a> ()</td></tr>
|
|
<tr class="memdesc:a4712eb0707514d26c1f17fc09575c6ff"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classaudio__tools_1_1_audio_actions.html" title="A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...">AudioActions</a>. <br /></td></tr>
|
|
<tr class="separator:a4712eb0707514d26c1f17fc09575c6ff"><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_i2_s_codec_stream.html#afbb59a2f946191d7cf2a5c0a00b29ec2">available</a> () override</td></tr>
|
|
<tr class="memdesc:afbb59a2f946191d7cf2a5c0a00b29ec2"><td class="mdescLeft"> </td><td class="mdescRight">Provides the available audio data. <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"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a6ff0d6d1b0f3f9b652c9d5298ed0863c">availableForWrite</a> () override</td></tr>
|
|
<tr class="memdesc:a6ff0d6d1b0f3f9b652c9d5298ed0863c"><td class="mdescLeft"> </td><td class="mdescRight">Provides the available audio data. <br /></td></tr>
|
|
<tr class="separator:a6ff0d6d1b0f3f9b652c9d5298ed0863c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acba365cc28eb702040c382646cfb0a7a"><td class="memItemLeft" align="right" valign="top"><a id="acba365cc28eb702040c382646cfb0a7a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>begin</b> () override</td></tr>
|
|
<tr class="separator:acba365cc28eb702040c382646cfb0a7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61557dc282cd11030598a02dd7c9f300"><td class="memItemLeft" align="right" valign="top"><a id="a61557dc282cd11030598a02dd7c9f300"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a61557dc282cd11030598a02dd7c9f300">begin</a> (<a class="el" href="structaudio__tools_1_1_i2_s_codec_config.html">I2SCodecConfig</a> cfg) override</td></tr>
|
|
<tr class="memdesc:a61557dc282cd11030598a02dd7c9f300"><td class="mdescLeft"> </td><td class="mdescRight">Starts the I2S interface. <br /></td></tr>
|
|
<tr class="separator:a61557dc282cd11030598a02dd7c9f300"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a896ab86ed22240433abf907dc6bd89"><td class="memItemLeft" align="right" valign="top"><a id="a6a896ab86ed22240433abf907dc6bd89"></a>
|
|
AudioBoard & </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a6a896ab86ed22240433abf907dc6bd89">board</a> ()</td></tr>
|
|
<tr class="memdesc:a6a896ab86ed22240433abf907dc6bd89"><td class="mdescLeft"> </td><td class="mdescRight">Provides the board. <br /></td></tr>
|
|
<tr class="separator:a6a896ab86ed22240433abf907dc6bd89"><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:a71295636859da247dd8398d2c7097ccb"><td class="memItemLeft" align="right" valign="top"><a id="a71295636859da247dd8398d2c7097ccb"></a>
|
|
<a class="el" href="structaudio__tools_1_1_i2_s_codec_config.html">I2SCodecConfig</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a71295636859da247dd8398d2c7097ccb">defaultConfig</a> (<a class="el" href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">RxTxMode</a> mode=TX_MODE)</td></tr>
|
|
<tr class="memdesc:a71295636859da247dd8398d2c7097ccb"><td class="mdescLeft"> </td><td class="mdescRight">Provides the default configuration. <br /></td></tr>
|
|
<tr class="separator:a71295636859da247dd8398d2c7097ccb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a689451e34493ddc13d4f8456089df1a5"><td class="memItemLeft" align="right" valign="top"><a id="a689451e34493ddc13d4f8456089df1a5"></a>
|
|
<a class="el" href="classaudio__tools_1_1_i2_s_driver_e_s_p32.html">I2SDriver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a689451e34493ddc13d4f8456089df1a5">driver</a> ()</td></tr>
|
|
<tr class="memdesc:a689451e34493ddc13d4f8456089df1a5"><td class="mdescLeft"> </td><td class="mdescRight">Provides the i2s driver. <br /></td></tr>
|
|
<tr class="separator:a689451e34493ddc13d4f8456089df1a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf81d3fdaf258088d7692fa70cece087"><td class="memItemLeft" align="right" valign="top"><a id="aaf81d3fdaf258088d7692fa70cece087"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#aaf81d3fdaf258088d7692fa70cece087">end</a> ()</td></tr>
|
|
<tr class="memdesc:aaf81d3fdaf258088d7692fa70cece087"><td class="mdescLeft"> </td><td class="mdescRight">Stops the I2S interface. <br /></td></tr>
|
|
<tr class="separator:aaf81d3fdaf258088d7692fa70cece087"><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"><b>flush</b> () override</td></tr>
|
|
<tr class="separator:af654b48544c195ab99fe27e7bc3ed5fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6abf68b86516d04f8b69a62be8a36e6"><td class="memItemLeft" align="right" valign="top"><a id="ad6abf68b86516d04f8b69a62be8a36e6"></a>
|
|
<a class="el" href="classaudio__tools_1_1_audio_actions.html">AudioActions</a> & </td><td class="memItemRight" valign="bottom"><b>getActions</b> ()</td></tr>
|
|
<tr class="separator:ad6abf68b86516d04f8b69a62be8a36e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9736b8f2749abbd1a2edba38e9b96e39"><td class="memItemLeft" align="right" valign="top"><a id="a9736b8f2749abbd1a2edba38e9b96e39"></a>
|
|
GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a9736b8f2749abbd1a2edba38e9b96e39">getKey</a> (int pos)</td></tr>
|
|
<tr class="memdesc:a9736b8f2749abbd1a2edba38e9b96e39"><td class="mdescLeft"> </td><td class="mdescRight">Provides the gpio for the indicated key pos. <br /></td></tr>
|
|
<tr class="separator:a9736b8f2749abbd1a2edba38e9b96e39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc7e7ed349d6b52628ad9dc78d665727"><td class="memItemLeft" align="right" valign="top"><a id="adc7e7ed349d6b52628ad9dc78d665727"></a>
|
|
GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#adc7e7ed349d6b52628ad9dc78d665727">getPinID</a> (PinFunction function)</td></tr>
|
|
<tr class="memdesc:adc7e7ed349d6b52628ad9dc78d665727"><td class="mdescLeft"> </td><td class="mdescRight">Provides the gpio for the indicated function. <br /></td></tr>
|
|
<tr class="separator:adc7e7ed349d6b52628ad9dc78d665727"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab69341b1e881a1473ecd2f45dd110826"><td class="memItemLeft" align="right" valign="top"><a id="ab69341b1e881a1473ecd2f45dd110826"></a>
|
|
GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#ab69341b1e881a1473ecd2f45dd110826">getPinID</a> (PinFunction function, int pos)</td></tr>
|
|
<tr class="memdesc:ab69341b1e881a1473ecd2f45dd110826"><td class="mdescLeft"> </td><td class="mdescRight">Provides the gpio for the indicated function. <br /></td></tr>
|
|
<tr class="separator:ab69341b1e881a1473ecd2f45dd110826"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec6b6a6470235a8500063be9a64dc380"><td class="memItemLeft" align="right" valign="top"><a id="aec6b6a6470235a8500063be9a64dc380"></a>
|
|
DriverPins & </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#aec6b6a6470235a8500063be9a64dc380">getPins</a> ()</td></tr>
|
|
<tr class="memdesc:aec6b6a6470235a8500063be9a64dc380"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the pin information. <br /></td></tr>
|
|
<tr class="separator:aec6b6a6470235a8500063be9a64dc380"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc34138b4a6abf14269a6a34e901a5c8"><td class="memItemLeft" align="right" valign="top"><a id="abc34138b4a6abf14269a6a34e901a5c8"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#abc34138b4a6abf14269a6a34e901a5c8">getVolume</a> ()</td></tr>
|
|
<tr class="memdesc:abc34138b4a6abf14269a6a34e901a5c8"><td class="mdescLeft"> </td><td class="mdescRight">legacy: same as <a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a75896c16336462449610b256c8313b4c" title="Provides the actual volume (0.0f - 1.0f)">volume()</a> <br /></td></tr>
|
|
<tr class="separator:abc34138b4a6abf14269a6a34e901a5c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ba991aaffca599345eb6969122fb547"><td class="memItemLeft" align="right" valign="top"><a id="a0ba991aaffca599345eb6969122fb547"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a0ba991aaffca599345eb6969122fb547">hasBoard</a> ()</td></tr>
|
|
<tr class="memdesc:a0ba991aaffca599345eb6969122fb547"><td class="mdescLeft"> </td><td class="mdescRight">checks if a board has been defined <br /></td></tr>
|
|
<tr class="separator:a0ba991aaffca599345eb6969122fb547"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad497d1809a653cebe8e82b625e642bb1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#ad497d1809a653cebe8e82b625e642bb1">headphoneStatus</a> ()</td></tr>
|
|
<tr class="memdesc:ad497d1809a653cebe8e82b625e642bb1"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the headphone was detected. <a href="classaudio__tools_1_1_audio_board_stream.html#ad497d1809a653cebe8e82b625e642bb1">More...</a><br /></td></tr>
|
|
<tr class="separator:ad497d1809a653cebe8e82b625e642bb1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a899b8192ea6dc5d7db20c57121655f58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a899b8192ea6dc5d7db20c57121655f58">incrementVolume</a> (float inc)</td></tr>
|
|
<tr class="memdesc:a899b8192ea6dc5d7db20c57121655f58"><td class="mdescLeft"> </td><td class="mdescRight">Relative volume control. <a href="classaudio__tools_1_1_audio_board_stream.html#a899b8192ea6dc5d7db20c57121655f58">More...</a><br /></td></tr>
|
|
<tr class="separator:a899b8192ea6dc5d7db20c57121655f58"><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:a3cc5bafcade54d106ec00838c30d856a"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a3cc5bafcade54d106ec00838c30d856a">pinAuxin</a> ()</td></tr>
|
|
<tr class="memdesc:a3cc5bafcade54d106ec00838c30d856a"><td class="mdescLeft"> </td><td class="mdescRight">Get the gpio number for auxin detection. <a href="classaudio__tools_1_1_audio_board_stream.html#a3cc5bafcade54d106ec00838c30d856a">More...</a><br /></td></tr>
|
|
<tr class="separator:a3cc5bafcade54d106ec00838c30d856a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e5eda0090d3ce0d4a828ef652e10a2f"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a5e5eda0090d3ce0d4a828ef652e10a2f">pinHeadphoneDetect</a> ()</td></tr>
|
|
<tr class="memdesc:a5e5eda0090d3ce0d4a828ef652e10a2f"><td class="mdescLeft"> </td><td class="mdescRight">Get the gpio number for headphone detection. <a href="classaudio__tools_1_1_audio_board_stream.html#a5e5eda0090d3ce0d4a828ef652e10a2f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5e5eda0090d3ce0d4a828ef652e10a2f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a555009869fcf81abedba3bc24e3d7301"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a555009869fcf81abedba3bc24e3d7301">pinInputMode</a> ()</td></tr>
|
|
<tr class="memdesc:a555009869fcf81abedba3bc24e3d7301"><td class="mdescLeft"> </td><td class="mdescRight">Get the number for mode-button. <a href="classaudio__tools_1_1_audio_board_stream.html#a555009869fcf81abedba3bc24e3d7301">More...</a><br /></td></tr>
|
|
<tr class="separator:a555009869fcf81abedba3bc24e3d7301"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57da14af534ee41a579cc62071735b5a"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a57da14af534ee41a579cc62071735b5a">pinInputPlay</a> ()</td></tr>
|
|
<tr class="memdesc:a57da14af534ee41a579cc62071735b5a"><td class="mdescLeft"> </td><td class="mdescRight">Get number for play function. <a href="classaudio__tools_1_1_audio_board_stream.html#a57da14af534ee41a579cc62071735b5a">More...</a><br /></td></tr>
|
|
<tr class="separator:a57da14af534ee41a579cc62071735b5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a059d0367a1404dcf42f06cc59d73f2ce"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a059d0367a1404dcf42f06cc59d73f2ce">pinInputRec</a> ()</td></tr>
|
|
<tr class="memdesc:a059d0367a1404dcf42f06cc59d73f2ce"><td class="mdescLeft"> </td><td class="mdescRight">Get the record-button id for adc-button. <a href="classaudio__tools_1_1_audio_board_stream.html#a059d0367a1404dcf42f06cc59d73f2ce">More...</a><br /></td></tr>
|
|
<tr class="separator:a059d0367a1404dcf42f06cc59d73f2ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ebba51e0cf604b2cd32403eee279f76"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a5ebba51e0cf604b2cd32403eee279f76">pinInputSet</a> ()</td></tr>
|
|
<tr class="memdesc:a5ebba51e0cf604b2cd32403eee279f76"><td class="mdescLeft"> </td><td class="mdescRight">Get number for set function. <a href="classaudio__tools_1_1_audio_board_stream.html#a5ebba51e0cf604b2cd32403eee279f76">More...</a><br /></td></tr>
|
|
<tr class="separator:a5ebba51e0cf604b2cd32403eee279f76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3521bfe173958daec58f275c595bfdaa"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a3521bfe173958daec58f275c595bfdaa">pinLed</a> (int idx)</td></tr>
|
|
<tr class="memdesc:a3521bfe173958daec58f275c595bfdaa"><td class="mdescLeft"> </td><td class="mdescRight">Get LED pin. <a href="classaudio__tools_1_1_audio_board_stream.html#a3521bfe173958daec58f275c595bfdaa">More...</a><br /></td></tr>
|
|
<tr class="separator:a3521bfe173958daec58f275c595bfdaa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d8fcedc151202a64b809ec88d453086"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a4d8fcedc151202a64b809ec88d453086">pinPaEnable</a> ()</td></tr>
|
|
<tr class="memdesc:a4d8fcedc151202a64b809ec88d453086"><td class="mdescLeft"> </td><td class="mdescRight">Get the gpio number for PA enable. <a href="classaudio__tools_1_1_audio_board_stream.html#a4d8fcedc151202a64b809ec88d453086">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d8fcedc151202a64b809ec88d453086"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a3ff0ab05f547ca86fc651fad3e86db"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a1a3ff0ab05f547ca86fc651fad3e86db">pinVolumeDown</a> ()</td></tr>
|
|
<tr class="memdesc:a1a3ff0ab05f547ca86fc651fad3e86db"><td class="mdescLeft"> </td><td class="mdescRight">Get number for volume down function. <a href="classaudio__tools_1_1_audio_board_stream.html#a1a3ff0ab05f547ca86fc651fad3e86db">More...</a><br /></td></tr>
|
|
<tr class="separator:a1a3ff0ab05f547ca86fc651fad3e86db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac093e3552e99362d863ae2f404b5aae1"><td class="memItemLeft" align="right" valign="top">GpioPin </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#ac093e3552e99362d863ae2f404b5aae1">pinVolumeUp</a> ()</td></tr>
|
|
<tr class="memdesc:ac093e3552e99362d863ae2f404b5aae1"><td class="mdescLeft"> </td><td class="mdescRight">number for volume up function <a href="classaudio__tools_1_1_audio_board_stream.html#ac093e3552e99362d863ae2f404b5aae1">More...</a><br /></td></tr>
|
|
<tr class="separator:ac093e3552e99362d863ae2f404b5aae1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7897359154057644b97714a13fc70581"><td class="memItemLeft" align="right" valign="top"><a id="a7897359154057644b97714a13fc70581"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a7897359154057644b97714a13fc70581">processActions</a> ()</td></tr>
|
|
<tr class="memdesc:a7897359154057644b97714a13fc70581"><td class="mdescLeft"> </td><td class="mdescRight">Process input keys and pins. <br /></td></tr>
|
|
<tr class="separator:a7897359154057644b97714a13fc70581"><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_i2_s_codec_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">Reads the audio data. <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:a92f6a09fee97399e88ace3f852323f30"><td class="memItemLeft" align="right" valign="top"><a id="a92f6a09fee97399e88ace3f852323f30"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a92f6a09fee97399e88ace3f852323f30">setActive</a> (bool active)</td></tr>
|
|
<tr class="memdesc:a92f6a09fee97399e88ace3f852323f30"><td class="mdescLeft"> </td><td class="mdescRight">The oposite of <a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#aa2a08d0fd7c4e897419766a5a0ebc291" title="Mute / unmote.">setMute()</a>: setActive(true) calls setMute(false) <br /></td></tr>
|
|
<tr class="separator:a92f6a09fee97399e88ace3f852323f30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87feead15897a49c7dccb043ac9fcddc"><td class="memItemLeft" align="right" valign="top"><a id="a87feead15897a49c7dccb043ac9fcddc"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a87feead15897a49c7dccb043ac9fcddc">setAudioInfo</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
|
|
<tr class="memdesc:a87feead15897a49c7dccb043ac9fcddc"><td class="mdescLeft"> </td><td class="mdescRight">updates the sample rate dynamically <br /></td></tr>
|
|
<tr class="separator:a87feead15897a49c7dccb043ac9fcddc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65d017f0bc7d2d71d0aca07d7579ab9f"><td class="memItemLeft" align="right" valign="top"><a id="a65d017f0bc7d2d71d0aca07d7579ab9f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a65d017f0bc7d2d71d0aca07d7579ab9f">setBoard</a> (AudioBoard &<a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a6a896ab86ed22240433abf907dc6bd89">board</a>)</td></tr>
|
|
<tr class="memdesc:a65d017f0bc7d2d71d0aca07d7579ab9f"><td class="mdescLeft"> </td><td class="mdescRight">(re)defines the board <br /></td></tr>
|
|
<tr class="separator:a65d017f0bc7d2d71d0aca07d7579ab9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcc3a1029b1da044f9df36a9209b077f"><td class="memItemLeft" align="right" valign="top"><a id="abcc3a1029b1da044f9df36a9209b077f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#abcc3a1029b1da044f9df36a9209b077f">setBoard</a> (AudioBoard *<a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a6a896ab86ed22240433abf907dc6bd89">board</a>)</td></tr>
|
|
<tr class="memdesc:abcc3a1029b1da044f9df36a9209b077f"><td class="mdescLeft"> </td><td class="mdescRight">(re)defines the board <br /></td></tr>
|
|
<tr class="separator:abcc3a1029b1da044f9df36a9209b077f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2a08d0fd7c4e897419766a5a0ebc291"><td class="memItemLeft" align="right" valign="top"><a id="aa2a08d0fd7c4e897419766a5a0ebc291"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#aa2a08d0fd7c4e897419766a5a0ebc291">setMute</a> (bool mute)</td></tr>
|
|
<tr class="memdesc:aa2a08d0fd7c4e897419766a5a0ebc291"><td class="mdescLeft"> </td><td class="mdescRight">Mute / unmote. <br /></td></tr>
|
|
<tr class="separator:aa2a08d0fd7c4e897419766a5a0ebc291"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59ea4d70e5093706baadc42b6854b6ab"><td class="memItemLeft" align="right" valign="top"><a id="a59ea4d70e5093706baadc42b6854b6ab"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a59ea4d70e5093706baadc42b6854b6ab">setMute</a> (bool mute, int line)</td></tr>
|
|
<tr class="memdesc:a59ea4d70e5093706baadc42b6854b6ab"><td class="mdescLeft"> </td><td class="mdescRight">Mute / unmute of an individual line (codec) <br /></td></tr>
|
|
<tr class="separator:a59ea4d70e5093706baadc42b6854b6ab"><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:ac515c630cf8bddf7e5238601cb60393f"><td class="memItemLeft" align="right" valign="top"><a id="ac515c630cf8bddf7e5238601cb60393f"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#ac515c630cf8bddf7e5238601cb60393f">setPAPower</a> (bool active)</td></tr>
|
|
<tr class="memdesc:ac515c630cf8bddf7e5238601cb60393f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the output of the PA Power Pin. <br /></td></tr>
|
|
<tr class="separator:ac515c630cf8bddf7e5238601cb60393f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fdd798e6ae46c5c0bd4b3f42bf18220"><td class="memItemLeft" align="right" valign="top"><a id="a1fdd798e6ae46c5c0bd4b3f42bf18220"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a1fdd798e6ae46c5c0bd4b3f42bf18220">setSpeakerActive</a> (bool active)</td></tr>
|
|
<tr class="memdesc:a1fdd798e6ae46c5c0bd4b3f42bf18220"><td class="mdescLeft"> </td><td class="mdescRight">the same as <a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#ac515c630cf8bddf7e5238601cb60393f" title="Sets the output of the PA Power Pin.">setPAPower()</a> <br /></td></tr>
|
|
<tr class="separator:a1fdd798e6ae46c5c0bd4b3f42bf18220"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad593a1d6f339d68d255deca6ed148a43"><td class="memItemLeft" align="right" valign="top"><a id="ad593a1d6f339d68d255deca6ed148a43"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#ad593a1d6f339d68d255deca6ed148a43">setVolume</a> (float vol) override</td></tr>
|
|
<tr class="memdesc:ad593a1d6f339d68d255deca6ed148a43"><td class="mdescLeft"> </td><td class="mdescRight">sets the volume (range 0.0f - 1.0f) <br /></td></tr>
|
|
<tr class="separator:ad593a1d6f339d68d255deca6ed148a43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75896c16336462449610b256c8313b4c"><td class="memItemLeft" align="right" valign="top"><a id="a75896c16336462449610b256c8313b4c"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a75896c16336462449610b256c8313b4c">volume</a> () override</td></tr>
|
|
<tr class="memdesc:a75896c16336462449610b256c8313b4c"><td class="mdescLeft"> </td><td class="mdescRight">Provides the actual volume (0.0f - 1.0f) <br /></td></tr>
|
|
<tr class="separator:a75896c16336462449610b256c8313b4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="memItemLeft" align="right" valign="top"><a id="a8b8471dbbdc5527cdf9bfd31612cc973"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#a8b8471dbbdc5527cdf9bfd31612cc973">write</a> (const uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="mdescLeft"> </td><td class="mdescRight">Writes the audio data to I2S. <br /></td></tr>
|
|
<tr class="separator:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adffba128cba62b029746648f6946945c"><td class="memItemLeft" align="right" valign="top"><a id="adffba128cba62b029746648f6946945c"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t ch) override</td></tr>
|
|
<tr class="separator:adffba128cba62b029746648f6946945c"><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="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a649ac2c61ceb08c2b2290898512a413a"><td class="memItemLeft" align="right" valign="top"><a id="a649ac2c61ceb08c2b2290898512a413a"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a649ac2c61ceb08c2b2290898512a413a">actionHeadphoneDetection</a> (bool, int, void *)</td></tr>
|
|
<tr class="memdesc:a649ac2c61ceb08c2b2290898512a413a"><td class="mdescLeft"> </td><td class="mdescRight">Switch off the PA if the headphone in plugged in and switch it on again if the headphone is unplugged. This method complies with the. <br /></td></tr>
|
|
<tr class="separator:a649ac2c61ceb08c2b2290898512a413a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9124340ae513f2575531cba6e490a4db"><td class="memItemLeft" align="right" valign="top"><a id="a9124340ae513f2575531cba6e490a4db"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a9124340ae513f2575531cba6e490a4db">actionStart</a> (bool, int, void *)</td></tr>
|
|
<tr class="memdesc:a9124340ae513f2575531cba6e490a4db"><td class="mdescLeft"> </td><td class="mdescRight">Start. <br /></td></tr>
|
|
<tr class="separator:a9124340ae513f2575531cba6e490a4db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11e789f0bbb3771a9af4f1bfd3c3a33f"><td class="memItemLeft" align="right" valign="top"><a id="a11e789f0bbb3771a9af4f1bfd3c3a33f"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a11e789f0bbb3771a9af4f1bfd3c3a33f">actionStartStop</a> (bool, int, void *)</td></tr>
|
|
<tr class="memdesc:a11e789f0bbb3771a9af4f1bfd3c3a33f"><td class="mdescLeft"> </td><td class="mdescRight">Toggle start stop. <br /></td></tr>
|
|
<tr class="separator:a11e789f0bbb3771a9af4f1bfd3c3a33f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6263321578e2d73132c83b55b2ed14d"><td class="memItemLeft" align="right" valign="top"><a id="ac6263321578e2d73132c83b55b2ed14d"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#ac6263321578e2d73132c83b55b2ed14d">actionStop</a> (bool, int, void *)</td></tr>
|
|
<tr class="memdesc:ac6263321578e2d73132c83b55b2ed14d"><td class="mdescLeft"> </td><td class="mdescRight">Stop. <br /></td></tr>
|
|
<tr class="separator:ac6263321578e2d73132c83b55b2ed14d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bcf39924799e8c9b98420f82754c54f"><td class="memItemLeft" align="right" valign="top"><a id="a0bcf39924799e8c9b98420f82754c54f"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a0bcf39924799e8c9b98420f82754c54f">actionVolumeDown</a> (bool, int, void *)</td></tr>
|
|
<tr class="memdesc:a0bcf39924799e8c9b98420f82754c54f"><td class="mdescLeft"> </td><td class="mdescRight">Decrease the volume. <br /></td></tr>
|
|
<tr class="separator:a0bcf39924799e8c9b98420f82754c54f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89f3eeb9cbb93f78e8934bda2b390408"><td class="memItemLeft" align="right" valign="top"><a id="a89f3eeb9cbb93f78e8934bda2b390408"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a89f3eeb9cbb93f78e8934bda2b390408">actionVolumeUp</a> (bool, int, void *)</td></tr>
|
|
<tr class="memdesc:a89f3eeb9cbb93f78e8934bda2b390408"><td class="mdescLeft"> </td><td class="mdescRight">Increase the volume. <br /></td></tr>
|
|
<tr class="separator:a89f3eeb9cbb93f78e8934bda2b390408"><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:a6223ed9eecf9575a05e6e4b3fa23628b"><td class="memItemLeft" align="right" valign="top"><a id="a6223ed9eecf9575a05e6e4b3fa23628b"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>begin1</b> ()</td></tr>
|
|
<tr class="separator:a6223ed9eecf9575a05e6e4b3fa23628b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f9f289a2181f62b89cff6fc401c0108"><td class="memItemLeft" align="right" valign="top"><a id="a2f9f289a2181f62b89cff6fc401c0108"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>beginCodec</b> (<a class="el" href="structaudio__tools_1_1_i2_s_codec_config.html">I2SCodecConfig</a> info)</td></tr>
|
|
<tr class="separator:a2f9f289a2181f62b89cff6fc401c0108"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429791ee6aa07d099b1e2df39b688507"><td class="memItemLeft" align="right" valign="top"><a id="a429791ee6aa07d099b1e2df39b688507"></a>
|
|
AudioActions::ActiveLogic </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_board_stream.html#a429791ee6aa07d099b1e2df39b688507">getActionLogic</a> (int pin)</td></tr>
|
|
<tr class="memdesc:a429791ee6aa07d099b1e2df39b688507"><td class="mdescLeft"> </td><td class="mdescRight">Determines the action logic (ActiveLow or ActiveTouch) for the pin. <br /></td></tr>
|
|
<tr class="separator:a429791ee6aa07d099b1e2df39b688507"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab22ccce879df03e04256612fee567543"><td class="memItemLeft" align="right" valign="top"><a id="ab22ccce879df03e04256612fee567543"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>getSdCsPin</b> ()</td></tr>
|
|
<tr class="separator:ab22ccce879df03e04256612fee567543"><td class="memSeparator" colspan="2"> </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: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>
|
|
<tr class="memitem:ab488c7c7d7d3c547ff56ed932be97db9"><td class="memItemLeft" align="right" valign="top"><a id="ab488c7c7d7d3c547ff56ed932be97db9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html#ab488c7c7d7d3c547ff56ed932be97db9">setupI2SPins</a> ()</td></tr>
|
|
<tr class="memdesc:ab488c7c7d7d3c547ff56ed932be97db9"><td class="mdescLeft"> </td><td class="mdescRight">We use the board pins if they are available. <br /></td></tr>
|
|
<tr class="separator:ab488c7c7d7d3c547ff56ed932be97db9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37614d7eecdd46a38fbb79c7121818ff"><td class="memItemLeft" align="right" valign="top"><a id="a37614d7eecdd46a38fbb79c7121818ff"></a>
|
|
sample_bits_t </td><td class="memItemRight" valign="bottom"><b>toCodecBits</b> (int bits)</td></tr>
|
|
<tr class="separator:a37614d7eecdd46a38fbb79c7121818ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6df5f8fcc8e4c04e317f0a7bf8b391f"><td class="memItemLeft" align="right" valign="top"><a id="ad6df5f8fcc8e4c04e317f0a7bf8b391f"></a>
|
|
i2s_format_t </td><td class="memItemRight" valign="bottom"><b>toFormat</b> (<a class="el" href="namespaceaudio__tools.html#a720616ce211566d808f3e441f9b18cda">I2SFormat</a> fmt)</td></tr>
|
|
<tr class="separator:ad6df5f8fcc8e4c04e317f0a7bf8b391f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ade9c7359aea1b71c2c666cf77afa62"><td class="memItemLeft" align="right" valign="top"><a id="a9ade9c7359aea1b71c2c666cf77afa62"></a>
|
|
samplerate_t </td><td class="memItemRight" valign="bottom"><b>toRate</b> (int rate)</td></tr>
|
|
<tr class="separator:a9ade9c7359aea1b71c2c666cf77afa62"><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:a9ed6e0705d9742e5c354eaa51c8bcf09"><td class="memItemLeft" align="right" valign="top"><a id="a9ed6e0705d9742e5c354eaa51c8bcf09"></a>
|
|
<a class="el" href="classaudio__tools_1_1_audio_actions.html">AudioActions</a> </td><td class="memItemRight" valign="bottom"><b>actions</b></td></tr>
|
|
<tr class="separator:a9ed6e0705d9742e5c354eaa51c8bcf09"><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> = true</td></tr>
|
|
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45a1e07c9a3f22b938f9d612b51e460d"><td class="memItemLeft" align="right" valign="top"><a id="a45a1e07c9a3f22b938f9d612b51e460d"></a>
|
|
<a class="el" href="structaudio__tools_1_1_i2_s_codec_config.html">I2SCodecConfig</a> </td><td class="memItemRight" valign="bottom"><b>cfg</b></td></tr>
|
|
<tr class="separator:a45a1e07c9a3f22b938f9d612b51e460d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4296f334f4441aae57fb5f43a0b77968"><td class="memItemLeft" align="right" valign="top"><a id="a4296f334f4441aae57fb5f43a0b77968"></a>
|
|
CodecConfig </td><td class="memItemRight" valign="bottom"><b>codec_cfg</b></td></tr>
|
|
<tr class="separator:a4296f334f4441aae57fb5f43a0b77968"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86f6a759a6b9c8080d914c1aa84c243a"><td class="memItemLeft" align="right" valign="top"><a id="a86f6a759a6b9c8080d914c1aa84c243a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>headphoneIsConnected</b> = false</td></tr>
|
|
<tr class="separator:a86f6a759a6b9c8080d914c1aa84c243a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f2666dd37f8cfae1d93fb22225bd29c"><td class="memItemLeft" align="right" valign="top"><a id="a4f2666dd37f8cfae1d93fb22225bd29c"></a>
|
|
<a class="el" href="classaudio__tools_1_1_i2_s_stream.html">I2SStream</a> </td><td class="memItemRight" valign="bottom"><b>i2s</b></td></tr>
|
|
<tr class="separator:a4f2666dd37f8cfae1d93fb22225bd29c"><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:a407c3efba665d276a38229f905bef352"><td class="memItemLeft" align="right" valign="top"><a id="a407c3efba665d276a38229f905bef352"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>is_active</b> = false</td></tr>
|
|
<tr class="separator:a407c3efba665d276a38229f905bef352"><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:adfde90af42b7a3c097e59a39e385cbb3"><td class="memItemLeft" align="right" valign="top"><a id="adfde90af42b7a3c097e59a39e385cbb3"></a>
|
|
AudioBoard * </td><td class="memItemRight" valign="bottom"><b>p_board</b> = nullptr</td></tr>
|
|
<tr class="separator:adfde90af42b7a3c097e59a39e385cbb3"><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>
|
|
<tr class="memitem:a0e460a46f786cbf5771335ce4c4148f1"><td class="memItemLeft" align="right" valign="top"><a id="a0e460a46f786cbf5771335ce4c4148f1"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><b>volume_value</b> = 1.0f</td></tr>
|
|
<tr class="separator:a0e460a46f786cbf5771335ce4c4148f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>New functionality which replaces the <a class="el" href="classaudio__tools_1_1_audio_kit_stream.html" title="AudioKit Stream which uses the https://github.com/pschatzmann/arduino-audiokit library.">AudioKitStream</a> that is based on the legacy AudioKit library. This functionality uses the new arduino-audio-driver library! It is the same as <a class="el" href="classaudio__tools_1_1_i2_s_codec_stream.html" title="I2S Stream which also sets up a codec chip and i2s.">I2SCodecStream</a> extended by some <a class="el" href="classaudio__tools_1_1_audio_actions.html" title="A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...">AudioActions</a> and some method calls to determine defined pin values. See <a href="https://github.com/pschatzmann/arduino-audio-driver">https://github.com/pschatzmann/arduino-audio-driver</a>. </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 Function Documentation</h2>
|
|
<a id="a24fac46b019688e1b0993569912128a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24fac46b019688e1b0993569912128a1">◆ </a></span>addAction() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void addAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void(*)(bool, int, void *) </td>
|
|
<td class="paramname"><em>action</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">AudioActions::ActiveLogic </td>
|
|
<td class="paramname"><em>activeLogic</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>ref</em> = <code>nullptr</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Defines a new action that is executed when the indicated pin is active. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td></td></tr>
|
|
<tr><td class="paramname">action</td><td></td></tr>
|
|
<tr><td class="paramname">activeLogic</td><td></td></tr>
|
|
<tr><td class="paramname">ref</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a08e8001d4d1048b8fd9e13a5e968d453"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a08e8001d4d1048b8fd9e13a5e968d453">◆ </a></span>addAction() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void addAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void(*)(bool, int, void *) </td>
|
|
<td class="paramname"><em>action</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>ref</em> = <code>nullptr</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Defines a new action that is executed when the indicated pin is active. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td></td></tr>
|
|
<tr><td class="paramname">action</td><td></td></tr>
|
|
<tr><td class="paramname">ref</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad497d1809a653cebe8e82b625e642bb1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad497d1809a653cebe8e82b625e642bb1">◆ </a></span>headphoneStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool headphoneStatus </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if the headphone was detected. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true </dd>
|
|
<dd>
|
|
false </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a899b8192ea6dc5d7db20c57121655f58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a899b8192ea6dc5d7db20c57121655f58">◆ </a></span>incrementVolume()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void incrementVolume </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>inc</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Relative volume control. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vol</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3cc5bafcade54d106ec00838c30d856a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3cc5bafcade54d106ec00838c30d856a">◆ </a></span>pinAuxin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinAuxin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the gpio number for auxin detection. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others gpio number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e5eda0090d3ce0d4a828ef652e10a2f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e5eda0090d3ce0d4a828ef652e10a2f">◆ </a></span>pinHeadphoneDetect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinHeadphoneDetect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the gpio number for headphone detection. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others gpio number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a555009869fcf81abedba3bc24e3d7301"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a555009869fcf81abedba3bc24e3d7301">◆ </a></span>pinInputMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinInputMode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number for mode-button. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a57da14af534ee41a579cc62071735b5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57da14af534ee41a579cc62071735b5a">◆ </a></span>pinInputPlay()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinInputPlay </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number for play function. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a059d0367a1404dcf42f06cc59d73f2ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a059d0367a1404dcf42f06cc59d73f2ce">◆ </a></span>pinInputRec()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinInputRec </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the record-button id for adc-button. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others button id </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ebba51e0cf604b2cd32403eee279f76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ebba51e0cf604b2cd32403eee279f76">◆ </a></span>pinInputSet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinInputSet </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number for set function. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3521bfe173958daec58f275c595bfdaa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3521bfe173958daec58f275c595bfdaa">◆ </a></span>pinLed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinLed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>idx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get LED pin. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others gpio number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d8fcedc151202a64b809ec88d453086"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d8fcedc151202a64b809ec88d453086">◆ </a></span>pinPaEnable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinPaEnable </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the gpio number for PA enable. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others gpio number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a3ff0ab05f547ca86fc651fad3e86db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a3ff0ab05f547ca86fc651fad3e86db">◆ </a></span>pinVolumeDown()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinVolumeDown </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number for volume down function. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac093e3552e99362d863ae2f404b5aae1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac093e3552e99362d863ae2f404b5aae1">◆ </a></span>pinVolumeUp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpioPin pinVolumeUp </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>number for volume up function </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>-1 non-existent Others number </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/AudioLibs/<a class="el" href="_audio_board_stream_8h_source.html">AudioBoardStream.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>
|