Sophie

Sophie

distrib > Mandriva > cooker > x86_64 > by-pkgid > 8bc91a014960c92a1758363ffa3e1d03 > files > 44

clanlib0.6-docs-0.6.5-39.x86_64.rpm


<html>
<head><title>ClanLib Reference: CL_CDDrive</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_CDDrive</h1><p>
<b>  CD drive audio interface.</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 (CD Audio)
<p>
#include &lt;ClanLib/sound.h&gt;
<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_CDDrive.html#2129"><tt><font color=blue><b>~CL_CDDrive</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2130"><tt><font color=blue><b>init</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>virtual</tt> <tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2131"><tt><font color=blue><b>get_drive_path</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2132"><tt><font color=blue><b>get_cd_name</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2133"><tt><font color=blue><b>get_num_tracks</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2134"><tt><font color=blue><b>is_playing</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2135"><tt><font color=blue><b>get_cur_track</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2136"><tt><font color=blue><b>get_cur_frame</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>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2137"><tt><font color=blue><b>play_tracks</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>track</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>end_track</font></tt>=0)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2138"><tt><font color=blue><b>play_frames</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>frame</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>end_frame</font></tt>=0)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2139"><tt><font color=blue><b>play_track</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>track</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2140"><tt><font color=blue><b>stop</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2141"><tt><font color=blue><b>pause</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_CDDrive.html#2142"><tt><font color=blue><b>resume</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
  Use this class to control the CDROM drive in your computer.<br><p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="2132"><font size=+1><b>CL_CDDrive::get_cd_name</b></font></a> -   Get the name of the CD.<br><tt><tt>virtual</tt> <tt><font color=navy>std::string</font></tt></tt> <a href="CL_CDDrive.html#2132"><tt><font color=blue><b>get_cd_name</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2136"><font size=+1><b>CL_CDDrive::get_cur_frame</b></font></a> -   Returns the current frame on the track.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_CDDrive.html#2136"><tt><font color=blue><b>get_cur_frame</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2135"><font size=+1><b>CL_CDDrive::get_cur_track</b></font></a> -   Returns the current track.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_CDDrive.html#2135"><tt><font color=blue><b>get_cur_track</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2131"><font size=+1><b>CL_CDDrive::get_drive_path</b></font></a> -   Get the path of the CD drive. (what is this, starch?)<br><tt><tt>virtual</tt> <tt><font color=navy>std::string</font></tt></tt> <a href="CL_CDDrive.html#2131"><tt><font color=blue><b>get_drive_path</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2133"><font size=+1><b>CL_CDDrive::get_num_tracks</b></font></a> -   Get the number of tracks available on the cd.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_CDDrive.html#2133"><tt><font color=blue><b>get_num_tracks</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2130"><font size=+1><b>CL_CDDrive::init</b></font></a> -   Call this one to initialize the cd drive.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_CDDrive.html#2130"><tt><font color=blue><b>init</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2134"><font size=+1><b>CL_CDDrive::is_playing</b></font></a> -   Returns true if the CD drive is playing.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_CDDrive.html#2134"><tt><font color=blue><b>is_playing</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2141"><font size=+1><b>CL_CDDrive::pause</b></font></a> -   Pause the playback.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_CDDrive.html#2141"><tt><font color=blue><b>pause</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2138"><font size=+1><b>CL_CDDrive::play_frames</b></font></a> -   Play from frame 'frame' to 'end_frame'.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_CDDrive.html#2138"><tt><font color=blue><b>play_frames</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>frame</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>end_frame</font></tt>=0)</tt>;<br><blockquote>  frame - Begin frame.<br>  end_frame - End frame.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2139"><font size=+1><b>CL_CDDrive::play_track</b></font></a> -   Play track 'track'. Returns true if successful.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_CDDrive.html#2139"><tt><font color=blue><b>play_track</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>track</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2137"><font size=+1><b>CL_CDDrive::play_tracks</b></font></a> -   Play from track 'track' til track 'end_track'.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_CDDrive.html#2137"><tt><font color=blue><b>play_tracks</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>track</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>end_track</font></tt>=0)</tt>;<br><blockquote>  track - Begin track.<br>  end_track - End track.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2142"><font size=+1><b>CL_CDDrive::resume</b></font></a> -   Resume the playback.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_CDDrive.html#2142"><tt><font color=blue><b>resume</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2140"><font size=+1><b>CL_CDDrive::stop</b></font></a> -   Stop playing.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_CDDrive.html#2140"><tt><font color=blue><b>stop</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2129"><font size=+1><b>CL_CDDrive::~CL_CDDrive</b></font></a> -   CD Drive Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_CDDrive.html#2129"><tt><font color=blue><b>~CL_CDDrive</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
</body>
</html>