<!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>Hook Extension</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindex" href="examples.html">Examples</a> </center>
<hr><h1>Hook Extension<br>
<small>
[<a class="el" href="group___p_c_m.html">PCM Interface</a>]</small>
</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Files</h2></td></tr>
<tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="pcm__hooks_8c.html">pcm_hooks.c</a></td></tr>
<tr><td> </td><td><font size=-1><em>PCM Hook Interface.</em></font><br><br></td></tr>
<p>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef enum <a class="el" href="group___p_c_m___hook.html#a8">_snd_pcm_hook_type</a> </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a0">snd_pcm_hook_type_t</a></td></tr>
<tr><td nowrap align=right valign=top>typedef _snd_pcm_hook </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a></td></tr>
<tr><td nowrap align=right valign=top>typedef int(* </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a2">snd_pcm_hook_func_t</a> )(<a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> *hook)</td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a8">_snd_pcm_hook_type</a> </td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group___p_c_m.html#a20">snd_pcm_t</a> * </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a3">snd_pcm_hook_get_pcm</a> (<a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> *hook)</td></tr>
<tr><td> </td><td><font size=-1><em>Get PCM handle for a PCM hook.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a4">snd_pcm_hook_get_private</a> (<a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> *hook)</td></tr>
<tr><td> </td><td><font size=-1><em>Get callback function private data for a PCM hook.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a5">snd_pcm_hook_set_private</a> (<a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> *hook, void *private_data)</td></tr>
<tr><td> </td><td><font size=-1><em>Set callback function private data for a PCM hook.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a6">snd_pcm_hook_add</a> (<a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> **hookp, <a class="el" href="group___p_c_m.html#a20">snd_pcm_t</a> *pcm, <a class="el" href="group___p_c_m___hook.html#a0">snd_pcm_hook_type_t</a> type, <a class="el" href="group___p_c_m___hook.html#a2">snd_pcm_hook_func_t</a> func, void *private_data)</td></tr>
<tr><td> </td><td><font size=-1><em>Add a PCM hook at end of hooks chain.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group___p_c_m___hook.html#a7">snd_pcm_hook_remove</a> (<a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> *hook)</td></tr>
<tr><td> </td><td><font size=-1><em>Remove a PCM hook.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
See the <a href="pcm.html#pcm">PCM (digital audio) interface</a> page for more details. <hr><h2>Typedef Documentation</h2>
<a name="a2" doxytag="pcm.h::snd_pcm_hook_func_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef int(* snd_pcm_hook_func_t)(<a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> *hook)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
PCM hook callback function </td>
</tr>
</table>
<a name="a1" doxytag="pcm.h::snd_pcm_hook_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct _snd_pcm_hook snd_pcm_hook_t
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
PCM hook container </td>
</tr>
</table>
<a name="a0" doxytag="pcm.h::snd_pcm_hook_type_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef enum <a class="el" href="group___p_c_m___hook.html#a8">_snd_pcm_hook_type</a> snd_pcm_hook_type_t
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
type of pcm hook </td>
</tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a name="a8" doxytag="pcm.h::_snd_pcm_hook_type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum _snd_pcm_hook_type
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
type of pcm hook </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a6" doxytag="pcm.h::snd_pcm_hook_add"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int snd_pcm_hook_add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> ** </td>
<td class="mdname" nowrap> <em>hookp</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group___p_c_m.html#a20">snd_pcm_t</a> * </td>
<td class="mdname" nowrap> <em>pcm</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group___p_c_m___hook.html#a0">snd_pcm_hook_type_t</a> </td>
<td class="mdname" nowrap> <em>type</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group___p_c_m___hook.html#a2">snd_pcm_hook_func_t</a> </td>
<td class="mdname" nowrap> <em>func</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>private_data</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add a PCM hook at end of hooks chain.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hookp</em> </td><td>
Returned PCM hook handle </td></tr>
<tr><td valign=top><em>pcm</em> </td><td>
PCM handle </td></tr>
<tr><td valign=top><em>type</em> </td><td>
PCM hook type </td></tr>
<tr><td valign=top><em>func</em> </td><td>
PCM hook callback function </td></tr>
<tr><td valign=top><em>private_data</em> </td><td>
PCM hook private data </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
0 on success otherwise a negative error code</dl>Warning: an hook callback function cannot remove an hook of the same type different from itself </td>
</tr>
</table>
<a name="a3" doxytag="pcm.h::snd_pcm_hook_get_pcm"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group___p_c_m.html#a20">snd_pcm_t</a>* snd_pcm_hook_get_pcm </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>hook</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get PCM handle for a PCM hook.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hook</em> </td><td>
PCM hook handle </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
PCM handle </dl> </td>
</tr>
</table>
<a name="a4" doxytag="pcm.h::snd_pcm_hook_get_private"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* snd_pcm_hook_get_private </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>hook</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get callback function private data for a PCM hook.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hook</em> </td><td>
PCM hook handle </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
callback function private data </dl> </td>
</tr>
</table>
<a name="a7" doxytag="pcm.h::snd_pcm_hook_remove"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int snd_pcm_hook_remove </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>hook</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Remove a PCM hook.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hook</em> </td><td>
PCM hook handle </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
0 on success otherwise a negative error code</dl>Warning: an hook callback cannot remove an hook of the same type different from itself </td>
</tr>
</table>
<a name="a5" doxytag="pcm.h::snd_pcm_hook_set_private"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void snd_pcm_hook_set_private </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m___hook.html#a1">snd_pcm_hook_t</a> * </td>
<td class="mdname" nowrap> <em>hook</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>private_data</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set callback function private data for a PCM hook.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hook</em> </td><td>
PCM hook handle </td></tr>
<tr><td valign=top><em>private_data</em> </td><td>
The private data value </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Wed Apr 2 16:06:38 2003 for ALSA project - the C library reference by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
distrib
>
Mandriva
>
9.1
>
ppc
>
media
>
updates
>
by-pkgid
>
18785641029f14f23cccc82925607ace
>
files
>
60
