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

timer_query.c File Reference


Functions

int snd_timer_query_open (snd_timer_query_t **timer, const char *name, int mode)
 Opens a new connection to the timer query interface.

int snd_timer_query_open_lconf (snd_timer_query_t **timer, const char *name, int mode, snd_config_t *lconf)
 Opens a new connection to the timer query interface using local configuration.

int snd_timer_query_close (snd_timer_query_t *timer)
 close timer query handle

int snd_timer_query_next_device (snd_timer_query_t *timer, snd_timer_id_t *tid)
 obtain the next timer identification

int snd_timer_query_info (snd_timer_query_t *timer, snd_timer_ginfo_t *info)
 obtain the timer global information

int snd_timer_query_params (snd_timer_query_t *timer, snd_timer_gparams_t *params)
 set the timer global parameters

int snd_timer_query_status (snd_timer_query_t *timer, snd_timer_gstatus_t *status)
 get the timer global status

size_t snd_timer_id_sizeof ()
 get size of the snd_timer_id_t structure in bytes

int snd_timer_id_malloc (snd_timer_id_t **info)
 allocate a new snd_timer_id_t structure

void snd_timer_id_free (snd_timer_id_t *info)
 frees the snd_timer_id_t structure

void snd_timer_id_copy (snd_timer_id_t *dst, const snd_timer_id_t *src)
 copy one snd_timer_id_t structure to another

void snd_timer_id_set_class (snd_timer_id_t *tid, int dev_class)
 set timer class

int snd_timer_id_get_class (snd_timer_id_t *tid)
 get timer class

void snd_timer_id_set_sclass (snd_timer_id_t *tid, int dev_sclass)
 set timer sub-class

int snd_timer_id_get_sclass (snd_timer_id_t *tid)
 get timer sub-class

void snd_timer_id_set_card (snd_timer_id_t *tid, int card)
 set timer card

int snd_timer_id_get_card (snd_timer_id_t *tid)
 get timer card

void snd_timer_id_set_device (snd_timer_id_t *tid, int device)
 set timer device

int snd_timer_id_get_device (snd_timer_id_t *tid)
 get timer device

void snd_timer_id_set_subdevice (snd_timer_id_t *tid, int subdevice)
 set timer subdevice

int snd_timer_id_get_subdevice (snd_timer_id_t *tid)
 get timer subdevice


Detailed Description

Author:
Jaroslav Kysela <perex@suse.cz>
Date:
2001
Timer Query Interface is designed to obtain identification of timers.


Function Documentation

void snd_timer_id_copy snd_timer_id_t   dst,
const snd_timer_id_t   src
 

copy one snd_timer_id_t structure to another

Parameters:
dst  destination snd_timer_id_t structure
src  source snd_timer_id_t structure

void snd_timer_id_free snd_timer_id_t   info
 

frees the snd_timer_id_t structure

Parameters:
info  pointer to the snd_timer_id_t structure to free
Frees the given snd_timer_id_t structure using the standard free C library function.

int snd_timer_id_get_card snd_timer_id_t   tid
 

get timer card

Parameters:
params  pointer to snd_timer_id_t structure
Returns:
timer card number

int snd_timer_id_get_class snd_timer_id_t   tid
 

get timer class

Parameters:
tid  pointer to snd_timer_id_t structure
Returns:
timer class

int snd_timer_id_get_device snd_timer_id_t   tid
 

get timer device

Parameters:
params  pointer to snd_timer_id_t structure
Returns:
timer device number

int snd_timer_id_get_sclass snd_timer_id_t   tid
 

get timer sub-class

Parameters:
params  pointer to snd_timer_id_t structure
Returns:
timer sub-class

int snd_timer_id_get_subdevice snd_timer_id_t   tid
 

get timer subdevice

Parameters:
params  pointer to snd_timer_id_t structure
Returns:
timer subdevice number

int snd_timer_id_malloc snd_timer_id_t **    info
 

allocate a new snd_timer_id_t structure

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise a negative error code if fails
Allocates a new snd_timer_id_t structure using the standard malloc C library function.

void snd_timer_id_set_card snd_timer_id_t   tid,
int    card
 

set timer card

Parameters:
tid  pointer to snd_timer_id_t structure
card  card number

void snd_timer_id_set_class snd_timer_id_t   tid,
int    dev_class
 

set timer class

Parameters:
tid  pointer to snd_timer_id_t structure
dev_class  class of timer device

void snd_timer_id_set_device snd_timer_id_t   tid,
int    device
 

set timer device

Parameters:
tid  pointer to snd_timer_id_t structure
device  device number

void snd_timer_id_set_sclass snd_timer_id_t   tid,
int    dev_sclass
 

set timer sub-class

Parameters:
tid  pointer to snd_timer_id_t structure
dev_sclass  sub-class of timer device

void snd_timer_id_set_subdevice snd_timer_id_t   tid,
int    subdevice
 

set timer subdevice

Parameters:
tid  pointer to snd_timer_id_t structure
subdevice  subdevice number

size_t snd_timer_id_sizeof void   
 

get size of the snd_timer_id_t structure in bytes

Returns:
size of the snd_timer_id_t structure in bytes

int snd_timer_query_close snd_timer_query_t   timer
 

close timer query handle

Parameters:
timer  timer handle
Returns:
0 on success otherwise a negative error code
Closes the specified timer handle and frees all associated resources.

int snd_timer_query_info snd_timer_query_t   timer,
snd_timer_ginfo_t   info
 

obtain the timer global information

Parameters:
timer  timer handle
info  timer information
Returns:
0 on success otherwise a negative error code

int snd_timer_query_next_device snd_timer_query_t   timer,
snd_timer_id_t   tid
 

obtain the next timer identification

Parameters:
timer  timer handle
tid  timer identification
Returns:
0 on success otherwise a negative error code
if tid->dev_class is -1, then the first device is returned if result tid->dev_class is -1, no more devices are left

int snd_timer_query_open snd_timer_query_t **    timer,
const char *    name,
int    mode
 

Opens a new connection to the timer query interface.

Parameters:
timer  Returned handle (NULL if not wanted)
name  ASCII identifier of the RawMidi handle
mode  Open mode
Returns:
0 on success otherwise a negative error code
Opens a new connection to the RawMidi interface specified with an ASCII identifier and mode.

int snd_timer_query_open_lconf snd_timer_query_t **    timer,
const char *    name,
int    mode,
snd_config_t   lconf
 

Opens a new connection to the timer query interface using local configuration.

Parameters:
timer  Returned handle (NULL if not wanted)
name  ASCII identifier of the RawMidi handle
mode  Open mode
lconf  Local configuration
Returns:
0 on success otherwise a negative error code
Opens a new connection to the RawMidi interface specified with an ASCII identifier and mode.

int snd_timer_query_params snd_timer_query_t   timer,
snd_timer_gparams_t   params
 

set the timer global parameters

Parameters:
timer  timer handle
params  timer parameters
Returns:
0 on success otherwise a negative error code

int snd_timer_query_status snd_timer_query_t   timer,
snd_timer_gstatus_t   status
 

get the timer global status

Parameters:
timer  timer handle
status  timer status
Returns:
0 on success otherwise a negative error code


Generated on Fri Sep 3 11:05:46 2004 for ALSA project - the C library reference by doxygen1.2.18