<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: CS::SndSys::SndSysBasicData Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="namespaceCS_1_1SndSys.html">SndSys</a>::<a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html">SndSysBasicData</a></div>
<h1>CS::SndSys::SndSysBasicData Class Reference</h1><!-- doxytag: class="CS::SndSys::SndSysBasicData" --><!-- doxytag: inherits="scfImplementation1" --><div class="dynheader">
Inheritance diagram for CS::SndSys::SndSysBasicData:</div>
<div class="dynsection">
<p><center><img src="classCS_1_1SndSys_1_1SndSysBasicData__inherit__graph.png" border="0" usemap="#CS_1_1SndSys_1_1SndSysBasicData__inherit__map" alt="Inheritance graph"></center>
<map name="CS_1_1SndSys_1_1SndSysBasicData__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< CS::SndSys::SndSysBasicData, iSndSysData \>" alt="" coords="5,161,477,188"><area shape="rect" href="classscfImplementation.html" title="Baseclass for the SCF implementation templates." alt="" coords="139,84,344,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="132,7,188,33"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="212,7,433,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classCS_1_1SndSys_1_1SndSysBasicData-members.html">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 <a class="el" href="structiSndSysStream.html">iSndSysStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#ed95d7e0c88c142a1bc14db10a7ce08d">CreateStream</a> (<a class="el" href="structcsSndSysSoundFormat.html">csSndSysSoundFormat</a> *pRenderFormat, int Mode3D)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a stream associated with this sound data positioned at the begining of the sound data and initially paused if possible. <a href="#ed95d7e0c88c142a1bc14db10a7ce08d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#20ba69335e582ca52d326030c7b26dbc">GetDataSize</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the data stored in bytes. <a href="#20ba69335e582ca52d326030c7b26dbc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#a5988c9cd7b6b1edd2ac9abdf11bba79">GetDescription</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the description associated with this sound data. <a href="#a5988c9cd7b6b1edd2ac9abdf11bba79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="structcsSndSysSoundFormat.html">csSndSysSoundFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#3f42d77026ce4fd6f6ad95e145d666af">GetFormat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the format of the sound data. <a href="#3f42d77026ce4fd6f6ad95e145d666af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#86c4259f2f517f85cf6c84b679f1e552">GetFrameCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get size of this sound in frames. <a href="#86c4259f2f517f85cf6c84b679f1e552"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#2bbfd26e628c533a98a950ac6a9488ef">SetDescription</a> (const char *pDescription)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an optional description to be associated with this sound data. <a href="#2bbfd26e628c533a98a950ac6a9488ef"></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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#260ecd938c4eb1430ee2f289cee27709">Initialize</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is required to initialize the m_SampleCount and m_SoundFormat member variables. It is called internally. <a href="#260ecd938c4eb1430ee2f289cee27709"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#f895e33412560483c4d32d2ecfb776e9">m_bInfoReady</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating whether <a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#260ecd938c4eb1430ee2f289cee27709" title="This is required to initialize the m_SampleCount and m_SoundFormat member variables...">Initialize()</a> has been called yet. <a href="#f895e33412560483c4d32d2ecfb776e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#94fb2827f6247cb27de6807f6dd79a59">m_FrameCount</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of frames in the decoded output. <a href="#94fb2827f6247cb27de6807f6dd79a59"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#d2b107809bcac02d165df98c8bad7b9b">m_pDescription</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An optional brief description of the sound data. <a href="#d2b107809bcac02d165df98c8bad7b9b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcsSndSysSoundFormat.html">csSndSysSoundFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#bd3297c1100a80b7a720c88b9b76c789">m_SoundFormat</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The format that we're decoding the Ogg stream to. <a href="#bd3297c1100a80b7a720c88b9b76c789"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="snddata_8h-source.html#l00034">34</a> of file <a class="el" href="snddata_8h-source.html">snddata.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ed95d7e0c88c142a1bc14db10a7ce08d"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::CreateStream" ref="ed95d7e0c88c142a1bc14db10a7ce08d" args="(csSndSysSoundFormat *pRenderFormat, int Mode3D)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiSndSysStream.html">iSndSysStream</a>* CS::SndSys::SndSysBasicData::CreateStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcsSndSysSoundFormat.html">csSndSysSoundFormat</a> * </td>
<td class="paramname"> <em>pRenderFormat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>Mode3D</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a stream associated with this sound data positioned at the begining of the sound data and initially paused if possible.
<p>
</div>
</div><p>
<a class="anchor" name="20ba69335e582ca52d326030c7b26dbc"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::GetDataSize" ref="20ba69335e582ca52d326030c7b26dbc" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t CS::SndSys::SndSysBasicData::GetDataSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the size of the data stored in bytes.
<p>
This is informational only and is not guaranteed to be a number usable for sound calculations. For example, an audio file compressed with variable rate compression may result in a situation where FILE_SIZE is not equal to SAMPLE_COUNT * SAMPLE_SIZE since SAMPLE_SIZE may vary throughout the audio data.
</div>
</div><p>
<a class="anchor" name="a5988c9cd7b6b1edd2ac9abdf11bba79"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::GetDescription" ref="a5988c9cd7b6b1edd2ac9abdf11bba79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* CS::SndSys::SndSysBasicData::GetDescription </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the description associated with this sound data.
<p>
<p>Definition at line <a class="el" href="snddata_8h-source.html#l00087">87</a> of file <a class="el" href="snddata_8h-source.html">snddata.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3f42d77026ce4fd6f6ad95e145d666af"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::GetFormat" ref="3f42d77026ce4fd6f6ad95e145d666af" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcsSndSysSoundFormat.html">csSndSysSoundFormat</a>* CS::SndSys::SndSysBasicData::GetFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the format of the sound data.
<p>
</div>
</div><p>
<a class="anchor" name="86c4259f2f517f85cf6c84b679f1e552"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::GetFrameCount" ref="86c4259f2f517f85cf6c84b679f1e552" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t CS::SndSys::SndSysBasicData::GetFrameCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get size of this sound in frames.
<p>
</div>
</div><p>
<a class="anchor" name="260ecd938c4eb1430ee2f289cee27709"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::Initialize" ref="260ecd938c4eb1430ee2f289cee27709" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CS::SndSys::SndSysBasicData::Initialize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is required to initialize the m_SampleCount and m_SoundFormat member variables. It is called internally.
<p>
</div>
</div><p>
<a class="anchor" name="2bbfd26e628c533a98a950ac6a9488ef"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::SetDescription" ref="2bbfd26e628c533a98a950ac6a9488ef" args="(const char *pDescription)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CS::SndSys::SndSysBasicData::SetDescription </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pDescription</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set an optional description to be associated with this sound data.
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f895e33412560483c4d32d2ecfb776e9"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::m_bInfoReady" ref="f895e33412560483c4d32d2ecfb776e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#f895e33412560483c4d32d2ecfb776e9">CS::SndSys::SndSysBasicData::m_bInfoReady</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flag indicating whether <a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#260ecd938c4eb1430ee2f289cee27709" title="This is required to initialize the m_SampleCount and m_SoundFormat member variables...">Initialize()</a> has been called yet.
<p>
<p>Definition at line <a class="el" href="snddata_8h-source.html#l00095">95</a> of file <a class="el" href="snddata_8h-source.html">snddata.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="94fb2827f6247cb27de6807f6dd79a59"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::m_FrameCount" ref="94fb2827f6247cb27de6807f6dd79a59" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#94fb2827f6247cb27de6807f6dd79a59">CS::SndSys::SndSysBasicData::m_FrameCount</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number of frames in the decoded output.
<p>
<p>Definition at line <a class="el" href="snddata_8h-source.html#l00102">102</a> of file <a class="el" href="snddata_8h-source.html">snddata.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d2b107809bcac02d165df98c8bad7b9b"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::m_pDescription" ref="d2b107809bcac02d165df98c8bad7b9b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#d2b107809bcac02d165df98c8bad7b9b">CS::SndSys::SndSysBasicData::m_pDescription</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An optional brief description of the sound data.
<p>
<p>Definition at line <a class="el" href="snddata_8h-source.html#l00105">105</a> of file <a class="el" href="snddata_8h-source.html">snddata.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="bd3297c1100a80b7a720c88b9b76c789"></a><!-- doxytag: member="CS::SndSys::SndSysBasicData::m_SoundFormat" ref="bd3297c1100a80b7a720c88b9b76c789" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcsSndSysSoundFormat.html">csSndSysSoundFormat</a> <a class="el" href="classCS_1_1SndSys_1_1SndSysBasicData.html#bd3297c1100a80b7a720c88b9b76c789">CS::SndSys::SndSysBasicData::m_SoundFormat</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The format that we're decoding the Ogg stream to.
<p>
<p>Definition at line <a class="el" href="snddata_8h-source.html#l00099">99</a> of file <a class="el" href="snddata_8h-source.html">snddata.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csplugincommon/sndsys/<a class="el" href="snddata_8h-source.html">snddata.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
136
