<!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;"/> <meta charset="utf-8"/> <!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>--> <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> </head> <body> <div id="banner-container"> <div id="banner"> <span id="sfml">SFML 2.5.1</span> </div> </div> <div id="content"> <!-- Generated by Doxygen 1.8.14 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</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> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>sf</b></li><li class="navelem"><a class="el" href="classsf_1_1OutputSoundFile.html">OutputSoundFile</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <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="classsf_1_1OutputSoundFile.html#details">More...</a></p> <p><code>#include <<a class="el" href="OutputSoundFile_8hpp_source.html">OutputSoundFile.hpp</a>></code></p> <div class="dynheader"> Inheritance diagram for sf::OutputSoundFile:</div> <div class="dyncontent"> <div class="center"> <img src="classsf_1_1OutputSoundFile.png" usemap="#sf::OutputSoundFile_map" alt=""/> <map id="sf::OutputSoundFile_map" name="sf::OutputSoundFile_map"> <area href="classsf_1_1NonCopyable.html" title="Utility class that makes any derived class non-copyable. " alt="sf::NonCopyable" shape="rect" coords="0,0,122,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:a7ae9f2dbd0991fa9394726a3d58bb19e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1OutputSoundFile.html#a7ae9f2dbd0991fa9394726a3d58bb19e">OutputSoundFile</a> ()</td></tr> <tr class="memdesc:a7ae9f2dbd0991fa9394726a3d58bb19e"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a7ae9f2dbd0991fa9394726a3d58bb19e">More...</a><br /></td></tr> <tr class="separator:a7ae9f2dbd0991fa9394726a3d58bb19e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1492adbfef1f391d720afb56f068182e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1OutputSoundFile.html#a1492adbfef1f391d720afb56f068182e">~OutputSoundFile</a> ()</td></tr> <tr class="memdesc:a1492adbfef1f391d720afb56f068182e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a1492adbfef1f391d720afb56f068182e">More...</a><br /></td></tr> <tr class="separator:a1492adbfef1f391d720afb56f068182e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae5e55f01c53c1422c44eaed2eed67fce"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1OutputSoundFile.html#ae5e55f01c53c1422c44eaed2eed67fce">openFromFile</a> (const std::string &filename, unsigned int sampleRate, unsigned int channelCount)</td></tr> <tr class="memdesc:ae5e55f01c53c1422c44eaed2eed67fce"><td class="mdescLeft"> </td><td class="mdescRight">Open the sound file from the disk for writing. <a href="#ae5e55f01c53c1422c44eaed2eed67fce">More...</a><br /></td></tr> <tr class="separator:ae5e55f01c53c1422c44eaed2eed67fce"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adfcf525fced71121f336fa89faac3d67"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1OutputSoundFile.html#adfcf525fced71121f336fa89faac3d67">write</a> (const Int16 *samples, Uint64 count)</td></tr> <tr class="memdesc:adfcf525fced71121f336fa89faac3d67"><td class="mdescLeft"> </td><td class="mdescRight">Write audio samples to the file. <a href="#adfcf525fced71121f336fa89faac3d67">More...</a><br /></td></tr> <tr class="separator:adfcf525fced71121f336fa89faac3d67"><td class="memSeparator" colspan="2"> </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 <a class="el" href="classsf_1_1SoundBuffer.html" title="Storage for audio samples defining a sound. ">sf::SoundBuffer</a>, 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" href="classsf_1_1OutputSoundFile.html">sf::OutputSoundFile</a> file;</div><div class="line"><span class="keywordflow">if</span> (!file.<a class="code" href="classsf_1_1OutputSoundFile.html#ae5e55f01c53c1422c44eaed2eed67fce">openFromFile</a>(<span class="stringliteral">"music.ogg"</span>, 44100, 2))</div><div class="line"> <span class="comment">/* error */</span>;</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<sf::Int16> samples = ...;</div><div class="line"></div><div class="line"> <span class="comment">// Write them to the file</span></div><div class="line"> file.<a class="code" href="classsf_1_1OutputSoundFile.html#adfcf525fced71121f336fa89faac3d67">write</a>(samples.data(), samples.size());</div><div class="line">}</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1SoundFileWriter.html" title="Abstract base class for sound file encoding. ">sf::SoundFileWriter</a>, <a class="el" href="classsf_1_1InputSoundFile.html" title="Provide read access to sound files. ">sf::InputSoundFile</a> </dd></dl> <p class="definition">Definition at line <a class="el" href="OutputSoundFile_8hpp_source.html#l00044">44</a> of file <a class="el" href="OutputSoundFile_8hpp_source.html">OutputSoundFile.hpp</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a7ae9f2dbd0991fa9394726a3d58bb19e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7ae9f2dbd0991fa9394726a3d58bb19e">◆ </a></span>OutputSoundFile()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">sf::OutputSoundFile::OutputSoundFile </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Default constructor. </p> </div> </div> <a id="a1492adbfef1f391d720afb56f068182e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1492adbfef1f391d720afb56f068182e">◆ </a></span>~OutputSoundFile()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">sf::OutputSoundFile::~OutputSoundFile </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destructor. </p> <p>Closes the file if it was still open. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="ae5e55f01c53c1422c44eaed2eed67fce"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae5e55f01c53c1422c44eaed2eed67fce">◆ </a></span>openFromFile()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool sf::OutputSoundFile::openFromFile </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>filename</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>sampleRate</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>channelCount</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></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> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>True if the file was successfully opened </dd></dl> </div> </div> <a id="adfcf525fced71121f336fa89faac3d67"></a> <h2 class="memtitle"><span class="permalink"><a href="#adfcf525fced71121f336fa89faac3d67">◆ </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 Int16 * </td> <td class="paramname"><em>samples</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Uint64 </td> <td class="paramname"><em>count</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></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 © Laurent Gomila :: Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> :: </div> </div> </body> </html>