<!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: Sound system (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><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>
<h1>Sound system</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsSndSysSoundFormat.html">csSndSysSoundFormat</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sound format. <a href="structcsSndSysSoundFormat.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysData.html">iSndSysData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sound data is an interface to the container object controlling raw sound data. <a href="structiSndSysData.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html">iSndSysListener</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sound listener is a unique object created by the sound renderer. <a href="structiSndSysListener.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysLoader.html">iSndSysLoader</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sound loader is used to load sound files given a raw input data stream. <a href="structiSndSysLoader.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysManager.html">iSndSysManager</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the sound manager for Crystal Space. <a href="structiSndSysManager.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRenderer.html">iSndSysRenderer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRendererCallback.html">iSndSysRendererCallback</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sound System renderer interface for callback notification. <a href="structiSndSysRendererCallback.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysRendererSoftware.html">iSndSysRendererSoftware</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Software renderer specific interface extensions. <a href="structiSndSysRendererSoftware.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSoftwareDriver.html">iSndSysSoftwareDriver</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the interface for the low-level, system-dependent sound driver that is used by the software sound renderer. <a href="structiSndSysSoftwareDriver.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSoftwareFilter3D.html">iSndSysSoftwareFilter3D</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A sound filter is an interface to an object that modifies sequences of sound samples. <a href="structiSndSysSoftwareFilter3D.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSoftwareFilter3DProperties.html">iSndSysSoftwareFilter3DProperties</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSoftwareOutputFilter.html">iSndSysSoftwareOutputFilter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Temporary filter interface definition. <a href="structiSndSysSoftwareOutputFilter.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSource.html">iSndSysSource</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSourceSoftware.html">iSndSysSourceSoftware</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysSourceSoftware3D.html">iSndSysSourceSoftware3D</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysStream.html">iSndSysStream</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The primary interface for a sound stream used by the audio system. <a href="structiSndSysStream.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysStreamCallback.html">iSndSysStreamCallback</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sound System stream interface for callback notification. <a href="structiSndSysStreamCallback.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysWrapper.html">iSndSysWrapper</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A wrapper/holder for a loaded sound. <a href="structiSndSysWrapper.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf71c4fd6249d7b489d926a61beed9cd7"></a><!-- doxytag: member="sndsys::CS_SNDSYS_DATA_UNKNOWN_SIZE" ref="gf71c4fd6249d7b489d926a61beed9cd7" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#gf71c4fd6249d7b489d926a61beed9cd7">CS_SNDSYS_DATA_UNKNOWN_SIZE</a> -1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g166882a13c2046e4baf3633479d7c229"></a><!-- doxytag: member="sndsys::CS_SNDSYS_SOURCE_DISTANCE_INFINITE" ref="g166882a13c2046e4baf3633479d7c229" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g166882a13c2046e4baf3633479d7c229">CS_SNDSYS_SOURCE_DISTANCE_INFINITE</a> -1.0f</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g166882a13c2046e4baf3633479d7c229"></a><!-- doxytag: member="sndsys::CS_SNDSYS_SOURCE_DISTANCE_INFINITE" ref="g166882a13c2046e4baf3633479d7c229" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g166882a13c2046e4baf3633479d7c229">CS_SNDSYS_SOURCE_DISTANCE_INFINITE</a> -1.0f</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g752cd34a8060cbf8e156bb6733470a47"></a><!-- doxytag: member="sndsys::CS_SNDSYS_SOURCE_PLAYING" ref="g752cd34a8060cbf8e156bb6733470a47" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g752cd34a8060cbf8e156bb6733470a47">CS_SNDSYS_SOURCE_PLAYING</a> 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gca656338c994f44004a2133324d0442a"></a><!-- doxytag: member="sndsys::CS_SNDSYS_SOURCE_STOPPED" ref="gca656338c994f44004a2133324d0442a" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#gca656338c994f44004a2133324d0442a">CS_SNDSYS_SOURCE_STOPPED</a> 0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3ec72a39bc01c6674b3d10bcf4ab2cb1"></a><!-- doxytag: member="sndsys::CS_SNDSYS_STREAM_DONTLOOP" ref="g3ec72a39bc01c6674b3d10bcf4ab2cb1" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g3ec72a39bc01c6674b3d10bcf4ab2cb1">CS_SNDSYS_STREAM_DONTLOOP</a> 0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g600ef21e35b75759590e6b5da1a29e71"></a><!-- doxytag: member="sndsys::CS_SNDSYS_STREAM_LOOP" ref="g600ef21e35b75759590e6b5da1a29e71" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g600ef21e35b75759590e6b5da1a29e71">CS_SNDSYS_STREAM_LOOP</a> 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g87fd29283c05296e9848f2a0ab15bf98"></a><!-- doxytag: member="sndsys::CS_SNDSYS_STREAM_PAUSED" ref="g87fd29283c05296e9848f2a0ab15bf98" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g87fd29283c05296e9848f2a0ab15bf98">CS_SNDSYS_STREAM_PAUSED</a> 0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g73fbf8bc2594975618d454114ead7dff"></a><!-- doxytag: member="sndsys::CS_SNDSYS_STREAM_UNPAUSED" ref="g73fbf8bc2594975618d454114ead7dff" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g73fbf8bc2594975618d454114ead7dff">CS_SNDSYS_STREAM_UNPAUSED</a> 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g815726dc75e493d0e6fa549f61fb1c8e"></a><!-- doxytag: member="sndsys::CSSNDSYS_SAMPLE_BIG_ENDIAN" ref="g815726dc75e493d0e6fa549f61fb1c8e" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g815726dc75e493d0e6fa549f61fb1c8e">CSSNDSYS_SAMPLE_BIG_ENDIAN</a> 0x01</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6c7477df4000fbdbc3babaae7c1d7c8"></a><!-- doxytag: member="sndsys::CSSNDSYS_SAMPLE_ENDIAN_MASK" ref="ga6c7477df4000fbdbc3babaae7c1d7c8" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#ga6c7477df4000fbdbc3babaae7c1d7c8">CSSNDSYS_SAMPLE_ENDIAN_MASK</a> 0x01</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6b792e4e1ef7251e5ed55efeedae435b"></a><!-- doxytag: member="sndsys::CSSNDSYS_SAMPLE_LITTLE_ENDIAN" ref="g6b792e4e1ef7251e5ed55efeedae435b" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g6b792e4e1ef7251e5ed55efeedae435b">CSSNDSYS_SAMPLE_LITTLE_ENDIAN</a> 0x00</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc8eb30abac5547e09b41e96e87100ff7"></a><!-- doxytag: member="sndsys::csSoundSample" ref="gc8eb30abac5547e09b41e96e87100ff7" args="" -->
typedef <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#gc8eb30abac5547e09b41e96e87100ff7">csSoundSample</a></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="group__sndsys.html#gg79e9f285d34216706a748fd7ba8941b74401fef783851d77029e6a74e4d6faee">CS_SND3D_DISABLE</a> = 0,
<a class="el" href="group__sndsys.html#gg79e9f285d34216706a748fd7ba8941b721804053f393ecd9b1ad79d9132179a1">CS_SND3D_RELATIVE</a>,
<a class="el" href="group__sndsys.html#gg79e9f285d34216706a748fd7ba8941b7b9f7a0ab979ba1e2456205bb8087f65e">CS_SND3D_ABSOLUTE</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Every sound stream must be created with one of these 3d modes. <a href="group__sndsys.html#g79e9f285d34216706a748fd7ba8941b7">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#g02040177da92d61fbeac3125aef7ddcc">SndSysFilterLocation</a> { <a class="el" href="group__sndsys.html#gg02040177da92d61fbeac3125aef7ddccacdc97af48f103e5138c4550b2e4bb4e">SS_FILTER_LOC_RENDEROUT</a> = 0,
<a class="el" href="group__sndsys.html#gg02040177da92d61fbeac3125aef7ddcc6115c9bfb5d0d7eb48216d72a6999f15">SS_FILTER_LOC_SOURCEOUT</a>,
<a class="el" href="group__sndsys.html#gg02040177da92d61fbeac3125aef7ddcc3c40153e851fd9895d67fa8f9de27495">SS_FILTER_LOC_SOURCEIN</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Possible locations at which filters may be installed into the sound system. <a href="group__sndsys.html#g02040177da92d61fbeac3125aef7ddcc">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gea9e554208f88a0736a09e6854d808da"></a><!-- doxytag: member="sndsys::CS_SNDSYS_STREAM_UNKNOWN_LENGTH" ref="gea9e554208f88a0736a09e6854d808da" args="" -->
const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sndsys.html#gea9e554208f88a0736a09e6854d808da">CS_SNDSYS_STREAM_UNKNOWN_LENGTH</a> = (size_t)-1</td></tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="g79e9f285d34216706a748fd7ba8941b7"></a><!-- doxytag: member="ss_stream.h::@76" ref="g79e9f285d34216706a748fd7ba8941b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Every sound stream must be created with one of these 3d modes.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="gg79e9f285d34216706a748fd7ba8941b74401fef783851d77029e6a74e4d6faee"></a><!-- doxytag: member="CS_SND3D_DISABLE" ref="gg79e9f285d34216706a748fd7ba8941b74401fef783851d77029e6a74e4d6faee" args="" -->CS_SND3D_DISABLE</em> </td><td>
Disable 3d effect. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg79e9f285d34216706a748fd7ba8941b721804053f393ecd9b1ad79d9132179a1"></a><!-- doxytag: member="CS_SND3D_RELATIVE" ref="gg79e9f285d34216706a748fd7ba8941b721804053f393ecd9b1ad79d9132179a1" args="" -->CS_SND3D_RELATIVE</em> </td><td>
Position of the sound is relative to the listener. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg79e9f285d34216706a748fd7ba8941b7b9f7a0ab979ba1e2456205bb8087f65e"></a><!-- doxytag: member="CS_SND3D_ABSOLUTE" ref="gg79e9f285d34216706a748fd7ba8941b7b9f7a0ab979ba1e2456205bb8087f65e" args="" -->CS_SND3D_ABSOLUTE</em> </td><td>
Position of the sound is absolute. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ss__stream_8h-source.html#l00045">45</a> of file <a class="el" href="ss__stream_8h-source.html">ss_stream.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g02040177da92d61fbeac3125aef7ddcc"></a><!-- doxytag: member="ss_filter.h::SndSysFilterLocation" ref="g02040177da92d61fbeac3125aef7ddcc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__sndsys.html#g02040177da92d61fbeac3125aef7ddcc">SndSysFilterLocation</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Possible locations at which filters may be installed into the sound system.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="gg02040177da92d61fbeac3125aef7ddccacdc97af48f103e5138c4550b2e4bb4e"></a><!-- doxytag: member="SS_FILTER_LOC_RENDEROUT" ref="gg02040177da92d61fbeac3125aef7ddccacdc97af48f103e5138c4550b2e4bb4e" args="" -->SS_FILTER_LOC_RENDEROUT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg02040177da92d61fbeac3125aef7ddcc6115c9bfb5d0d7eb48216d72a6999f15"></a><!-- doxytag: member="SS_FILTER_LOC_SOURCEOUT" ref="gg02040177da92d61fbeac3125aef7ddcc6115c9bfb5d0d7eb48216d72a6999f15" args="" -->SS_FILTER_LOC_SOURCEOUT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg02040177da92d61fbeac3125aef7ddcc3c40153e851fd9895d67fa8f9de27495"></a><!-- doxytag: member="SS_FILTER_LOC_SOURCEIN" ref="gg02040177da92d61fbeac3125aef7ddcc3c40153e851fd9895d67fa8f9de27495" args="" -->SS_FILTER_LOC_SOURCEIN</em> </td><td>
</td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ss__filter_8h-source.html#l00108">108</a> of file <a class="el" href="ss__filter_8h-source.html">ss_filter.h</a>.</p>
</div>
</div><p>
<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
>
1799
