<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>SDL_sound: Sound_Sample Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SDL_sound
 <span id="projectnumber">1.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">Sound_Sample Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents sound data in the process of being decoded.
<a href="structSound__Sample.html#details">More...</a></p>
<p><code>#include <<a class="el" href="SDL__sound_8h_source.html">SDL_sound.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:af9b14d108498631919187832d74efa11"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#af9b14d108498631919187832d74efa11">opaque</a></td></tr>
<tr class="separator:af9b14d108498631919187832d74efa11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03ef7710992520e65edacc9ad694b034"><td class="memItemLeft" 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#a03ef7710992520e65edacc9ad694b034">decoder</a></td></tr>
<tr class="separator:a03ef7710992520e65edacc9ad694b034"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca3059080501599b2fef90032122108d"><td class="memItemLeft" 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#aca3059080501599b2fef90032122108d">desired</a></td></tr>
<tr class="separator:aca3059080501599b2fef90032122108d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4862ebaacdb0d4ec3aa3f7874ef2b903"><td class="memItemLeft" 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#a4862ebaacdb0d4ec3aa3f7874ef2b903">actual</a></td></tr>
<tr class="separator:a4862ebaacdb0d4ec3aa3f7874ef2b903"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a160959b8f33b039d54e6a64452d3d9e7"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#a160959b8f33b039d54e6a64452d3d9e7">buffer</a></td></tr>
<tr class="separator:a160959b8f33b039d54e6a64452d3d9e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bd0273a97a4044e8dbf2bbba36ca176"><td class="memItemLeft" align="right" valign="top">Uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#a7bd0273a97a4044e8dbf2bbba36ca176">buffer_size</a></td></tr>
<tr class="separator:a7bd0273a97a4044e8dbf2bbba36ca176"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0aa7f52ce553407fdff6947b50626b2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625">Sound_SampleFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSound__Sample.html#a0aa7f52ce553407fdff6947b50626b2b">flags</a></td></tr>
<tr class="separator:a0aa7f52ce553407fdff6947b50626b2b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents sound data in the process of being decoded. </p>
<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. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a4862ebaacdb0d4ec3aa3f7874ef2b903"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSound__AudioInfo.html">Sound_AudioInfo</a> Sound_Sample::actual</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual audio format of sample. </p>
</div>
</div>
<a class="anchor" id="a160959b8f33b039d54e6a64452d3d9e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* Sound_Sample::buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decoded sound data lands in here. </p>
</div>
</div>
<a class="anchor" id="a7bd0273a97a4044e8dbf2bbba36ca176"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Uint32 Sound_Sample::buffer_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current size of (buffer), in bytes (Uint8). </p>
</div>
</div>
<a class="anchor" id="a03ef7710992520e65edacc9ad694b034"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structSound__DecoderInfo.html">Sound_DecoderInfo</a>* Sound_Sample::decoder</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decoder used for this sample. </p>
</div>
</div>
<a class="anchor" id="aca3059080501599b2fef90032122108d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSound__AudioInfo.html">Sound_AudioInfo</a> Sound_Sample::desired</td>
</tr>
</table>
</div><div class="memdoc">
<p>Desired audio format for conversion. </p>
</div>
</div>
<a class="anchor" id="a0aa7f52ce553407fdff6947b50626b2b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__sound_8h.html#abf2c8cef39e83f01531f0bf255bdc625">Sound_SampleFlags</a> Sound_Sample::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags relating to this sample. </p>
</div>
</div>
<a class="anchor" id="af9b14d108498631919187832d74efa11"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* Sound_Sample::opaque</td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal use only. Don't touch. </p>
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 22:15:33 for SDL_sound by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
