diff options
Diffstat (limited to 'doc/html/classsf_1_1SoundRecorder.htm')
| -rwxr-xr-x | doc/html/classsf_1_1SoundRecorder.htm | 160 |
1 files changed, 97 insertions, 63 deletions
diff --git a/doc/html/classsf_1_1SoundRecorder.htm b/doc/html/classsf_1_1SoundRecorder.htm index 59c9083..a2c0f9e 100755 --- a/doc/html/classsf_1_1SoundRecorder.htm +++ b/doc/html/classsf_1_1SoundRecorder.htm @@ -10,76 +10,97 @@ <div id="logo"> <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> </div> -<!-- Generated by Doxygen 1.5.2 --> -<div class="tabs"> - <ul> - <li><a href="index.htm"><span>Main Page</span></a></li> - <li><a href="namespaces.htm"><span>Namespaces</span></a></li> - <li class="current"><a href="classes.htm"><span>Classes</span></a></li> - <li><a href="files.htm"><span>Files</span></a></li> - </ul> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.htm"><span>Main Page</span></a></li> + <li><a href="namespaces.htm"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.htm"><span>Classes</span></a></li> + <li><a href="files.htm"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.htm"><span>Class List</span></a></li> + <li><a href="classes.htm"><span>Class Index</span></a></li> + <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> + <li><a href="functions.htm"><span>Class Members</span></a></li> + </ul> + </div> + <div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1SoundRecorder.htm">SoundRecorder</a> + </div> </div> -<div class="tabs"> - <ul> - <li><a href="classes.htm"><span>Alphabetical List</span></a></li> - <li><a href="annotated.htm"><span>Class List</span></a></li> - <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> - <li><a href="functions.htm"><span>Class Members</span></a></li> - </ul> -</div> -<div class="nav"> -<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1SoundRecorder.htm">SoundRecorder</a></div> +<div class="contents"> <h1>sf::SoundRecorder Class Reference</h1><!-- doxytag: class="sf::SoundRecorder" --><!-- doxytag: inherits="sf::Thread" --><a class="el" href="classsf_1_1SoundRecorder.htm" title="SoundRecorder is an interface for capturing sound data, it is meant to be used as...">SoundRecorder</a> is an interface for capturing sound data, it is meant to be used as a base class. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="SoundRecorder_8hpp-source.htm">SoundRecorder.hpp</a>></code> <p> -<p>Inheritance diagram for sf::SoundRecorder: +<div class="dynheader"> +Inheritance diagram for sf::SoundRecorder:</div> +<div class="dynsection"> + <p><center><img src="classsf_1_1SoundRecorder.png" usemap="#sf::SoundRecorder_map" border="0" alt=""></center> <map name="sf::SoundRecorder_map"> <area href="classsf_1_1Thread.htm" alt="sf::Thread" shape="rect" coords="0,0,152,24"> <area href="classsf_1_1SoundBufferRecorder.htm" alt="sf::SoundBufferRecorder" shape="rect" coords="0,112,152,136"> </map> +</div> + +<p> <a href="classsf_1_1SoundRecorder-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#cc599e61aaa47edaae88cf43f0a43549">~SoundRecorder</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#e83953cce24c5245c0672d150d280b64">~SoundRecorder</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#cc599e61aaa47edaae88cf43f0a43549"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#e83953cce24c5245c0672d150d280b64"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#6693c1ac2c0d1677f798539b0643eac6">Start</a> (unsigned int SampleRate=44100)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Start the capture. <a href="#6693c1ac2c0d1677f798539b0643eac6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#9d51c7ef42bcdd4ad53e995d57f90733">Stop</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Stop the capture. <a href="#9d51c7ef42bcdd4ad53e995d57f90733"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#e82653812d3f8251f63d42ba364236f5">GetSampleRate</a> () const</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#bab8a7f4ba28658c4bf707639f11a6c5">GetSampleRate</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the sample rate. <a href="#e82653812d3f8251f63d42ba364236f5"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the sample rate. <a href="#bab8a7f4ba28658c4bf707639f11a6c5"></a><br></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#fa49a0834d1b49ec69b9991f88558040">CanCapture</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#436acab98f3f95d146b3ffe24fbf3fc5">CanCapture</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell if the system supports sound capture. <a href="#fa49a0834d1b49ec69b9991f88558040"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell if the system supports sound capture. <a href="#436acab98f3f95d146b3ffe24fbf3fc5"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SoundRecorder.htm#50ebad413c4f157408a0fa49f23212a9">SoundRecorder</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#50ebad413c4f157408a0fa49f23212a9"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab6e6f11eb38f106cd7c1149763a11b8"></a><!-- doxytag: member="sf::SoundRecorder::FuncType" ref="ab6e6f11eb38f106cd7c1149763a11b8" args=")(void *)" --> +typedef void(* </td><td class="memItemRight" valign="bottom"><b>FuncType</b> )(void *)</td></tr> + +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.htm#046df871f73d3cf452d1c72bcc143642">Launch</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create and run the thread. <a href="#046df871f73d3cf452d1c72bcc143642"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.htm#67f3c609fdf99688531dbfae461ea4d2">Wait</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait until the thread finishes. <a href="#67f3c609fdf99688531dbfae461ea4d2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.htm#603d9493c6a845188f05c2eca48dc41b">Terminate</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself. <a href="#603d9493c6a845188f05c2eca48dc41b"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classsf_1_1SoundRecorder.htm" title="SoundRecorder is an interface for capturing sound data, it is meant to be used as...">SoundRecorder</a> is an interface for capturing sound data, it is meant to be used as a base class. -<p> - -<p> -Definition at line <a class="el" href="SoundRecorder_8hpp-source.htm#l00041">41</a> of file <a class="el" href="SoundRecorder_8hpp-source.htm">SoundRecorder.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2> -<a class="anchor" name="cc599e61aaa47edaae88cf43f0a43549"></a><!-- doxytag: member="sf::SoundRecorder::~SoundRecorder" ref="cc599e61aaa47edaae88cf43f0a43549" args="()" --> +<p>Definition at line <a class="el" href="SoundRecorder_8hpp-source.htm#l00041">41</a> of file <a class="el" href="SoundRecorder_8hpp-source.htm">SoundRecorder.hpp</a>.</p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="e83953cce24c5245c0672d150d280b64"></a><!-- doxytag: member="sf::SoundRecorder::~SoundRecorder" ref="e83953cce24c5245c0672d150d280b64" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual sf::SoundRecorder::~SoundRecorder </td> + <td class="memname">sf::SoundRecorder::~SoundRecorder </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [virtual]</code></td> + <td><code> [virtual]</code></td> </tr> </table> </div> @@ -89,6 +110,8 @@ Definition at line <a class="el" href="SoundRecorder_8hpp-source.htm#l00041">41< Virtual destructor. <p> +<p>Definition at line <a class="el" href="SoundRecorder_8cpp-source.htm#l00059">59</a> of file <a class="el" href="SoundRecorder_8cpp-source.htm">SoundRecorder.cpp</a>.</p> + </div> </div><p> <a class="anchor" name="50ebad413c4f157408a0fa49f23212a9"></a><!-- doxytag: member="sf::SoundRecorder::SoundRecorder" ref="50ebad413c4f157408a0fa49f23212a9" args="()" --> @@ -100,7 +123,7 @@ Virtual destructor. <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [protected]</code></td> + <td><code> [protected]</code></td> </tr> </table> </div> @@ -110,105 +133,116 @@ Virtual destructor. Default constructor. <p> +<p>Definition at line <a class="el" href="SoundRecorder_8cpp-source.htm#l00048">48</a> of file <a class="el" href="SoundRecorder_8cpp-source.htm">SoundRecorder.cpp</a>.</p> + </div> </div><p> <hr><h2>Member Function Documentation</h2> -<a class="anchor" name="6693c1ac2c0d1677f798539b0643eac6"></a><!-- doxytag: member="sf::SoundRecorder::Start" ref="6693c1ac2c0d1677f798539b0643eac6" args="(unsigned int SampleRate=44100)" --> +<a class="anchor" name="436acab98f3f95d146b3ffe24fbf3fc5"></a><!-- doxytag: member="sf::SoundRecorder::CanCapture" ref="436acab98f3f95d146b3ffe24fbf3fc5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void sf::SoundRecorder::Start </td> + <td class="memname">bool sf::SoundRecorder::CanCapture </td> <td>(</td> - <td class="paramtype">unsigned int </td> - <td class="paramname"> <em>SampleRate</em> = <code>44100</code> </td> + <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> -Start the capture. +Tell if the system supports sound capture. <p> -Warning : only one capture can happen at the same time<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>SampleRate</em> </td><td>: <a class="el" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a> frequency (the more samples, the higher the quality) (44100 by default = CD quality) </td></tr> - </table> -</dl> +If not, this class won't be usable<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if audio capture is supported</dd></dl> +If not, this class won't be usable +<p>Definition at line <a class="el" href="SoundRecorder_8cpp-source.htm#l00136">136</a> of file <a class="el" href="SoundRecorder_8cpp-source.htm">SoundRecorder.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="9d51c7ef42bcdd4ad53e995d57f90733"></a><!-- doxytag: member="sf::SoundRecorder::Stop" ref="9d51c7ef42bcdd4ad53e995d57f90733" args="()" --> +<a class="anchor" name="bab8a7f4ba28658c4bf707639f11a6c5"></a><!-- doxytag: member="sf::SoundRecorder::GetSampleRate" ref="bab8a7f4ba28658c4bf707639f11a6c5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void sf::SoundRecorder::Stop </td> + <td class="memname">unsigned int sf::SoundRecorder::GetSampleRate </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> -Stop the capture. +Get the sample rate. <p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Frequency, in samples per second </dd></dl> + +<p>Definition at line <a class="el" href="SoundRecorder_8cpp-source.htm#l00126">126</a> of file <a class="el" href="SoundRecorder_8cpp-source.htm">SoundRecorder.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="e82653812d3f8251f63d42ba364236f5"></a><!-- doxytag: member="sf::SoundRecorder::GetSampleRate" ref="e82653812d3f8251f63d42ba364236f5" args="() const" --> +<a class="anchor" name="6693c1ac2c0d1677f798539b0643eac6"></a><!-- doxytag: member="sf::SoundRecorder::Start" ref="6693c1ac2c0d1677f798539b0643eac6" args="(unsigned int SampleRate=44100)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">unsigned int sf::SoundRecorder::GetSampleRate </td> + <td class="memname">void sf::SoundRecorder::Start </td> <td>(</td> - <td class="paramname"> </td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>SampleRate</em> = <code>44100</code> </td> <td> ) </td> - <td width="100%"> const</td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Get the sample rate. +Start the capture. <p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Frequency, in samples per second </dd></dl> +Warning : only one capture can happen at the same time<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>SampleRate</em> </td><td>: <a class="el" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a> frequency (the more samples, the higher the quality) (44100 by default = CD quality)</td></tr> + </table> +</dl> +Warning : only one capture can happen at the same time +<p>Definition at line <a class="el" href="SoundRecorder_8cpp-source.htm#l00069">69</a> of file <a class="el" href="SoundRecorder_8cpp-source.htm">SoundRecorder.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="fa49a0834d1b49ec69b9991f88558040"></a><!-- doxytag: member="sf::SoundRecorder::CanCapture" ref="fa49a0834d1b49ec69b9991f88558040" args="()" --> +<a class="anchor" name="9d51c7ef42bcdd4ad53e995d57f90733"></a><!-- doxytag: member="sf::SoundRecorder::Stop" ref="9d51c7ef42bcdd4ad53e995d57f90733" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">static bool sf::SoundRecorder::CanCapture </td> + <td class="memname">void sf::SoundRecorder::Stop </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [static]</code></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Tell if the system supports sound capture. +Stop the capture. <p> -If not, this class won't be usable<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if audio capture is supported </dd></dl> + +<p>Definition at line <a class="el" href="SoundRecorder_8cpp-source.htm#l00115">115</a> of file <a class="el" href="SoundRecorder_8cpp-source.htm">SoundRecorder.cpp</a>.</p> </div> </div><p> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="SoundRecorder_8hpp-source.htm">SoundRecorder.hpp</a></ul> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="SoundRecorder_8hpp-source.htm">SoundRecorder.hpp</a><li><a class="el" href="SoundRecorder_8cpp-source.htm">SoundRecorder.cpp</a></ul> +</div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: |