<!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"/>
<title>gavl: Volume control</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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gavl</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Volume control</h1> </div>
<div class="ingroups"><a class="el" href="group__audio.html">Audio</a></div></div>
<div class="contents">
<p>Simple volume control.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
gavl_volume_control_s </td><td class="memItemRight" valign="bottom"><a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure for a volume control. <a href="#gae8781d6999b54e43aaadce7276608094"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__volume__control.html#ga25e0769a204694c823a5479f2523b22e">gavl_volume_control_create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create volume control. <a href="#ga25e0769a204694c823a5479f2523b22e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__volume__control.html#ga78702c1703b4246993d2100f6bf1ba21">gavl_volume_control_destroy</a> (<a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> *ctrl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys a volume control and frees all associated memory. <a href="#ga78702c1703b4246993d2100f6bf1ba21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__volume__control.html#gad02d09ed3342b5aab75c1d96287e7907">gavl_volume_control_set_format</a> (<a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> *ctrl, const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set format for a volume control. <a href="#gad02d09ed3342b5aab75c1d96287e7907"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__volume__control.html#ga3de60cc1345fb95f4f262a1665b6360e">gavl_volume_control_set_volume</a> (<a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> *ctrl, float volume)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set volume for a volume control. <a href="#ga3de60cc1345fb95f4f262a1665b6360e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__volume__control.html#ga3ebf8e61c37d0c4eb5510dbf23fc2826">gavl_volume_control_apply</a> (<a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> *ctrl, <a class="el" href="structgavl__audio__frame__t.html">gavl_audio_frame_t</a> *frame)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply a volume control for an audio frame. <a href="#ga3ebf8e61c37d0c4eb5510dbf23fc2826"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Simple volume control. </p>
<p>This is a very simple software volume control. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gae8781d6999b54e43aaadce7276608094"></a><!-- doxytag: member="gavl.h::gavl_volume_control_t" ref="gae8781d6999b54e43aaadce7276608094" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct gavl_volume_control_s <a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opaque structure for a volume control. </p>
<p>You don't want to know what's inside. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga25e0769a204694c823a5479f2523b22e"></a><!-- doxytag: member="gavl.h::gavl_volume_control_create" ref="ga25e0769a204694c823a5479f2523b22e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC <a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a>* gavl_volume_control_create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create volume control. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated volume control </dd></dl>
</div>
</div>
<a class="anchor" id="ga78702c1703b4246993d2100f6bf1ba21"></a><!-- doxytag: member="gavl.h::gavl_volume_control_destroy" ref="ga78702c1703b4246993d2100f6bf1ba21" args="(gavl_volume_control_t *ctrl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_volume_control_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> * </td>
<td class="paramname"><em>ctrl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys a volume control and frees all associated memory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctrl</td><td>A volume control </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad02d09ed3342b5aab75c1d96287e7907"></a><!-- doxytag: member="gavl.h::gavl_volume_control_set_format" ref="gad02d09ed3342b5aab75c1d96287e7907" args="(gavl_volume_control_t *ctrl, const gavl_audio_format_t *format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_volume_control_set_format </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> * </td>
<td class="paramname"><em>ctrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set format for a volume control. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctrl</td><td>A volume control </td></tr>
<tr><td class="paramname">format</td><td>The format subsequent frames will be passed with This function can be called multiple times with one instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3de60cc1345fb95f4f262a1665b6360e"></a><!-- doxytag: member="gavl.h::gavl_volume_control_set_volume" ref="ga3de60cc1345fb95f4f262a1665b6360e" args="(gavl_volume_control_t *ctrl, float volume)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_volume_control_set_volume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> * </td>
<td class="paramname"><em>ctrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set volume for a volume control. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctrl</td><td>A volume control </td></tr>
<tr><td class="paramname">volume</td><td>Volume in dB (must be <= 0.0 to prevent overflows) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3ebf8e61c37d0c4eb5510dbf23fc2826"></a><!-- doxytag: member="gavl.h::gavl_volume_control_apply" ref="ga3ebf8e61c37d0c4eb5510dbf23fc2826" args="(gavl_volume_control_t *ctrl, gavl_audio_frame_t *frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_volume_control_apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__volume__control.html#gae8781d6999b54e43aaadce7276608094">gavl_volume_control_t</a> * </td>
<td class="paramname"><em>ctrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgavl__audio__frame__t.html">gavl_audio_frame_t</a> * </td>
<td class="paramname"><em>frame</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Apply a volume control for an audio frame. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ctrl</td><td>A volume control </td></tr>
<tr><td class="paramname">frame</td><td>An audio frame </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sat Mar 26 2011 for gavl by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
