joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/InputSoundFile_8hpp_source....

250 lines
33 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c0a853e81d6f1c1f0a3eb7a27dc24256.html">SFML</a></li><li class="navelem"><a class="el" href="dir_dd49ddb3ba8035e4a328f8c5f31cda7e.html">Audio</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">InputSoundFile.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="InputSoundFile_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">//</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// This software is provided &#39;as-is&#39;, without any express or implied warranty.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">//</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">//</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">//</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// and must not be misrepresented as being the original software.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">//</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">//</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// Headers</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;<a class="code" href="Audio_2Export_8hpp.html">SFML/Audio/Export.hpp</a>&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include &lt;<a class="code" href="SoundFileReader_8hpp.html">SFML/Audio/SoundFileReader.hpp</a>&gt;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include &lt;filesystem&gt;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#include &lt;cstddef&gt;</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacesf.html">sf</a></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>{</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keyword">class </span>Time;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keyword">class </span>InputStream;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="foldopen" id="foldopen00051" data-start="{" data-end="};">
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html"> 51</a></span><span class="keyword">class </span><a class="code hl_define" href="Audio_2Export_8hpp.html#a4d34c0f253824ac49bdd93545913eb89">SFML_AUDIO_API</a> <a class="code hl_class" href="classsf_1_1InputSoundFile.html">InputSoundFile</a></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>{</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a656b5b198b7fc216915989b05b6ae51e"> 61</a></span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a656b5b198b7fc216915989b05b6ae51e">InputSoundFile</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a0729e8109a29eed7d844294ce254e137"> 79</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a0729e8109a29eed7d844294ce254e137">InputSoundFile</a>(<span class="keyword">const</span> std::filesystem::path&amp; filename);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a3d893678827ac5b81012656978243707"> 93</a></span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a3d893678827ac5b81012656978243707">InputSoundFile</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t sizeInBytes);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a95c3344624ab189e38f5b69333bf4076"> 106</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a95c3344624ab189e38f5b69333bf4076">InputSoundFile</a>(<a class="code hl_class" href="classsf_1_1InputStream.html">InputStream</a>&amp; stream);</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a4ca76fd9f563158d462bef20c6ed09cc"> 124</a></span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a4ca76fd9f563158d462bef20c6ed09cc">openFromFile</a>(<span class="keyword">const</span> std::filesystem::path&amp; filename);</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a4e034a8e9e69ca3c33a3f11180250400"> 138</a></span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a4e034a8e9e69ca3c33a3f11180250400">openFromMemory</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t sizeInBytes);</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a32b76497aeb088a2b46dc6efd819b909"> 151</a></span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a32b76497aeb088a2b46dc6efd819b909">openFromStream</a>(<a class="code hl_class" href="classsf_1_1InputStream.html">InputStream</a>&amp; stream);</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a5516ece930e7d1923ad19a8b3750e4f8"> 159</a></span> [[nodiscard]] std::uint64_t <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a5516ece930e7d1923ad19a8b3750e4f8">getSampleCount</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a54307c308ba05dea63aba54a29c804a4"> 167</a></span> [[nodiscard]] <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a54307c308ba05dea63aba54a29c804a4">getChannelCount</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a6b8177e40dd8020752f6d52f96b774c3"> 175</a></span> [[nodiscard]] <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a6b8177e40dd8020752f6d52f96b774c3">getSampleRate</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#aa1ec832743a0dfcc4f72caca77d8d5c5"> 188</a></span> [[nodiscard]] <span class="keyword">const</span> std::vector&lt;SoundChannel&gt;&amp; <a class="code hl_function" href="classsf_1_1InputSoundFile.html#aa1ec832743a0dfcc4f72caca77d8d5c5">getChannelMap</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#aa081bd4d9732408d10b48227a360778e"> 199</a></span> [[nodiscard]] <a class="code hl_class" href="classsf_1_1Time.html">Time</a> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#aa081bd4d9732408d10b48227a360778e">getDuration</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#ad1a2238acb734d8b1144ecd75cccc2e7"> 207</a></span> [[nodiscard]] <a class="code hl_class" href="classsf_1_1Time.html">Time</a> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#ad1a2238acb734d8b1144ecd75cccc2e7">getTimeOffset</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> </div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a861013e6105643881596dbaeffdb1ca2"> 215</a></span> [[nodiscard]] std::uint64_t <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a861013e6105643881596dbaeffdb1ca2">getSampleOffset</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#afc98f7c941fbac7c2c0f697014b03b92"> 234</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#afc98f7c941fbac7c2c0f697014b03b92">seek</a>(std::uint64_t sampleOffset);</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#a8eee7af58ad75ddc61f93ad72e2d66c1"> 248</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#a8eee7af58ad75ddc61f93ad72e2d66c1">seek</a>(<a class="code hl_class" href="classsf_1_1Time.html">Time</a> timeOffset);</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> </div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#ace52e5a9baca072799366cb181a70280"> 259</a></span> [[nodiscard]] std::uint64_t <a class="code hl_function" href="classsf_1_1InputSoundFile.html#ace52e5a9baca072799366cb181a70280">read</a>(std::int16_t* samples, std::uint64_t maxCount);</div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span> </div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"><a class="line" href="classsf_1_1InputSoundFile.html#ad28182aea9dc9f7d0dfc7f78691825b4"> 265</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classsf_1_1InputSoundFile.html#ad28182aea9dc9f7d0dfc7f78691825b4">close</a>();</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> </div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span> <span class="keyword">struct </span><a class="code hl_define" href="Audio_2Export_8hpp.html#a4d34c0f253824ac49bdd93545913eb89">SFML_AUDIO_API</a> StreamDeleter</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> {</div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span> StreamDeleter(<span class="keywordtype">bool</span> theOwned);</div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> </div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> <span class="comment">// To accept ownership transfer from usual std::unique_ptr&lt;T&gt;</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> StreamDeleter(<span class="keyword">const</span> std::default_delete&lt;T&gt;&amp;);</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> </div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> <span class="keywordtype">void</span> operator()(<a class="code hl_class" href="classsf_1_1InputStream.html">InputStream</a>* ptr) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span> </div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> <span class="keywordtype">bool</span> owned{<span class="keyword">true</span>};</div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> };</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> </div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span> <span class="comment">// Member data</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> std::unique_ptr&lt;SoundFileReader&gt; m_reader; </div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span> std::unique_ptr&lt;InputStream, StreamDeleter&gt; m_stream{<span class="keyword">nullptr</span>, <span class="keyword">false</span>}; </div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span> std::uint64_t m_sampleOffset{}; </div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno"> 291</span> std::uint64_t m_sampleCount{}; </div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno"> 292</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_sampleRate{}; </div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span> std::vector&lt;SoundChannel&gt; m_channelMap; </div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno"> 294</span>};</div>
</div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno"> 295</span> </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span>} <span class="comment">// namespace sf</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span> </div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno"> 298</span> </div>
<div class="ttc" id="aAudio_2Export_8hpp_html"><div class="ttname"><a href="Audio_2Export_8hpp.html">Export.hpp</a></div></div>
<div class="ttc" id="aAudio_2Export_8hpp_html_a4d34c0f253824ac49bdd93545913eb89"><div class="ttname"><a href="Audio_2Export_8hpp.html#a4d34c0f253824ac49bdd93545913eb89">SFML_AUDIO_API</a></div><div class="ttdeci">#define SFML_AUDIO_API</div><div class="ttdef"><b>Definition</b> <a href="Audio_2Export_8hpp_source.html#l00042">Audio/Export.hpp:42</a></div></div>
<div class="ttc" id="aSoundFileReader_8hpp_html"><div class="ttname"><a href="SoundFileReader_8hpp.html">SoundFileReader.hpp</a></div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html"><div class="ttname"><a href="classsf_1_1InputSoundFile.html">sf::InputSoundFile</a></div><div class="ttdoc">Provide read access to sound files.</div><div class="ttdef"><b>Definition</b> <a href="#l00051">InputSoundFile.hpp:52</a></div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a0729e8109a29eed7d844294ce254e137"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a0729e8109a29eed7d844294ce254e137">sf::InputSoundFile::InputSoundFile</a></div><div class="ttdeci">InputSoundFile(const std::filesystem::path &amp;filename)</div><div class="ttdoc">Construct a sound file from the disk for reading.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a32b76497aeb088a2b46dc6efd819b909"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a32b76497aeb088a2b46dc6efd819b909">sf::InputSoundFile::openFromStream</a></div><div class="ttdeci">bool openFromStream(InputStream &amp;stream)</div><div class="ttdoc">Open a sound file from a custom stream for reading.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a3d893678827ac5b81012656978243707"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a3d893678827ac5b81012656978243707">sf::InputSoundFile::InputSoundFile</a></div><div class="ttdeci">InputSoundFile(const void *data, std::size_t sizeInBytes)</div><div class="ttdoc">Construct a sound file in memory for reading.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a4ca76fd9f563158d462bef20c6ed09cc"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a4ca76fd9f563158d462bef20c6ed09cc">sf::InputSoundFile::openFromFile</a></div><div class="ttdeci">bool openFromFile(const std::filesystem::path &amp;filename)</div><div class="ttdoc">Open a sound file from the disk for reading.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a4e034a8e9e69ca3c33a3f11180250400"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a4e034a8e9e69ca3c33a3f11180250400">sf::InputSoundFile::openFromMemory</a></div><div class="ttdeci">bool openFromMemory(const void *data, std::size_t sizeInBytes)</div><div class="ttdoc">Open a sound file in memory for reading.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a54307c308ba05dea63aba54a29c804a4"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a54307c308ba05dea63aba54a29c804a4">sf::InputSoundFile::getChannelCount</a></div><div class="ttdeci">unsigned int getChannelCount() const</div><div class="ttdoc">Get the number of channels used by the sound.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a5516ece930e7d1923ad19a8b3750e4f8"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a5516ece930e7d1923ad19a8b3750e4f8">sf::InputSoundFile::getSampleCount</a></div><div class="ttdeci">std::uint64_t getSampleCount() const</div><div class="ttdoc">Get the total number of audio samples in the file.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a656b5b198b7fc216915989b05b6ae51e"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a656b5b198b7fc216915989b05b6ae51e">sf::InputSoundFile::InputSoundFile</a></div><div class="ttdeci">InputSoundFile()=default</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a6b8177e40dd8020752f6d52f96b774c3"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a6b8177e40dd8020752f6d52f96b774c3">sf::InputSoundFile::getSampleRate</a></div><div class="ttdeci">unsigned int getSampleRate() const</div><div class="ttdoc">Get the sample rate of the sound.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a861013e6105643881596dbaeffdb1ca2"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a861013e6105643881596dbaeffdb1ca2">sf::InputSoundFile::getSampleOffset</a></div><div class="ttdeci">std::uint64_t getSampleOffset() const</div><div class="ttdoc">Get the read offset of the file in samples.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a8eee7af58ad75ddc61f93ad72e2d66c1"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a8eee7af58ad75ddc61f93ad72e2d66c1">sf::InputSoundFile::seek</a></div><div class="ttdeci">void seek(Time timeOffset)</div><div class="ttdoc">Change the current read position to the given time offset.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_a95c3344624ab189e38f5b69333bf4076"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#a95c3344624ab189e38f5b69333bf4076">sf::InputSoundFile::InputSoundFile</a></div><div class="ttdeci">InputSoundFile(InputStream &amp;stream)</div><div class="ttdoc">Construct a sound file from a custom stream for reading.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_aa081bd4d9732408d10b48227a360778e"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#aa081bd4d9732408d10b48227a360778e">sf::InputSoundFile::getDuration</a></div><div class="ttdeci">Time getDuration() const</div><div class="ttdoc">Get the total duration of the sound file.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_aa1ec832743a0dfcc4f72caca77d8d5c5"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#aa1ec832743a0dfcc4f72caca77d8d5c5">sf::InputSoundFile::getChannelMap</a></div><div class="ttdeci">const std::vector&lt; SoundChannel &gt; &amp; getChannelMap() const</div><div class="ttdoc">Get the map of position in sample frame to sound channel.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_ace52e5a9baca072799366cb181a70280"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#ace52e5a9baca072799366cb181a70280">sf::InputSoundFile::read</a></div><div class="ttdeci">std::uint64_t read(std::int16_t *samples, std::uint64_t maxCount)</div><div class="ttdoc">Read audio samples from the open file.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_ad1a2238acb734d8b1144ecd75cccc2e7"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#ad1a2238acb734d8b1144ecd75cccc2e7">sf::InputSoundFile::getTimeOffset</a></div><div class="ttdeci">Time getTimeOffset() const</div><div class="ttdoc">Get the read offset of the file in time.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_ad28182aea9dc9f7d0dfc7f78691825b4"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#ad28182aea9dc9f7d0dfc7f78691825b4">sf::InputSoundFile::close</a></div><div class="ttdeci">void close()</div><div class="ttdoc">Close the current file.</div></div>
<div class="ttc" id="aclasssf_1_1InputSoundFile_html_afc98f7c941fbac7c2c0f697014b03b92"><div class="ttname"><a href="classsf_1_1InputSoundFile.html#afc98f7c941fbac7c2c0f697014b03b92">sf::InputSoundFile::seek</a></div><div class="ttdeci">void seek(std::uint64_t sampleOffset)</div><div class="ttdoc">Change the current read position to the given sample offset.</div></div>
<div class="ttc" id="aclasssf_1_1InputStream_html"><div class="ttname"><a href="classsf_1_1InputStream.html">sf::InputStream</a></div><div class="ttdoc">Abstract class for custom file input streams.</div><div class="ttdef"><b>Definition</b> <a href="InputStream_8hpp_source.html#l00045">InputStream.hpp:46</a></div></div>
<div class="ttc" id="aclasssf_1_1Time_html"><div class="ttname"><a href="classsf_1_1Time.html">sf::Time</a></div><div class="ttdoc">Represents a time value.</div><div class="ttdef"><b>Definition</b> <a href="Time_8hpp_source.html#l00041">Time.hpp:42</a></div></div>
<div class="ttc" id="anamespacesf_html"><div class="ttname"><a href="namespacesf.html">sf</a></div><div class="ttdef"><b>Definition</b> <a href="AudioResource_8hpp_source.html#l00035">AudioResource.hpp:36</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink