mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-02 09:01:48 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

More documentation enhancements / removal of non-existent functions.

Browse source
This commit is contained in:
Jaroslav Kysela 2001-07-11 15:48:27 +00:00
parent 052be891a5
commit 3590f6ecd3
18 changed files with 153 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

44
src/control/cards.c
View file

@ -1,3 +1,8 @@
/**
* \file control/cards.c
* \author Jaroslav Kysela <perex@suse.cz>
* \date 1998-2001
*/
/*
* Control Interface - main file
* Copyright (c) 1998 by Jaroslav Kysela <perex@suse.cz>
@ -28,9 +33,16 @@
#include <sys/ioctl.h>
#include "control_local.h"
#ifndef DOC_HIDDEN
#define SND_FILE_CONTROL "/dev/snd/controlC%i"
#define SND_FILE_LOAD "/dev/aloadC%i"
#endif
/**
* \brief Try to load the driver for a card.
* \param card Card number.
* \return 1 if driver is present, zero if driver is not present
*/
int snd_card_load(int card)
{
int open_dev;
@ -47,9 +59,19 @@ int snd_card_load(int card)
close (open_dev);
return 0;
}
return open_dev;
return open_dev ? 1 : 0;
}
/**
* \brief Try to determine the next card.
* \param rcard pointer to card number
* \result zero if success, otherwise a negative error code
*
* Tries to determine the next card from given card number.
* If card number is -1, then the first available card is
* returned. If the result card number is -1, no more cards
* are available.
*/
int snd_card_next(int *rcard)
{
int card;
@ -68,6 +90,14 @@ int snd_card_next(int *rcard)
return 0;
}
/**
* \brief Convert card string to an integer value.
* \param string String containing card identifier
* \return zero if success, otherwise a negative error code
*
* The accepted format is an integer value in ASCII representation
* or the card identifier (snd_id parameter for soundcard drivers).
*/
int snd_card_get_index(const char *string)
{
int card;
@ -101,6 +131,12 @@ int snd_card_get_index(const char *string)
return -ENODEV;
}
/**
* \brief Obtain the card name.
* \param card Card number
* \param name Result - card name corresponding to card number
* \result zero if success, otherwise a negative error code
*/
int snd_card_get_name(int card, char **name)
{
snd_ctl_t *handle;
@ -122,6 +158,12 @@ int snd_card_get_name(int card, char **name)
return 0;
}
/**
* \brief Obtain the card long name.
* \param card Card number
* \param name Result - card long name corresponding to card number
* \result zero if success, otherwise a negative error code
*/
int snd_card_get_longname(int card, char **name)
{
snd_ctl_t *handle;

24
src/control/setup.c
View file

@ -72,6 +72,11 @@ static int free_elems(snd_sctl_t *h)
return err;
}
/**
* \brief Install given values to control elements
* \param h Setup control handle
* \result zero if success, otherwise a negative error code
*/
int snd_sctl_install(snd_sctl_t *h)
{
struct list_head *pos;
@ -165,6 +170,11 @@ int snd_sctl_install(snd_sctl_t *h)
return 0;
}
/**
* \brief Remove (restore) previous values from control elements
* \param h Setup control handle
* \result zero if success, otherwise a negative error code
*/
int snd_sctl_remove(snd_sctl_t *h)
{
struct list_head *pos;
@ -556,6 +566,15 @@ static int add_elem(snd_sctl_t *h, snd_config_t *_conf, void *private_data)
return err;
}
/**
* \brief Build setup control handle
* \param sctl Result - setup control handle
* \param handle Master control handle
* \param conf Setup configuration
* \param private_data Private data for runtime evaluation
* \param mode Build mode - SND_SCTL_xxxx
* \result zero if success, otherwise a negative error code
*/
int snd_sctl_build(snd_sctl_t **sctl, snd_ctl_t *handle, snd_config_t *conf, void *private_data, int mode)
{
snd_sctl_t *h;
@ -589,6 +608,11 @@ int snd_sctl_build(snd_sctl_t **sctl, snd_ctl_t *handle, snd_config_t *conf, voi
return 0;
}
/**
* \brief Free setup control handle
* \param sctl Setup control handle
* \result zero if success, otherwise a negative error code
*/
int snd_sctl_free(snd_sctl_t *sctl)
{
assert(sctl);