mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
205 lines
16 KiB
HTML
205 lines
16 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: File 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_file.html">File</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classaudio__tools_1_1_file-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">File Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Arduino <a class="el" href="classaudio__tools_1_1_file.html" title="Arduino File support using std::fstream.">File</a> support using std::fstream.
|
|
<a href="classaudio__tools_1_1_file.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_file_8h_source.html">File.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for File:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaudio__tools_1_1_file.png" usemap="#File_map" alt=""/>
|
|
<map id="File_map" name="File_map">
|
|
<area href="classaudio__tools_1_1_stream.html" alt="Stream" shape="rect" coords="0,56,51,80"/>
|
|
<area href="classaudio__tools_1_1_print.html" alt="Print" shape="rect" coords="0,0,51,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:a41f524a51f39c5e9a8d868ae0dc499fb"><td class="memItemLeft" align="right" valign="top"><a id="a41f524a51f39c5e9a8d868ae0dc499fb"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>File</b> (const char *fn)</td></tr>
|
|
<tr class="separator:a41f524a51f39c5e9a8d868ae0dc499fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b8b899790d7bf615f7c494f8c1fd40c"><td class="memItemLeft" align="right" valign="top"><a id="a5b8b899790d7bf615f7c494f8c1fd40c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>File</b> (const <a class="el" href="classaudio__tools_1_1_file.html">File</a> &file)</td></tr>
|
|
<tr class="separator:a5b8b899790d7bf615f7c494f8c1fd40c"><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"><b>available</b> () override</td></tr>
|
|
<tr class="separator:afbb59a2f946191d7cf2a5c0a00b29ec2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a473a08fbb41a997860a55213bc367d44"><td class="memItemLeft" align="right" valign="top"><a id="a473a08fbb41a997860a55213bc367d44"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>availableForWrite</b> ()</td></tr>
|
|
<tr class="separator:a473a08fbb41a997860a55213bc367d44"><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:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top"><a id="a5ae591df94fc66ccb85cbb6565368bca"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>close</b> ()</td></tr>
|
|
<tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><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"><b>flush</b> () override</td></tr>
|
|
<tr class="separator:af654b48544c195ab99fe27e7bc3ed5fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c4da4b626748f746b1f9fdbe885edfb"><td class="memItemLeft" align="right" valign="top"><a id="a8c4da4b626748f746b1f9fdbe885edfb"></a>
|
|
const char * </td><td class="memItemRight" valign="bottom"><b>name</b> () const</td></tr>
|
|
<tr class="separator:a8c4da4b626748f746b1f9fdbe885edfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b4be40390e93530c80dc8da005d2d11"><td class="memItemLeft" align="right" valign="top"><a id="a2b4be40390e93530c80dc8da005d2d11"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>open</b> (const char *name, FileMode mode)</td></tr>
|
|
<tr class="separator:a2b4be40390e93530c80dc8da005d2d11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b3baad8c612d81b96e46f84d7e97580"><td class="memItemLeft" align="right" valign="top"><a id="a9b3baad8c612d81b96e46f84d7e97580"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
|
|
<tr class="separator:a9b3baad8c612d81b96e46f84d7e97580"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb5fbdfe649ad7e5430423941a694213"><td class="memItemLeft" align="right" valign="top"><a id="adb5fbdfe649ad7e5430423941a694213"></a>
|
|
<a class="el" href="classaudio__tools_1_1_file.html">File</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classaudio__tools_1_1_file.html">File</a> file)</td></tr>
|
|
<tr class="separator:adb5fbdfe649ad7e5430423941a694213"><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"><b>peek</b> () override</td></tr>
|
|
<tr class="separator:a9bb6daa18ee5d207a6f2e1899eaadcf3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d39891dc26047fc48de2cccf5201ff9"><td class="memItemLeft" align="right" valign="top"><a id="a3d39891dc26047fc48de2cccf5201ff9"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>position</b> ()</td></tr>
|
|
<tr class="separator:a3d39891dc26047fc48de2cccf5201ff9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf615f356ee21621e33812719a29d287"><td class="memItemLeft" align="right" valign="top"><a id="acf615f356ee21621e33812719a29d287"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>print</b> (const char *str)</td></tr>
|
|
<tr class="separator:acf615f356ee21621e33812719a29d287"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add75a16f89ba1ce195aff531576b3c07"><td class="memItemLeft" align="right" valign="top"><a id="add75a16f89ba1ce195aff531576b3c07"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>print</b> (int number)</td></tr>
|
|
<tr class="separator:add75a16f89ba1ce195aff531576b3c07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a972979691b2304ae53d742c16acdb88b"><td class="memItemLeft" align="right" valign="top"><a id="a972979691b2304ae53d742c16acdb88b"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>println</b> (const char *str="")</td></tr>
|
|
<tr class="separator:a972979691b2304ae53d742c16acdb88b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accc8b6940d71f66e605c519eb29aa6ba"><td class="memItemLeft" align="right" valign="top"><a id="accc8b6940d71f66e605c519eb29aa6ba"></a>
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>println</b> (int number)</td></tr>
|
|
<tr class="separator:accc8b6940d71f66e605c519eb29aa6ba"><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"><b>read</b> () override</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"><b>readBytes</b> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="separator:a6406b16cb31ad79201459cb48b1ad6f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c4781efd8e7b6964e9f68f08fa7add8"><td class="memItemLeft" align="right" valign="top"><a id="a5c4781efd8e7b6964e9f68f08fa7add8"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>seek</b> (uint32_t pos)</td></tr>
|
|
<tr class="separator:a5c4781efd8e7b6964e9f68f08fa7add8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72cd1d032b9d1c72082bca179dbf4bac"><td class="memItemLeft" align="right" valign="top"><a id="a72cd1d032b9d1c72082bca179dbf4bac"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>seek</b> (uint32_t pos, SeekMode mode)</td></tr>
|
|
<tr class="separator:a72cd1d032b9d1c72082bca179dbf4bac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a259cb5a711406a8c3e5d937eb9350cca"><td class="memItemLeft" align="right" valign="top"><a id="a259cb5a711406a8c3e5d937eb9350cca"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
|
|
<tr class="separator:a259cb5a711406a8c3e5d937eb9350cca"><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"><b>write</b> (const uint8_t *data, size_t len)</td></tr>
|
|
<tr class="separator:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85c020ed77cdebe61109186d47a9e1e8"><td class="memItemLeft" align="right" valign="top"><a id="a85c020ed77cdebe61109186d47a9e1e8"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (int32_t value)</td></tr>
|
|
<tr class="separator:a85c020ed77cdebe61109186d47a9e1e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8ae904f28d22b165f3b775128e8528c"><td class="memItemLeft" align="right" valign="top"><a id="af8ae904f28d22b165f3b775128e8528c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t *str, int len)</td></tr>
|
|
<tr class="separator:af8ae904f28d22b165f3b775128e8528c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adaf6dbd5580928622fa2f00d889bbaf8"><td class="memItemLeft" align="right" valign="top"><a id="adaf6dbd5580928622fa2f00d889bbaf8"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t value) override</td></tr>
|
|
<tr class="separator:adaf6dbd5580928622fa2f00d889bbaf8"><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:a1c9143d8a093d86ff6c083a6b6adcdb9"><td class="memItemLeft" align="right" valign="top"><a id="a1c9143d8a093d86ff6c083a6b6adcdb9"></a>
|
|
const char * </td><td class="memItemRight" valign="bottom"><b>file_path</b> =nullptr</td></tr>
|
|
<tr class="separator:a1c9143d8a093d86ff6c083a6b6adcdb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ee5fcf67bbc32487bc8d661b07e7811"><td class="memItemLeft" align="right" valign="top"><a id="a8ee5fcf67bbc32487bc8d661b07e7811"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>is_read</b> =true</td></tr>
|
|
<tr class="separator:a8ee5fcf67bbc32487bc8d661b07e7811"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8858ebba853bebec63897a055877c296"><td class="memItemLeft" align="right" valign="top"><a id="a8858ebba853bebec63897a055877c296"></a>
|
|
std::fstream </td><td class="memItemRight" valign="bottom"><b>stream</b></td></tr>
|
|
<tr class="separator:a8858ebba853bebec63897a055877c296"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Arduino <a class="el" href="classaudio__tools_1_1_file.html" title="Arduino File support using std::fstream.">File</a> support using std::fstream. </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><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/AudioLibs/Desktop/<a class="el" href="_file_8h_source.html">File.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>
|