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_1OutputSoundFile....

348 lines
20 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_1OutputSoundFile.html">OutputSoundFile</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_1OutputSoundFile-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::OutputSoundFile Class Reference<div class="ingroups"><a class="el" href="group__audio.html">Audio module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Provide write access to sound files.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="OutputSoundFile_8hpp_source.html">SFML/Audio/OutputSoundFile.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:a8b1952831dd7061ed189687bffebf79f" id="r_a8b1952831dd7061ed189687bffebf79f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b1952831dd7061ed189687bffebf79f">OutputSoundFile</a> ()=default</td></tr>
<tr class="memdesc:a8b1952831dd7061ed189687bffebf79f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a8b1952831dd7061ed189687bffebf79f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6367d6b6733b211b6e42a68fa7d137bd" id="r_a6367d6b6733b211b6e42a68fa7d137bd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6367d6b6733b211b6e42a68fa7d137bd">OutputSoundFile</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)</td></tr>
<tr class="memdesc:a6367d6b6733b211b6e42a68fa7d137bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the sound file from the disk for writing. <br /></td></tr>
<tr class="separator:a6367d6b6733b211b6e42a68fa7d137bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8831d62f1ffabadb8a0de24908e16a88" id="r_a8831d62f1ffabadb8a0de24908e16a88"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8831d62f1ffabadb8a0de24908e16a88">openFromFile</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)</td></tr>
<tr class="memdesc:a8831d62f1ffabadb8a0de24908e16a88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the sound file from the disk for writing. <br /></td></tr>
<tr class="separator:a8831d62f1ffabadb8a0de24908e16a88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a66a72c3e5b973ff720cfd17c0bf0b0" id="r_a1a66a72c3e5b973ff720cfd17c0bf0b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1a66a72c3e5b973ff720cfd17c0bf0b0">write</a> (const std::int16_t *samples, std::uint64_t count)</td></tr>
<tr class="memdesc:a1a66a72c3e5b973ff720cfd17c0bf0b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write audio samples to the file. <br /></td></tr>
<tr class="separator:a1a66a72c3e5b973ff720cfd17c0bf0b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad20c867d7e565d533da029f31ea5a337" id="r_ad20c867d7e565d533da029f31ea5a337"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad20c867d7e565d533da029f31ea5a337">close</a> ()</td></tr>
<tr class="memdesc:ad20c867d7e565d533da029f31ea5a337"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the current file. <br /></td></tr>
<tr class="separator:ad20c867d7e565d533da029f31ea5a337"><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>Provide write access to sound files. </p>
<p>This class encodes audio samples to a sound file.</p>
<p>It is used internally by higher-level classes such as <code><a class="el" href="classsf_1_1SoundBuffer.html" title="Storage for audio samples defining a sound.">sf::SoundBuffer</a></code>, but can also be useful if you want to create audio files from custom data sources, like generated audio samples.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// Create a sound file, ogg/vorbis format, 44100 Hz, stereo</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1OutputSoundFile.html">sf::OutputSoundFile</a> file(<span class="stringliteral">&quot;music.ogg&quot;</span>, 44100, 2, {<a class="code hl_enumvalue" href="group__audio.html#gga9800c7f3d5e7a9c9310f707b2c995ff3a3a86c1ecef856c6360b14ee920abd2d4">sf::SoundChannel::FrontLeft</a>, <a class="code hl_enumvalue" href="group__audio.html#gga9800c7f3d5e7a9c9310f707b2c995ff3a17a1a1897fa234ffd995f32ff31c4075">sf::SoundChannel::FrontRight</a>});</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">while</span> (...)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// Read or generate audio samples from your custom source</span></div>
<div class="line"> std::vector&lt;std::int16_t&gt; samples = ...;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Write them to the file</span></div>
<div class="line"> file.write(samples.data(), samples.size());</div>
<div class="line">}</div>
<div class="ttc" id="aclasssf_1_1OutputSoundFile_html"><div class="ttname"><a href="classsf_1_1OutputSoundFile.html">sf::OutputSoundFile</a></div><div class="ttdoc">Provide write access to sound files.</div><div class="ttdef"><b>Definition</b> <a href="OutputSoundFile_8hpp_source.html#l00048">OutputSoundFile.hpp:49</a></div></div>
<div class="ttc" id="agroup__audio_html_gga9800c7f3d5e7a9c9310f707b2c995ff3a17a1a1897fa234ffd995f32ff31c4075"><div class="ttname"><a href="group__audio.html#gga9800c7f3d5e7a9c9310f707b2c995ff3a17a1a1897fa234ffd995f32ff31c4075">sf::SoundChannel::FrontRight</a></div><div class="ttdeci">@ FrontRight</div></div>
<div class="ttc" id="agroup__audio_html_gga9800c7f3d5e7a9c9310f707b2c995ff3a3a86c1ecef856c6360b14ee920abd2d4"><div class="ttname"><a href="group__audio.html#gga9800c7f3d5e7a9c9310f707b2c995ff3a3a86c1ecef856c6360b14ee920abd2d4">sf::SoundChannel::FrontLeft</a></div><div class="ttdeci">@ FrontLeft</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1SoundFileWriter.html" title="Abstract base class for sound file encoding.">sf::SoundFileWriter</a></code>, <code><a class="el" href="classsf_1_1InputSoundFile.html" title="Provide read access to sound files.">sf::InputSoundFile</a></code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="OutputSoundFile_8hpp_source.html#l00048">48</a> of file <a class="el" href="OutputSoundFile_8hpp_source.html">OutputSoundFile.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8b1952831dd7061ed189687bffebf79f" name="a8b1952831dd7061ed189687bffebf79f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b1952831dd7061ed189687bffebf79f">&#9670;&#160;</a></span>OutputSoundFile() <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">sf::OutputSoundFile::OutputSoundFile </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">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>Construct an output sound file that is not associated with a file to write. </p>
</div>
</div>
<a id="a6367d6b6733b211b6e42a68fa7d137bd" name="a6367d6b6733b211b6e42a68fa7d137bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6367d6b6733b211b6e42a68fa7d137bd">&#9670;&#160;</a></span>OutputSoundFile() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::OutputSoundFile::OutputSoundFile </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>
</div><div class="memdoc">
<p>Construct the sound file from the disk for writing. </p>
<p>The supported audio formats are: WAV, OGG/Vorbis, FLAC.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Path of the sound file to write </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 in 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="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classsf_1_1Exception.html" title="Library-specific exception type.">sf::Exception</a></td><td>if the file could not be opened successfully </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad20c867d7e565d533da029f31ea5a337" name="ad20c867d7e565d533da029f31ea5a337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad20c867d7e565d533da029f31ea5a337">&#9670;&#160;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::OutputSoundFile::close </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the current file. </p>
</div>
</div>
<a id="a8831d62f1ffabadb8a0de24908e16a88" name="a8831d62f1ffabadb8a0de24908e16a88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8831d62f1ffabadb8a0de24908e16a88">&#9670;&#160;</a></span>openFromFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::OutputSoundFile::openFromFile </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the sound file from the disk for writing. </p>
<p>The supported audio formats are: WAV, OGG/Vorbis, FLAC.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Path of the sound file to write </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 in 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="a1a66a72c3e5b973ff720cfd17c0bf0b0" name="a1a66a72c3e5b973ff720cfd17c0bf0b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a66a72c3e5b973ff720cfd17c0bf0b0">&#9670;&#160;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::OutputSoundFile::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>
</div><div class="memdoc">
<p>Write audio samples to the 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="OutputSoundFile_8hpp_source.html">OutputSoundFile.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