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

pcm_extplug.c File Reference

External Filter Plugin SDK. More...


Functions

int snd_pcm_extplug_create (snd_pcm_extplug_t *extplug, const char *name, snd_config_t *root, snd_config_t *slave_conf, snd_pcm_stream_t stream, int mode)
 Create an extplug instance.
int snd_pcm_extplug_delete (snd_pcm_extplug_t *extplug)
 Delete the extplug instance.
void snd_pcm_extplug_params_reset (snd_pcm_extplug_t *extplug)
 Reset extplug parameters.
int snd_pcm_extplug_set_slave_param_list (snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list)
 Set slave parameter as the list.
int snd_pcm_extplug_set_slave_param_minmax (snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max)
 Set slave parameter as the min/max values.
int snd_pcm_extplug_set_param_list (snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list)
 Set master parameter as the list.
int snd_pcm_extplug_set_param_minmax (snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max)
 Set master parameter as the min/max values.


Detailed Description

External Filter Plugin SDK.

Author:
Takashi Iwai <tiwai@suse.de>
Date:
2005

Function Documentation

int snd_pcm_extplug_create snd_pcm_extplug_t *  extplug,
const char *  name,
snd_config_t root,
snd_config_t slave_conf,
snd_pcm_stream_t  stream,
int  mode
 

Create an extplug instance.

Parameters:
extplug the extplug handle
name name of the PCM
root configuration tree root
slave_conf slave configuration root
stream stream direction
mode PCM open mode
Returns:
0 if successful, or a negative error code
Creates the extplug instance based on the given handle. The slave_conf argument is mandatory, and usually taken from the config tree of the PCM plugin as "slave" config value. name, root, stream and mode arguments are the values used for opening the PCM.

The callback is the mandatory field of extplug handle. At least, transfer callback must be set before calling this function.

int snd_pcm_extplug_delete snd_pcm_extplug_t *  extplug  ) 
 

Delete the extplug instance.

Parameters:
extplug the extplug handle to delete
Returns:
0 if successful, or a negative error code
The destructor of extplug instance. Closes the PCM and deletes the associated resources.

void snd_pcm_extplug_params_reset snd_pcm_extplug_t *  extplug  ) 
 

Reset extplug parameters.

Parameters:
extplug the extplug handle
Resets the all parameters for the given extplug handle.

int snd_pcm_extplug_set_param_list snd_pcm_extplug_t *  extplug,
int  type,
unsigned int  num_list,
const unsigned int *  list
 

Set master parameter as the list.

Parameters:
extplug the extplug handle
type parameter type
num_list number of available values
list the list of available values
Returns:
0 if successful, or a negative error code
Sets the master parameter as the list. The available values of the given parameter type of this PCM (as input) is restricted to the ones of the given list.

int snd_pcm_extplug_set_param_minmax snd_pcm_extplug_t *  extplug,
int  type,
unsigned int  min,
unsigned int  max
 

Set master parameter as the min/max values.

Parameters:
extplug the extplug handle
type parameter type
min the minimum value
max the maximum value
Returns:
0 if successful, or a negative error code
Sets the master parameter as the min/max values. The available values of the given parameter type of this PCM (as input) is restricted between the given minimum and maximum values.

int snd_pcm_extplug_set_slave_param_list snd_pcm_extplug_t *  extplug,
int  type,
unsigned int  num_list,
const unsigned int *  list
 

Set slave parameter as the list.

Parameters:
extplug the extplug handle
type parameter type
num_list number of available values
list the list of available values
Returns:
0 if successful, or a negative error code
Sets the slave parameter as the list. The available values of the given parameter type of the slave PCM is restricted to the ones of the given list.

int snd_pcm_extplug_set_slave_param_minmax snd_pcm_extplug_t *  extplug,
int  type,
unsigned int  min,
unsigned int  max
 

Set slave parameter as the min/max values.

Parameters:
extplug the extplug handle
type parameter type
min the minimum value
max the maximum value
Returns:
0 if successful, or a negative error code
Sets the slave parameter as the min/max values. The available values of the given parameter type of the slave PCM is restricted between the given minimum and maximum values.


Generated on Fri May 27 10:32:54 2005 for ALSA project - the C library reference by  doxygen 1.4.2