Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > 554fa56029a60daf7aab25253fdab3d8 > files > 245

clanlib0.6-docs-0.6.5-28mdv2008.1.x86_64.rpm


<html>
<head><title>ClanLib Reference: CL_VorbisSoundProvider</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_VorbisSoundProvider</h1><p>
<b>  Vorbis Sound Provider Class</b><br>
Contained in: <a href="global_index.html">global</a><br>
Derived from:
<a href="CL_StreamSoundProvider.html">CL_StreamSoundProvider</a>
<br>
Derived by:
<i>none</i>
<br>Group: Vorbis (Sound Providers)
<p>
#include &lt;ClanLib/vorbis.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> </td><td align=right><a href="CL_VorbisSoundProvider.html#1607"><tt><font color=blue><b>CL_VorbisSoundProvider</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt> = NULL, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt> = false)</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_VorbisSoundProvider.html#1608"><tt><font color=blue><b>CL_VorbisSoundProvider</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>resources</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_VorbisSoundProvider.html#1609"><tt><font color=blue><b>~CL_VorbisSoundProvider</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> <a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_Session</b></font></tt></a>*</tt> </td><td align=right><a href="CL_VorbisSoundProvider.html#1610"><tt><font color=blue><b>begin_session</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_VorbisSoundProvider.html#1611"><tt><font color=blue><b>end_session</b></font></tt></a></td><td><tt>(<a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_Session</b></font></tt></a>* <tt><font color=blue>session</font></tt>)</tt>;</td>
<tr><td>&nbsp;</td><tr><td colspan=3><h3>private function member index:</h3></td>
<tr valign=top><td align=left><h3>Implementation:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_VorbisSoundProvider.html#1612"><tt><font color=blue><b>CL_VorbisSoundProvider</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_VorbisSoundProvider.html#1612"><tt><font color=blue><b>CL_VorbisSoundProvider</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
<p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="1607"><font size=+1><b>CL_VorbisSoundProvider::CL_VorbisSoundProvider</b></font></a> -   Vorbis Sound Provider Constructor<br><tt></tt> <a href="CL_VorbisSoundProvider.html#1607"><tt><font color=blue><b>CL_VorbisSoundProvider</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt> = NULL, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt> = false)</tt>;<br><blockquote>  name - The name of the file, either it's filename or descriptor from 'provider'<br>  provider - the InputsourceProvider to use<br>  delete_provider - If true, 'provider' will be delete when the destructor is called</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="1608"><font size=+1><b>CL_VorbisSoundProvider::CL_VorbisSoundProvider</b></font></a> -   Vorbis Sound Provider Constructor<br><tt></tt> <a href="CL_VorbisSoundProvider.html#1608"><tt><font color=blue><b>CL_VorbisSoundProvider</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>resources</font></tt>)</tt>;<br><blockquote>  name - The name of the vorbis file in 'resources'<br> 	resources - The ResourceManager to use to access the resource identified by 'name'</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="1610"><font size=+1><b>CL_VorbisSoundProvider::begin_session</b></font></a> -   Begin Session<br><tt><tt>virtual</tt> <a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_Session</b></font></tt></a>*</tt> <a href="CL_VorbisSoundProvider.html#1610"><tt><font color=blue><b>begin_session</b></font></tt></a><tt>()</tt>;<br><blockquote>  Returns - A CL_StreamSoundProvider_Session object for the resource named in the constructor</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="1611"><font size=+1><b>CL_VorbisSoundProvider::end_session</b></font></a> -   End Session<br>  Deletes the object 'session'<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_VorbisSoundProvider.html#1611"><tt><font color=blue><b>end_session</b></font></tt></a><tt>(<a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_Session</b></font></tt></a>* <tt><font color=blue>session</font></tt>)</tt>;<br><blockquote>  session - The CL_StreamSoundProvider_Session to be deleted</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="1609"><font size=+1><b>CL_VorbisSoundProvider::~CL_VorbisSoundProvider</b></font></a> -   Vorbis Sound Provider Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_VorbisSoundProvider.html#1609"><tt><font color=blue><b>~CL_VorbisSoundProvider</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
<h2>Variable Member Descriptions:</h2>
<hr noshade>
</body>
</html>