Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages   Examples  

pcm_hooks.c File Reference

PCM Hook Interface. More...


Functions

int snd_pcm_hooks_open (snd_pcm_t **pcmp, const char *name, snd_pcm_t *slave, int close_slave)
 Creates a new hooks PCM.

int _snd_pcm_hooks_open (snd_pcm_t **pcmp, const char *name, snd_config_t *root, snd_config_t *conf, snd_pcm_stream_t stream, int mode)
 Creates a new hooks PCM.

snd_pcm_tsnd_pcm_hook_get_pcm (snd_pcm_hook_t *hook)
 Get PCM handle for a PCM hook.

void * snd_pcm_hook_get_private (snd_pcm_hook_t *hook)
 Get callback function private data for a PCM hook.

void snd_pcm_hook_set_private (snd_pcm_hook_t *hook, void *private_data)
 Set callback function private data for a PCM hook.

int snd_pcm_hook_add (snd_pcm_hook_t **hookp, snd_pcm_t *pcm, snd_pcm_hook_type_t type, snd_pcm_hook_func_t func, void *private_data)
 Add a PCM hook at end of hooks chain.

int snd_pcm_hook_remove (snd_pcm_hook_t *hook)
 Remove a PCM hook.

int _snd_pcm_hook_ctl_elems_install (snd_pcm_t *pcm, snd_config_t *conf)
 Install CTL settings using hardware associated with PCM handle.


Detailed Description

PCM Hook Interface.

Author:
Abramo Bagnara <abramo@alsa-project.org> , Jaroslav Kysela <perex@suse.cz>
Date:
2000-2001

Function Documentation

int _snd_pcm_hook_ctl_elems_install snd_pcm_t   pcm,
snd_config_t   conf
 

Install CTL settings using hardware associated with PCM handle.

Parameters:
pcm  PCM handle
conf  Configuration node with CTL settings
Returns:
zero on success otherwise a negative error code

int _snd_pcm_hooks_open snd_pcm_t **    pcmp,
const char *    name,
snd_config_t   root,
snd_config_t   conf,
snd_pcm_stream_t    stream,
int    mode
 

Creates a new hooks PCM.

Parameters:
pcmp  Returns created PCM handle
name  Name of PCM
root  Root configuration node
conf  Configuration node with hooks PCM description
stream  PCM Stream
mode  PCM Mode
Return values:
zero  on success otherwise a negative error code
Warning:
Using of this function might be dangerous in the sense of compatibility reasons. The prototype might be freely changed in future.

int snd_pcm_hook_add snd_pcm_hook_t **    hookp,
snd_pcm_t   pcm,
snd_pcm_hook_type_t    type,
snd_pcm_hook_func_t    func,
void *    private_data
 

Add a PCM hook at end of hooks chain.

Parameters:
hookp  Returned PCM hook handle
pcm  PCM handle
type  PCM hook type
func  PCM hook callback function
private_data  PCM hook private data
Returns:
0 on success otherwise a negative error code
Warning: an hook callback function cannot remove an hook of the same type different from itself

snd_pcm_t* snd_pcm_hook_get_pcm snd_pcm_hook_t   hook
 

Get PCM handle for a PCM hook.

Parameters:
hook  PCM hook handle
Returns:
PCM handle

void* snd_pcm_hook_get_private snd_pcm_hook_t   hook
 

Get callback function private data for a PCM hook.

Parameters:
hook  PCM hook handle
Returns:
callback function private data

int snd_pcm_hook_remove snd_pcm_hook_t   hook
 

Remove a PCM hook.

Parameters:
hook  PCM hook handle
Returns:
0 on success otherwise a negative error code
Warning: an hook callback cannot remove an hook of the same type different from itself

void snd_pcm_hook_set_private snd_pcm_hook_t   hook,
void *    private_data
 

Set callback function private data for a PCM hook.

Parameters:
hook  PCM hook handle
private_data  The private data value

int snd_pcm_hooks_open snd_pcm_t **    pcmp,
const char *    name,
snd_pcm_t   slave,
int    close_slave
 

Creates a new hooks PCM.

Parameters:
pcmp  Returns created PCM handle
name  Name of PCM
slave  Slave PCM
close_slave  If set, slave PCM handle is closed when hooks PCM is closed
Return values:
zero  on success otherwise a negative error code
Warning:
Using of this function might be dangerous in the sense of compatibility reasons. The prototype might be freely changed in future.


Generated on Wed Feb 19 12:45:33 2003 for ALSA project - the C library reference by doxygen1.2.18