<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>SDL_sound: Sound_Sample Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div> <div class="contents"> <h1>Sound_Sample Struct Reference</h1><!-- doxytag: class="Sound_Sample" -->Represents sound data in the process of being decoded. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="SDL__sound_8h_source.html">SDL_sound.h</a>></code> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#f9b14d108498631919187832d74efa11">opaque</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structSound__DecoderInfo.html">Sound_DecoderInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#03ef7710992520e65edacc9ad694b034">decoder</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structSound__AudioInfo.html">Sound_AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#ca3059080501599b2fef90032122108d">desired</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structSound__AudioInfo.html">Sound_AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#4862ebaacdb0d4ec3aa3f7874ef2b903">actual</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#160959b8f33b039d54e6a64452d3d9e7">buffer</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">Uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#7bd0273a97a4044e8dbf2bbba36ca176">buffer_size</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="SDL__sound_8h.html#bf2c8cef39e83f01531f0bf255bdc625">Sound_SampleFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#0aa7f52ce553407fdff6947b50626b2b">flags</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Represents sound data in the process of being decoded. <p> The <a class="el" href="structSound__Sample.html" title="Represents sound data in the process of being decoded.">Sound_Sample</a> structure is the heart of SDL_sound. This holds information about a source of sound data as it is being decoded. EVERY FIELD IN THIS IS READ-ONLY. Please use the API functions to change them. <hr><h2>Field Documentation</h2> <a class="anchor" name="4862ebaacdb0d4ec3aa3f7874ef2b903"></a><!-- doxytag: member="Sound_Sample::actual" ref="4862ebaacdb0d4ec3aa3f7874ef2b903" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structSound__AudioInfo.html">Sound_AudioInfo</a> <a class="el" href="structSound__Sample.html#4862ebaacdb0d4ec3aa3f7874ef2b903">Sound_Sample::actual</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Actual audio format of sample. </div> </div><p> <a class="anchor" name="160959b8f33b039d54e6a64452d3d9e7"></a><!-- doxytag: member="Sound_Sample::buffer" ref="160959b8f33b039d54e6a64452d3d9e7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* <a class="el" href="structSound__Sample.html#160959b8f33b039d54e6a64452d3d9e7">Sound_Sample::buffer</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Decoded sound data lands in here. </div> </div><p> <a class="anchor" name="7bd0273a97a4044e8dbf2bbba36ca176"></a><!-- doxytag: member="Sound_Sample::buffer_size" ref="7bd0273a97a4044e8dbf2bbba36ca176" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Uint32 <a class="el" href="structSound__Sample.html#7bd0273a97a4044e8dbf2bbba36ca176">Sound_Sample::buffer_size</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Current size of (buffer), in bytes (Uint8). </div> </div><p> <a class="anchor" name="03ef7710992520e65edacc9ad694b034"></a><!-- doxytag: member="Sound_Sample::decoder" ref="03ef7710992520e65edacc9ad694b034" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="structSound__DecoderInfo.html">Sound_DecoderInfo</a>* <a class="el" href="structSound__Sample.html#03ef7710992520e65edacc9ad694b034">Sound_Sample::decoder</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Decoder used for this sample. </div> </div><p> <a class="anchor" name="ca3059080501599b2fef90032122108d"></a><!-- doxytag: member="Sound_Sample::desired" ref="ca3059080501599b2fef90032122108d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structSound__AudioInfo.html">Sound_AudioInfo</a> <a class="el" href="structSound__Sample.html#ca3059080501599b2fef90032122108d">Sound_Sample::desired</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Desired audio format for conversion. </div> </div><p> <a class="anchor" name="0aa7f52ce553407fdff6947b50626b2b"></a><!-- doxytag: member="Sound_Sample::flags" ref="0aa7f52ce553407fdff6947b50626b2b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="SDL__sound_8h.html#bf2c8cef39e83f01531f0bf255bdc625">Sound_SampleFlags</a> <a class="el" href="structSound__Sample.html#0aa7f52ce553407fdff6947b50626b2b">Sound_Sample::flags</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Flags relating to this sample. </div> </div><p> <a class="anchor" name="f9b14d108498631919187832d74efa11"></a><!-- doxytag: member="Sound_Sample::opaque" ref="f9b14d108498631919187832d74efa11" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* <a class="el" href="structSound__Sample.html#f9b14d108498631919187832d74efa11">Sound_Sample::opaque</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Internal use only. Don't touch. </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="SDL__sound_8h_source.html">SDL_sound.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Thu Aug 20 13:53:21 2009 for SDL_sound by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>