<html> <head><title>ClanLib Reference: CL_Sound</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_Sound</h1><p> <b> Sound interface in ClanLib.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Sound (Audio Mixing) <p> #include <ClanLib/sound.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Sound.html#231"><tt><font color=blue><b>~CL_Sound</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_StreamSoundProvider.html"><tt><font color=navy><b>CL_StreamSoundProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Sound.html#234"><tt><font color=blue><b>get_microphone</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_StreamSoundProvider.html"><tt><font color=navy><b>CL_StreamSoundProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Sound.html#235"><tt><font color=blue><b>get_line_in</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Sound.html#236"><tt><font color=blue><b>get_current_card</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sound.html#237"><tt><font color=blue><b>clear_card_preload</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sound.html#238"><tt><font color=blue><b>add_card_preload</b></font></tt></a></td><td><tt>(<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sound.html#239"><tt><font color=blue><b>remove_card_preload</b></font></tt></a></td><td><tt>(<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sound.html#240"><tt><font color=blue><b>select_card</b></font></tt></a></td><td><tt>(<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sound.html#241"><tt><font color=blue><b>select_card</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>card_no</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> This class provides a list of all soundcards available on the system. It is also a wrapper class for the <a href="CL_SoundCard.html">CL_SoundCard</a> class, providing an easier access to a single selected soundcard.<br><br> All the functions that share name with those in <a href="CL_SoundCard.html">CL_SoundCard</a> have the same functionality. The only difference is, that the ones <a href="CL_Sound.html">CL_Sound</a> operate on a selected soundcard. This saves the trouble of passing around a pointer to the soundcard, when only a single one is used anyway.<br> See also - <a href="CL_SoundCard.html">CL_SoundCard</a> - Soundcard interface class.<br> See also - <a href="CL_SoundBuffer.html">CL_SoundBuffer</a> - Sample class in ClanLib.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="238"><font size=+1><b>CL_Sound::add_card_preload</b></font></a> - Adds 'card' to the preloaded soundcards list. This means all soundbuffers will be automatically preloaded onto the card. By default the first card is always on the preload list.<br> <br> If a card isn't on the list, the soundbuffer's data will first be loaded when the sample is actually played for the first time.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sound.html#238"><tt><font color=blue><b>add_card_preload</b></font></tt></a><tt>(<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>)</tt>;<br><blockquote> card - The card to be added to the preload list.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="237"><font size=+1><b>CL_Sound::clear_card_preload</b></font></a> - Clears the list of preloaded soundcards.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sound.html#237"><tt><font color=blue><b>clear_card_preload</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="236"><font size=+1><b>CL_Sound::get_current_card</b></font></a> - Returns the current selected soundcard.<br><tt><tt>static</tt> <a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>*</tt> <a href="CL_Sound.html#236"><tt><font color=blue><b>get_current_card</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - Current soundcard.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="235"><font size=+1><b>CL_Sound::get_line_in</b></font></a> - Returns the streamed soundprovider representing the line in.<br><tt><tt>static</tt> <a href="CL_StreamSoundProvider.html"><tt><font color=navy><b>CL_StreamSoundProvider</b></font></tt></a>*</tt> <a href="CL_Sound.html#235"><tt><font color=blue><b>get_line_in</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - The line in.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="234"><font size=+1><b>CL_Sound::get_microphone</b></font></a> - Returns the streamed soundprovider representing the microphone.<br><tt><tt>static</tt> <a href="CL_StreamSoundProvider.html"><tt><font color=navy><b>CL_StreamSoundProvider</b></font></tt></a>*</tt> <a href="CL_Sound.html#234"><tt><font color=blue><b>get_microphone</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - The microphone.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="239"><font size=+1><b>CL_Sound::remove_card_preload</b></font></a> - Removes the specified card from the preload list.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sound.html#239"><tt><font color=blue><b>remove_card_preload</b></font></tt></a><tt>(<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>)</tt>;<br><blockquote> card - The card to be removed from the list.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="240"><font size=+1><b>CL_Sound::select_card</b></font></a> - Change the current selected soundcard to 'card'.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sound.html#240"><tt><font color=blue><b>select_card</b></font></tt></a><tt>(<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>)</tt>;<br><blockquote> card - The new current selected soundcard.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="241"><font size=+1><b>CL_Sound::select_card</b></font></a> - Change the current selected soundcard to soundcard number 'card_no'.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sound.html#241"><tt><font color=blue><b>select_card</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>card_no</font></tt>)</tt>;<br><blockquote> card_no - Card number in the CL_Sound::cards list.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="231"><font size=+1><b>CL_Sound::~CL_Sound</b></font></a> - Sound Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Sound.html#231"><tt><font color=blue><b>~CL_Sound</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <a name="232"><font size=+1><b>CL_Sound::cards</b></font></a> - The list of soundcards available on this system.<br> <tt><tt>static</tt> <tt><font color=navy>std::vector</font></tt><<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>*> </tt> <tt><a href="CL_Sound.html#232"><tt><font color=blue>cards</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <a name="233"><font size=+1><b>CL_Sound::preload_cards</b></font></a> - List of all cards where soundbuffers are automatically preloaded.<br> <tt><tt>static</tt> <tt><font color=navy>std::list</font></tt><<a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>*> </tt> <tt><a href="CL_Sound.html#233"><tt><font color=blue>preload_cards</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <hr noshade> </body> </html>
