blob: 5277672ba0ca9b0d8fa3414eae6eced2293d7bb5 [file]
<!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>32blit API: blit::WavStream 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">32blit API
</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&amp;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&amp;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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classblit_1_1WavStream.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classblit_1_1WavStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">blit::WavStream Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aab2bc21a4f098a5cda42e2da7006eb50"><td class="memItemLeft" align="right" valign="top"><a id="aab2bc21a4f098a5cda42e2da7006eb50"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>PlayFlags</b> { <b>from_start</b> = (1 &lt;&lt; 0)
, <b>loop</b> = (1 &lt;&lt; 1)
}</td></tr>
<tr class="separator:aab2bc21a4f098a5cda42e2da7006eb50"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a3f8fe45ddea1a38509c72acd08369daa"><td class="memItemLeft" align="right" valign="top"><a id="a3f8fe45ddea1a38509c72acd08369daa"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>load</b> (std::string filename)</td></tr>
<tr class="separator:a3f8fe45ddea1a38509c72acd08369daa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a078cc471e394a7ac8c680ed9c1c98056"><td class="memItemLeft" align="right" valign="top"><a id="a078cc471e394a7ac8c680ed9c1c98056"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>play</b> (int channel, int flags=0)</td></tr>
<tr class="separator:a078cc471e394a7ac8c680ed9c1c98056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ac58e9f505f34f5f5179557419771c7"><td class="memItemLeft" align="right" valign="top"><a id="a3ac58e9f505f34f5f5179557419771c7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>pause</b> ()</td></tr>
<tr class="separator:a3ac58e9f505f34f5f5179557419771c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78a4302fcef74c1603bd17c2f12213d1"><td class="memItemLeft" align="right" valign="top"><a id="a78a4302fcef74c1603bd17c2f12213d1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>restart</b> ()</td></tr>
<tr class="separator:a78a4302fcef74c1603bd17c2f12213d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af29e6ec1e4011f35abaa18f88847cd5a"><td class="memItemLeft" align="right" valign="top"><a id="af29e6ec1e4011f35abaa18f88847cd5a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>get_playing</b> () const</td></tr>
<tr class="separator:af29e6ec1e4011f35abaa18f88847cd5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf124fcfc2928c2035a25869ac7cc61c"><td class="memItemLeft" align="right" valign="top"><a id="acf124fcfc2928c2035a25869ac7cc61c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>get_play_flags</b> () const</td></tr>
<tr class="separator:acf124fcfc2928c2035a25869ac7cc61c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a899bd6e039a44185a20a4d7e0078d7a6"><td class="memItemLeft" align="right" valign="top"><a id="a899bd6e039a44185a20a4d7e0078d7a6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>update</b> ()</td></tr>
<tr class="separator:a899bd6e039a44185a20a4d7e0078d7a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bb713393320f5f6c6f9f963e9525aa1"><td class="memItemLeft" align="right" valign="top"><a id="a6bb713393320f5f6c6f9f963e9525aa1"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>get_current_sample</b> () const</td></tr>
<tr class="separator:a6bb713393320f5f6c6f9f963e9525aa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30269e0d56166c70415e8cf62c9fc47e"><td class="memItemLeft" align="right" valign="top"><a id="a30269e0d56166c70415e8cf62c9fc47e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>get_duration_ms</b> () const</td></tr>
<tr class="separator:a30269e0d56166c70415e8cf62c9fc47e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>audio/<a class="el" href="wav-stream_8hpp_source.html">wav-stream.hpp</a></li>
<li>audio/wav-stream.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceblit.html">blit</a></li><li class="navelem"><a class="el" href="classblit_1_1WavStream.html">WavStream</a></li>
<li class="footer">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 </li>
</ul>
</div>
</body>
</html>