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/classsf_1_1SoundFileWriter....

296 lines
18 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#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="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1SoundFileWriter.html">SoundFileWriter</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsf_1_1SoundFileWriter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::SoundFileWriter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__audio.html">Audio module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract base class for sound file encoding.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SoundFileWriter_8hpp_source.html">SFML/Audio/SoundFileWriter.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a566338f5ef844496209e0b6d5fdb0f0b" id="r_a566338f5ef844496209e0b6d5fdb0f0b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a566338f5ef844496209e0b6d5fdb0f0b">~SoundFileWriter</a> ()=default</td></tr>
<tr class="memdesc:a566338f5ef844496209e0b6d5fdb0f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a566338f5ef844496209e0b6d5fdb0f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48ab92439e669bd1417e0bbfbc2b44c9" id="r_a48ab92439e669bd1417e0bbfbc2b44c9"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a48ab92439e669bd1417e0bbfbc2b44c9">open</a> (const std::filesystem::path &amp;filename, unsigned int sampleRate, unsigned int channelCount, const std::vector&lt; <a class="el" href="group__audio.html#ga9800c7f3d5e7a9c9310f707b2c995ff3">SoundChannel</a> &gt; &amp;channelMap)=0</td></tr>
<tr class="memdesc:a48ab92439e669bd1417e0bbfbc2b44c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a sound file for writing. <br /></td></tr>
<tr class="separator:a48ab92439e669bd1417e0bbfbc2b44c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53c63daec28b53db4697bd4024ea3dd4" id="r_a53c63daec28b53db4697bd4024ea3dd4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53c63daec28b53db4697bd4024ea3dd4">write</a> (const std::int16_t *samples, std::uint64_t count)=0</td></tr>
<tr class="memdesc:a53c63daec28b53db4697bd4024ea3dd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write audio samples to the open file. <br /></td></tr>
<tr class="separator:a53c63daec28b53db4697bd4024ea3dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract base class for sound file encoding. </p>
<p>This class allows users to write audio file formats not natively supported by SFML, and thus extend the set of supported writable audio formats.</p>
<p>A valid sound file writer must override the open and write functions, as well as providing a static check function; the latter is used by SFML to find a suitable writer for a given filename.</p>
<p>To register a new writer, use the <code><a class="el" href="classsf_1_1SoundFileFactory.html#abb6e082ea3fedf22c8648113d1be5755" title="Register a new writer.">sf::SoundFileFactory::registerWriter</a></code> template function.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MySoundFileWriter : <span class="keyword">public</span> <a class="code hl_class" href="classsf_1_1SoundFileWriter.html">sf::SoundFileWriter</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> </div>
<div class="line"> [[nodiscard]] <span class="keyword">static</span> <span class="keywordtype">bool</span> check(<span class="keyword">const</span> std::filesystem::path&amp; filename)</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">// typically, check the extension</span></div>
<div class="line"> <span class="comment">// return true if the writer can handle the format</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="#a48ab92439e669bd1417e0bbfbc2b44c9">open</a>(<span class="keyword">const</span> std::filesystem::path&amp; filename, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channelCount, <span class="keyword">const</span> std::vector&lt;SoundChannel&gt;&amp; channelMap)<span class="keyword"> override</span></div>
<div class="line"><span class="keyword"> </span>{</div>
<div class="line"> <span class="comment">// open the file &#39;filename&#39; for writing,</span></div>
<div class="line"> <span class="comment">// write the given sample rate and channel count to the file header</span></div>
<div class="line"> <span class="comment">// return true on success</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordtype">void</span> <a class="code hl_function" href="#a53c63daec28b53db4697bd4024ea3dd4">write</a>(<span class="keyword">const</span> std::int16_t* samples, std::uint64_t count)<span class="keyword"> override</span></div>
<div class="line"><span class="keyword"> </span>{</div>
<div class="line"> <span class="comment">// write &#39;count&#39; samples stored at address &#39;samples&#39;,</span></div>
<div class="line"> <span class="comment">// convert them (for example to normalized float) if the format requires it</span></div>
<div class="line"> }</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><a class="code hl_function" href="classsf_1_1SoundFileFactory.html#abb6e082ea3fedf22c8648113d1be5755">sf::SoundFileFactory::registerWriter&lt;MySoundFileWriter&gt;</a>();</div>
<div class="ttc" id="aclasssf_1_1SoundFileFactory_html_abb6e082ea3fedf22c8648113d1be5755"><div class="ttname"><a href="classsf_1_1SoundFileFactory.html#abb6e082ea3fedf22c8648113d1be5755">sf::SoundFileFactory::registerWriter</a></div><div class="ttdeci">static void registerWriter()</div><div class="ttdoc">Register a new writer.</div></div>
<div class="ttc" id="aclasssf_1_1SoundFileWriter_html"><div class="ttname"><a href="classsf_1_1SoundFileWriter.html">sf::SoundFileWriter</a></div><div class="ttdoc">Abstract base class for sound file encoding.</div><div class="ttdef"><b>Definition</b> <a href="SoundFileWriter_8hpp_source.html#l00046">SoundFileWriter.hpp:47</a></div></div>
<div class="ttc" id="aclasssf_1_1SoundFileWriter_html_a48ab92439e669bd1417e0bbfbc2b44c9"><div class="ttname"><a href="#a48ab92439e669bd1417e0bbfbc2b44c9">sf::SoundFileWriter::open</a></div><div class="ttdeci">virtual bool open(const std::filesystem::path &amp;filename, unsigned int sampleRate, unsigned int channelCount, const std::vector&lt; SoundChannel &gt; &amp;channelMap)=0</div><div class="ttdoc">Open a sound file for writing.</div></div>
<div class="ttc" id="aclasssf_1_1SoundFileWriter_html_a53c63daec28b53db4697bd4024ea3dd4"><div class="ttname"><a href="#a53c63daec28b53db4697bd4024ea3dd4">sf::SoundFileWriter::write</a></div><div class="ttdeci">virtual void write(const std::int16_t *samples, std::uint64_t count)=0</div><div class="ttdoc">Write audio samples to the open file.</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1OutputSoundFile.html" title="Provide write access to sound files.">sf::OutputSoundFile</a></code>, <code><a class="el" href="classsf_1_1SoundFileFactory.html" title="Manages and instantiates sound file readers and writers.">sf::SoundFileFactory</a></code>, <code><a class="el" href="classsf_1_1SoundFileReader.html" title="Abstract base class for sound file decoding.">sf::SoundFileReader</a></code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="SoundFileWriter_8hpp_source.html#l00046">46</a> of file <a class="el" href="SoundFileWriter_8hpp_source.html">SoundFileWriter.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a566338f5ef844496209e0b6d5fdb0f0b" name="a566338f5ef844496209e0b6d5fdb0f0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a566338f5ef844496209e0b6d5fdb0f0b">&#9670;&#160;</a></span>~SoundFileWriter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual sf::SoundFileWriter::~SoundFileWriter </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a48ab92439e669bd1417e0bbfbc2b44c9" name="a48ab92439e669bd1417e0bbfbc2b44c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48ab92439e669bd1417e0bbfbc2b44c9">&#9670;&#160;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool sf::SoundFileWriter::open </td>
<td>(</td>
<td class="paramtype">const std::filesystem::path &amp;</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>sampleRate</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>channelCount</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="group__audio.html#ga9800c7f3d5e7a9c9310f707b2c995ff3">SoundChannel</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>channelMap</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a sound file for writing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Path of the file to open </td></tr>
<tr><td class="paramname">sampleRate</td><td>Sample rate of the sound </td></tr>
<tr><td class="paramname">channelCount</td><td>Number of channels of the sound </td></tr>
<tr><td class="paramname">channelMap</td><td>Map of position in sample frame to sound channel</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the file was successfully opened </dd></dl>
</div>
</div>
<a id="a53c63daec28b53db4697bd4024ea3dd4" name="a53c63daec28b53db4697bd4024ea3dd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53c63daec28b53db4697bd4024ea3dd4">&#9670;&#160;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void sf::SoundFileWriter::write </td>
<td>(</td>
<td class="paramtype">const std::int16_t *</td> <td class="paramname"><span class="paramname"><em>samples</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::uint64_t</td> <td class="paramname"><span class="paramname"><em>count</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write audio samples to the open file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">samples</td><td>Pointer to the sample array to write </td></tr>
<tr><td class="paramname">count</td><td>Number of samples to write </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SoundFileWriter_8hpp_source.html">SoundFileWriter.hpp</a></li>
</ul>
</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