diff options
Diffstat (limited to 'libghack/CSFML-2.1-windows-64bits/CSFML-2.1/doc/html/SoundRecorder_8h.htm')
| -rwxr-xr-x | libghack/CSFML-2.1-windows-64bits/CSFML-2.1/doc/html/SoundRecorder_8h.htm | 321 |
1 files changed, 321 insertions, 0 deletions
diff --git a/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/doc/html/SoundRecorder_8h.htm b/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/doc/html/SoundRecorder_8h.htm new file mode 100755 index 0000000..212dea3 --- /dev/null +++ b/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/doc/html/SoundRecorder_8h.htm @@ -0,0 +1,321 @@ +<!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>CSFML - C binding of the Simple and Fast Multimedia Library</title> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/> + <!--<link rel='stylesheet' type='text/css' href="http://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>--> + <link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" /> + </head> + <body> + <div id="banner-container"> + <div id="banner"> + <span id="sfml">CSFML</span> + </div> + </div> + <div id="content"> +<!-- Generated by Doxygen 1.8.2 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.htm"><span>Main Page</span></a></li> + <li><a href="annotated.htm"><span>Data Structures</span></a></li> + <li class="current"><a href="files.htm"><span>Files</span></a></li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.htm"><span>File List</span></a></li> + <li><a href="globals.htm"><span>Globals</span></a></li> + </ul> + </div> +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_6a66b7969672f1da69f458a57d2c97f9.htm">include</a></li><li class="navelem"><a class="el" href="dir_8cc999c03ab8fdf40558b1f21f869c3e.htm">SFML</a></li><li class="navelem"><a class="el" href="dir_ab65b93e3e53c8b4552e87dc0e7cef27.htm">Audio</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">SoundRecorder.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <<a class="el" href="Audio_2Export_8h_source.htm">SFML/Audio/Export.h</a>></code><br/> +<code>#include <<a class="el" href="Audio_2Types_8h_source.htm">SFML/Audio/Types.h</a>></code><br/> +<code>#include <stddef.h></code><br/> +</div> +<p><a href="SoundRecorder_8h_source.htm">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a51de2ab37546b8f518af2a62f2fe6936"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#a51de2ab37546b8f518af2a62f2fe6936">sfSoundRecorderStartCallback</a> )(void *)</td></tr> +<tr class="memdesc:a51de2ab37546b8f518af2a62f2fe6936"><td class="mdescLeft"> </td><td class="mdescRight">Type of the callback used when starting a capture. <a href="#a51de2ab37546b8f518af2a62f2fe6936"></a><br/></td></tr> +<tr class="separator:a51de2ab37546b8f518af2a62f2fe6936"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad6d8bc1ecf3c165f687044c69b95ec79"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#ad6d8bc1ecf3c165f687044c69b95ec79">sfSoundRecorderProcessCallback</a> )(const <a class="el" href="Config_8h.htm#a41552dc8bf60293b5cc8515dd5beaf0e">sfInt16</a> *, size_t, void *)</td></tr> +<tr class="memdesc:ad6d8bc1ecf3c165f687044c69b95ec79"><td class="mdescLeft"> </td><td class="mdescRight">Type of the callback used to process audio data. <a href="#ad6d8bc1ecf3c165f687044c69b95ec79"></a><br/></td></tr> +<tr class="separator:ad6d8bc1ecf3c165f687044c69b95ec79"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1c79476189b5754b7ccd80de4f9b193d"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#a1c79476189b5754b7ccd80de4f9b193d">sfSoundRecorderStopCallback</a> )(void *)</td></tr> +<tr class="memdesc:a1c79476189b5754b7ccd80de4f9b193d"><td class="mdescLeft"> </td><td class="mdescRight">Type of the callback used when stopping a capture. <a href="#a1c79476189b5754b7ccd80de4f9b193d"></a><br/></td></tr> +<tr class="separator:a1c79476189b5754b7ccd80de4f9b193d"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a39c9a56c773f15ec3549ec60d3c5ee6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#a39c9a56c773f15ec3549ec60d3c5ee6e">sfSoundRecorder_create</a> (<a class="el" href="SoundRecorder_8h.htm#a51de2ab37546b8f518af2a62f2fe6936">sfSoundRecorderStartCallback</a> onStart, <a class="el" href="SoundRecorder_8h.htm#ad6d8bc1ecf3c165f687044c69b95ec79">sfSoundRecorderProcessCallback</a> onProcess, <a class="el" href="SoundRecorder_8h.htm#a1c79476189b5754b7ccd80de4f9b193d">sfSoundRecorderStopCallback</a> onStop, void *userData)</td></tr> +<tr class="memdesc:a39c9a56c773f15ec3549ec60d3c5ee6e"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new sound recorder from callback functions. <a href="#a39c9a56c773f15ec3549ec60d3c5ee6e"></a><br/></td></tr> +<tr class="separator:a39c9a56c773f15ec3549ec60d3c5ee6e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7258c607b624bb79a1c563196c67acc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#a7258c607b624bb79a1c563196c67acc5">sfSoundRecorder_destroy</a> (<a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> *soundRecorder)</td></tr> +<tr class="memdesc:a7258c607b624bb79a1c563196c67acc5"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a sound recorder. <a href="#a7258c607b624bb79a1c563196c67acc5"></a><br/></td></tr> +<tr class="separator:a7258c607b624bb79a1c563196c67acc5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a098e51a0657452111ef97d1d4a85c12e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#a098e51a0657452111ef97d1d4a85c12e">sfSoundRecorder_start</a> (<a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> *soundRecorder, unsigned int sampleRate)</td></tr> +<tr class="memdesc:a098e51a0657452111ef97d1d4a85c12e"><td class="mdescLeft"> </td><td class="mdescRight">Start the capture of a sound recorder. <a href="#a098e51a0657452111ef97d1d4a85c12e"></a><br/></td></tr> +<tr class="separator:a098e51a0657452111ef97d1d4a85c12e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afb0989a93277c350ccc185e39136e0f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#afb0989a93277c350ccc185e39136e0f2">sfSoundRecorder_stop</a> (<a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> *soundRecorder)</td></tr> +<tr class="memdesc:afb0989a93277c350ccc185e39136e0f2"><td class="mdescLeft"> </td><td class="mdescRight">Stop the capture of a sound recorder. <a href="#afb0989a93277c350ccc185e39136e0f2"></a><br/></td></tr> +<tr class="separator:afb0989a93277c350ccc185e39136e0f2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11efae59a67beccc7c972a25e1d4d0b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#a11efae59a67beccc7c972a25e1d4d0b5">sfSoundRecorder_getSampleRate</a> (const <a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> *soundRecorder)</td></tr> +<tr class="memdesc:a11efae59a67beccc7c972a25e1d4d0b5"><td class="mdescLeft"> </td><td class="mdescRight">Get the sample rate of a sound recorder. <a href="#a11efae59a67beccc7c972a25e1d4d0b5"></a><br/></td></tr> +<tr class="separator:a11efae59a67beccc7c972a25e1d4d0b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a476094e3adf6380f88e3741269d28af7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SoundRecorder_8h.htm#a476094e3adf6380f88e3741269d28af7">sfSoundRecorder_isAvailable</a> (void)</td></tr> +<tr class="memdesc:a476094e3adf6380f88e3741269d28af7"><td class="mdescLeft"> </td><td class="mdescRight">Check if the system supports audio capture. <a href="#a476094e3adf6380f88e3741269d28af7"></a><br/></td></tr> +<tr class="separator:a476094e3adf6380f88e3741269d28af7"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="ad6d8bc1ecf3c165f687044c69b95ec79"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a>(* sfSoundRecorderProcessCallback)(const <a class="el" href="Config_8h.htm#a41552dc8bf60293b5cc8515dd5beaf0e">sfInt16</a> *, size_t, void *)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Type of the callback used to process audio data. </p> + +<p>Definition at line <a class="el" href="SoundRecorder_8h_source.htm#l00037">37</a> of file <a class="el" href="SoundRecorder_8h_source.htm">SoundRecorder.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a51de2ab37546b8f518af2a62f2fe6936"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a>(* sfSoundRecorderStartCallback)(void *)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Type of the callback used when starting a capture. </p> + +<p>Definition at line <a class="el" href="SoundRecorder_8h_source.htm#l00036">36</a> of file <a class="el" href="SoundRecorder_8h_source.htm">SoundRecorder.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a1c79476189b5754b7ccd80de4f9b193d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef void(* sfSoundRecorderStopCallback)(void *)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Type of the callback used when stopping a capture. </p> + +<p>Definition at line <a class="el" href="SoundRecorder_8h_source.htm#l00038">38</a> of file <a class="el" href="SoundRecorder_8h_source.htm">SoundRecorder.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="a39c9a56c773f15ec3549ec60d3c5ee6e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a>* sfSoundRecorder_create </td> + <td>(</td> + <td class="paramtype"><a class="el" href="SoundRecorder_8h.htm#a51de2ab37546b8f518af2a62f2fe6936">sfSoundRecorderStartCallback</a> </td> + <td class="paramname"><em>onStart</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="SoundRecorder_8h.htm#ad6d8bc1ecf3c165f687044c69b95ec79">sfSoundRecorderProcessCallback</a> </td> + <td class="paramname"><em>onProcess</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="SoundRecorder_8h.htm#a1c79476189b5754b7ccd80de4f9b193d">sfSoundRecorderStopCallback</a> </td> + <td class="paramname"><em>onStop</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>userData</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Construct a new sound recorder from callback functions. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">onStart</td><td>Callback function which will be called when a new capture starts (can be NULL) </td></tr> + <tr><td class="paramname">onProcess</td><td>Callback function which will be called each time there's audio data to process </td></tr> + <tr><td class="paramname">onStop</td><td>Callback function which will be called when the current capture stops (can be NULL) </td></tr> + <tr><td class="paramname">userData</td><td>Data to pass to the callback function (can be NULL)</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A new sfSoundRecorder object (NULL if failed) </dd></dl> + +</div> +</div> +<a class="anchor" id="a7258c607b624bb79a1c563196c67acc5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfSoundRecorder_destroy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> * </td> + <td class="paramname"><em>soundRecorder</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Destroy a sound recorder. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">soundRecorder</td><td>Sound recorder to destroy </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a11efae59a67beccc7c972a25e1d4d0b5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> unsigned int sfSoundRecorder_getSampleRate </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> * </td> + <td class="paramname"><em>soundRecorder</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the sample rate of a sound recorder. </p> +<p>The sample rate defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality).</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">soundRecorder</td><td>Sound recorder object</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Sample rate, in samples per second </dd></dl> + +</div> +</div> +<a class="anchor" id="a476094e3adf6380f88e3741269d28af7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> sfSoundRecorder_isAvailable </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Check if the system supports audio capture. </p> +<p>This function should always be called before using the audio capture features. If it returns false, then any attempt to use sfSoundRecorder will fail.</p> +<dl class="section return"><dt>Returns</dt><dd>sfTrue if audio capture is supported, sfFalse otherwise </dd></dl> + +</div> +</div> +<a class="anchor" id="a098e51a0657452111ef97d1d4a85c12e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfSoundRecorder_start </td> + <td>(</td> + <td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> * </td> + <td class="paramname"><em>soundRecorder</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></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Start the capture of a sound recorder. </p> +<p>The <em>sampleRate</em> parameter defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality). This function uses its own thread so that it doesn't block the rest of the program while the capture runs. Please note that only one capture can happen at the same time.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">soundRecorder</td><td>Sound recorder object </td></tr> + <tr><td class="paramname">sampleRate</td><td>Desired capture rate, in number of samples per second </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="afb0989a93277c350ccc185e39136e0f2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="Audio_2Export_8h.htm#a7a489e428c325519799913f98f81f774">CSFML_AUDIO_API</a> void sfSoundRecorder_stop </td> + <td>(</td> + <td class="paramtype"><a class="el" href="Audio_2Types_8h.htm#a8ca1d417cfa024b69bada0ec2bc8b9ce">sfSoundRecorder</a> * </td> + <td class="paramname"><em>soundRecorder</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Stop the capture of a sound recorder. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">soundRecorder</td><td>Sound recorder object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> + </div> + <div id="footer-container"> + <div id="footer"> + Copyright © Laurent Gomila :: + Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> :: + </div> + </div> + </body> +</html> |