| Current File : //proc/self/root/kunden/usr/share/doc/alsa-lib-devel/doxygen/html/group___p_c_m___hook.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ALSA project - the C library reference: Hook Extension</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ALSA project - the C library reference
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#files">Files</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Hook Extension<div class="ingroups"><a class="el" href="group___p_c_m.html">PCM Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:pcm__hooks_8c"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="pcm__hooks_8c.html">pcm_hooks.c</a></td></tr>
<tr class="memdesc:pcm__hooks_8c"><td class="mdescLeft"> </td><td class="mdescRight">PCM Hook Interface. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gae6b33860eeaf4eca00bdbef9383c1911"><td class="memItemLeft" align="right" valign="top">typedef struct _snd_pcm_hook </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a></td></tr>
<tr class="separator:gae6b33860eeaf4eca00bdbef9383c1911"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1f6104443e129a88c5ac82bf398464a5"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#ga1f6104443e129a88c5ac82bf398464a5">snd_pcm_hook_func_t</a>) (<a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> *hook)</td></tr>
<tr class="separator:ga1f6104443e129a88c5ac82bf398464a5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga57b6ba407d293017e116fa1b462a2411"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#ga57b6ba407d293017e116fa1b462a2411">snd_pcm_hook_type_t</a> { <b>SND_PCM_HOOK_TYPE_HW_PARAMS</b> = 0
, <b>SND_PCM_HOOK_TYPE_HW_FREE</b>
, <b>SND_PCM_HOOK_TYPE_CLOSE</b>
, <b>SND_PCM_HOOK_TYPE_LAST</b> = SND_PCM_HOOK_TYPE_CLOSE
}</td></tr>
<tr class="separator:ga57b6ba407d293017e116fa1b462a2411"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacaec88e4b6cc2a45e7a805487acd64ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_c_m.html#ga919e634deecd855b6e2e15174e70d3ea">snd_pcm_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#gacaec88e4b6cc2a45e7a805487acd64ed">snd_pcm_hook_get_pcm</a> (<a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> *hook)</td></tr>
<tr class="memdesc:gacaec88e4b6cc2a45e7a805487acd64ed"><td class="mdescLeft"> </td><td class="mdescRight">Get PCM handle for a PCM hook. <a href="group___p_c_m___hook.html#gacaec88e4b6cc2a45e7a805487acd64ed">More...</a><br /></td></tr>
<tr class="separator:gacaec88e4b6cc2a45e7a805487acd64ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1eb467cd5ab11817edc2ed7df3608019"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#ga1eb467cd5ab11817edc2ed7df3608019">snd_pcm_hook_get_private</a> (<a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> *hook)</td></tr>
<tr class="memdesc:ga1eb467cd5ab11817edc2ed7df3608019"><td class="mdescLeft"> </td><td class="mdescRight">Get callback function private data for a PCM hook. <a href="group___p_c_m___hook.html#ga1eb467cd5ab11817edc2ed7df3608019">More...</a><br /></td></tr>
<tr class="separator:ga1eb467cd5ab11817edc2ed7df3608019"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6930df3b750b3f62dee6846fb3f6a576"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#ga6930df3b750b3f62dee6846fb3f6a576">snd_pcm_hook_set_private</a> (<a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> *hook, void *private_data)</td></tr>
<tr class="memdesc:ga6930df3b750b3f62dee6846fb3f6a576"><td class="mdescLeft"> </td><td class="mdescRight">Set callback function private data for a PCM hook. <a href="group___p_c_m___hook.html#ga6930df3b750b3f62dee6846fb3f6a576">More...</a><br /></td></tr>
<tr class="separator:ga6930df3b750b3f62dee6846fb3f6a576"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga89eed2fdcda68c1efae9180a3794d5ef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#ga89eed2fdcda68c1efae9180a3794d5ef">snd_pcm_hook_add</a> (<a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> **hookp, <a class="el" href="group___p_c_m.html#ga919e634deecd855b6e2e15174e70d3ea">snd_pcm_t</a> *pcm, <a class="el" href="group___p_c_m___hook.html#ga57b6ba407d293017e116fa1b462a2411">snd_pcm_hook_type_t</a> <a class="el" href="ump__msg_8h.html#ad44b615021ed3ccb734fcaf583ef4a03">type</a>, <a class="el" href="group___p_c_m___hook.html#ga1f6104443e129a88c5ac82bf398464a5">snd_pcm_hook_func_t</a> func, void *private_data)</td></tr>
<tr class="memdesc:ga89eed2fdcda68c1efae9180a3794d5ef"><td class="mdescLeft"> </td><td class="mdescRight">Add a PCM hook at end of hooks chain. <a href="group___p_c_m___hook.html#ga89eed2fdcda68c1efae9180a3794d5ef">More...</a><br /></td></tr>
<tr class="separator:ga89eed2fdcda68c1efae9180a3794d5ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c59ad440d2479f957b477b26b90e4b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___hook.html#ga4c59ad440d2479f957b477b26b90e4b1">snd_pcm_hook_remove</a> (<a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> *hook)</td></tr>
<tr class="memdesc:ga4c59ad440d2479f957b477b26b90e4b1"><td class="mdescLeft"> </td><td class="mdescRight">Remove a PCM hook. <a href="group___p_c_m___hook.html#ga4c59ad440d2479f957b477b26b90e4b1">More...</a><br /></td></tr>
<tr class="separator:ga4c59ad440d2479f957b477b26b90e4b1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>See the <a class="el" href="pcm.html">PCM (digital audio) interface</a> page for more details. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga1f6104443e129a88c5ac82bf398464a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1f6104443e129a88c5ac82bf398464a5">◆ </a></span>snd_pcm_hook_func_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* snd_pcm_hook_func_t) (<a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> *hook)</td>
</tr>
</table>
</div><div class="memdoc">
<p>PCM hook callback function </p>
</div>
</div>
<a id="gae6b33860eeaf4eca00bdbef9383c1911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae6b33860eeaf4eca00bdbef9383c1911">◆ </a></span>snd_pcm_hook_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _snd_pcm_hook <a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PCM hook container </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga57b6ba407d293017e116fa1b462a2411"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57b6ba407d293017e116fa1b462a2411">◆ </a></span>snd_pcm_hook_type_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___p_c_m___hook.html#ga57b6ba407d293017e116fa1b462a2411">snd_pcm_hook_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>type of pcm hook </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga89eed2fdcda68c1efae9180a3794d5ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89eed2fdcda68c1efae9180a3794d5ef">◆ </a></span>snd_pcm_hook_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_hook_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> ** </td>
<td class="paramname"><em>hookp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga919e634deecd855b6e2e15174e70d3ea">snd_pcm_t</a> * </td>
<td class="paramname"><em>pcm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___p_c_m___hook.html#ga57b6ba407d293017e116fa1b462a2411">snd_pcm_hook_type_t</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___p_c_m___hook.html#ga1f6104443e129a88c5ac82bf398464a5">snd_pcm_hook_func_t</a> </td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>private_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a PCM hook at end of hooks chain. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hookp</td><td>Returned PCM hook handle </td></tr>
<tr><td class="paramname">pcm</td><td>PCM handle </td></tr>
<tr><td class="paramname">type</td><td>PCM hook type </td></tr>
<tr><td class="paramname">func</td><td>PCM hook callback function </td></tr>
<tr><td class="paramname">private_data</td><td>PCM hook private data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success otherwise a negative error code</dd></dl>
<p>Warning: an hook callback function cannot remove an hook of the same type different from itself </p>
</div>
</div>
<a id="gacaec88e4b6cc2a45e7a805487acd64ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacaec88e4b6cc2a45e7a805487acd64ed">◆ </a></span>snd_pcm_hook_get_pcm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_c_m.html#ga919e634deecd855b6e2e15174e70d3ea">snd_pcm_t</a>* snd_pcm_hook_get_pcm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> * </td>
<td class="paramname"><em>hook</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get PCM handle for a PCM hook. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hook</td><td>PCM hook handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>PCM handle </dd></dl>
</div>
</div>
<a id="ga1eb467cd5ab11817edc2ed7df3608019"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1eb467cd5ab11817edc2ed7df3608019">◆ </a></span>snd_pcm_hook_get_private()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* snd_pcm_hook_get_private </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> * </td>
<td class="paramname"><em>hook</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get callback function private data for a PCM hook. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hook</td><td>PCM hook handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>callback function private data </dd></dl>
</div>
</div>
<a id="ga4c59ad440d2479f957b477b26b90e4b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c59ad440d2479f957b477b26b90e4b1">◆ </a></span>snd_pcm_hook_remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_hook_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> * </td>
<td class="paramname"><em>hook</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a PCM hook. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hook</td><td>PCM hook handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success otherwise a negative error code</dd></dl>
<p>Warning: an hook callback cannot remove an hook of the same type different from itself </p>
</div>
</div>
<a id="ga6930df3b750b3f62dee6846fb3f6a576"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6930df3b750b3f62dee6846fb3f6a576">◆ </a></span>snd_pcm_hook_set_private()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_hook_set_private </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m___hook.html#gae6b33860eeaf4eca00bdbef9383c1911">snd_pcm_hook_t</a> * </td>
<td class="paramname"><em>hook</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>private_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set callback function private data for a PCM hook. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hook</td><td>PCM hook handle </td></tr>
<tr><td class="paramname">private_data</td><td>The private data value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>