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

timer.h File Reference

Application interface library for the ALSA driver. More...

Go to the source code of this file.

Data Structures

struct  _snd_timer_read

Defines

#define SND_TIMER_DLSYM_VERSION   _dlsym_timer_001
#define SND_TIMER_QUERY_DLSYM_VERSION   _dlsym_timer_query_001
#define SND_TIMER_GLOBAL_SYSTEM   0
#define SND_TIMER_GLOBAL_RTC   1
#define SND_TIMER_OPEN_NONBLOCK   0x0001
#define snd_timer_id_alloca(ptr)   do { assert(ptr); *ptr = (snd_timer_id_t *) alloca(snd_timer_id_sizeof()); memset(*ptr, 0, snd_timer_id_sizeof()); } while (0)
#define snd_timer_info_alloca(ptr)   do { assert(ptr); *ptr = (snd_timer_info_t *) alloca(snd_timer_info_sizeof()); memset(*ptr, 0, snd_timer_info_sizeof()); } while (0)
#define snd_timer_params_alloca(ptr)   do { assert(ptr); *ptr = (snd_timer_params_t *) alloca(snd_timer_params_sizeof()); memset(*ptr, 0, snd_timer_params_sizeof()); } while (0)
#define snd_timer_status_alloca(ptr)   do { assert(ptr); *ptr = (snd_timer_status_t *) alloca(snd_timer_status_sizeof()); memset(*ptr, 0, snd_timer_status_sizeof()); } while (0)

Typedefs

typedef _snd_timer_id snd_timer_id_t
typedef _snd_timer_info snd_timer_info_t
typedef _snd_timer_params snd_timer_params_t
typedef _snd_timer_status snd_timer_status_t
typedef _snd_timer_read snd_timer_read_t
typedef enum _snd_timer_class snd_timer_class_t
typedef enum _snd_timer_slave_class snd_timer_slave_class_t
typedef enum _snd_timer_type snd_timer_type_t
typedef _snd_timer_query snd_timer_query_t
typedef _snd_timer snd_timer_t

Enumerations

enum  _snd_timer_class {
  SND_TIMER_CLASS_NONE = -1, SND_TIMER_CLASS_SLAVE = 0, SND_TIMER_CLASS_GLOBAL, SND_TIMER_CLASS_CARD,
  SND_TIMER_CLASS_PCM, SND_TIMER_CLASS_LAST = SND_TIMER_CLASS_PCM
}
enum  _snd_timer_slave_class {
  SND_TIMER_SCLASS_NONE = 0, SND_TIMER_SCLASS_APPLICATION, SND_TIMER_SCLASS_SEQUENCER, SND_TIMER_SCLASS_OSS_SEQUENCER,
  SND_TIMER_SCLASS_LAST = SND_TIMER_SCLASS_OSS_SEQUENCER
}
enum  _snd_timer_type { SND_TIMER_TYPE_HW = 0, SND_TIMER_TYPE_SHM, SND_TIMER_TYPE_INET }

Functions

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

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

int snd_timer_query_close (snd_timer_query_t *handle)
 close timer query handle. More...

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

int snd_timer_open (snd_timer_t **handle, const char *name, int mode)
 Opens a new connection to the timer interface. More...

int snd_timer_open_lconf (snd_timer_t **handle, const char *name, int mode, snd_config_t *lconf)
 Opens a new connection to the timer interface using local configuration. More...

int snd_timer_close (snd_timer_t *handle)
 close timer handle. More...

int snd_timer_poll_descriptors_count (snd_timer_t *handle)
 get count of poll descriptors for timer handle. More...

int snd_timer_poll_descriptors (snd_timer_t *handle, struct pollfd *pfds, unsigned int space)
 get poll descriptors. More...

int snd_timer_poll_descriptors_revents (snd_timer_t *timer, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
 get returned events from poll descriptors. More...

int snd_timer_info (snd_timer_t *handle, snd_timer_info_t *timer)
 get information about timer handle. More...

int snd_timer_params (snd_timer_t *handle, snd_timer_params_t *params)
 set parameters for timer handle. More...

int snd_timer_status (snd_timer_t *handle, snd_timer_status_t *status)
 get status from timer handle. More...

int snd_timer_start (snd_timer_t *handle)
 start the timer. More...

int snd_timer_stop (snd_timer_t *handle)
 stop the timer. More...

int snd_timer_continue (snd_timer_t *handle)
 continue the timer. More...

ssize_t snd_timer_read (snd_timer_t *handle, void *buffer, size_t size)
 read bytes using timer handle. More...

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

int snd_timer_id_malloc (snd_timer_id_t **ptr)
 allocate a new snd_timer_id_t structure. More...

void snd_timer_id_free (snd_timer_id_t *obj)
 frees the snd_timer_id_t structure. More...

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. More...

void snd_timer_id_set_class (snd_timer_id_t *id, int dev_class)
 set timer class. More...

int snd_timer_id_get_class (snd_timer_id_t *id)
 get timer class. More...

void snd_timer_id_set_sclass (snd_timer_id_t *id, int dev_sclass)
 set timer sub-class. More...

int snd_timer_id_get_sclass (snd_timer_id_t *id)
 get timer sub-class. More...

void snd_timer_id_set_card (snd_timer_id_t *id, int card)
 set timer card. More...

int snd_timer_id_get_card (snd_timer_id_t *id)
 get timer card. More...

void snd_timer_id_set_device (snd_timer_id_t *id, int device)
 set timer device. More...

int snd_timer_id_get_device (snd_timer_id_t *id)
 get timer device. More...

void snd_timer_id_set_subdevice (snd_timer_id_t *id, int subdevice)
 set timer subdevice. More...

int snd_timer_id_get_subdevice (snd_timer_id_t *id)
 get timer subdevice. More...

size_t snd_timer_info_sizeof (void)
 get size of the snd_timer_info_t structure in bytes. More...

int snd_timer_info_malloc (snd_timer_info_t **ptr)
 allocate a new snd_timer_info_t structure. More...

void snd_timer_info_free (snd_timer_info_t *obj)
 frees the snd_timer_info_t structure. More...

void snd_timer_info_copy (snd_timer_info_t *dst, const snd_timer_info_t *src)
 copy one snd_timer_info_t structure to another. More...

int snd_timer_info_is_slave (snd_timer_info_t *info)
 determine, if timer is slave. More...

int snd_timer_info_get_card (snd_timer_info_t *info)
 get timer card. More...

const char * snd_timer_info_get_id (snd_timer_info_t *info)
 get timer id. More...

const char * snd_timer_info_get_name (snd_timer_info_t *info)
 get timer name. More...

long snd_timer_info_get_ticks (snd_timer_info_t *info)
 get maximum timer ticks. More...

long snd_timer_info_get_resolution (snd_timer_info_t *info)
 get timer resolution in us. More...

size_t snd_timer_params_sizeof (void)
 get size of the snd_timer_params_t structure in bytes. More...

int snd_timer_params_malloc (snd_timer_params_t **ptr)
 allocate a new snd_timer_params_t structure. More...

void snd_timer_params_free (snd_timer_params_t *obj)
 frees the snd_timer_params_t structure. More...

void snd_timer_params_copy (snd_timer_params_t *dst, const snd_timer_params_t *src)
 copy one snd_timer_params_t structure to another. More...

void snd_timer_params_set_auto_start (snd_timer_params_t *params, int auto_start)
 set timer auto start. More...

void snd_timer_params_set_ticks (snd_timer_params_t *params, long ticks)
 set timer ticks. More...

long snd_timer_params_get_ticks (snd_timer_params_t *params)
 get timer ticks. More...

void snd_timer_params_set_queue_size (snd_timer_params_t *params, long queue_size)
 set timer queue size (32-1024). More...

long snd_timer_params_get_queue_size (snd_timer_params_t *params)
 get queue size. More...

size_t snd_timer_status_sizeof (void)
 get size of the snd_timer_status_t structure in bytes. More...

int snd_timer_status_malloc (snd_timer_status_t **ptr)
 allocate a new snd_timer_status_t structure. More...

void snd_timer_status_free (snd_timer_status_t *obj)
 frees the snd_timer_status_t structure. More...

void snd_timer_status_copy (snd_timer_status_t *dst, const snd_timer_status_t *src)
 copy one snd_timer_status_t structure to another. More...

timeval snd_timer_status_get_timestamp (snd_timer_status_t *status)
 get timestamp. More...

long snd_timer_status_get_resolution (snd_timer_status_t *status)
 get resolution in us. More...

long snd_timer_status_get_lost (snd_timer_status_t *status)
 get master tick lost count. More...

long snd_timer_status_get_overrun (snd_timer_status_t *status)
 get overrun count. More...

long snd_timer_status_get_queue (snd_timer_status_t *status)
 get count of used queue elements. More...


Detailed Description

Application interface library for the ALSA driver.

>

Author:
Jaroslav Kysela <perex@suse.cz> , Abramo Bagnara <abramo@alsa-project.org> , Takashi Iwai <tiwai@suse.de>
Date:
1998-2001
Application interface library for the ALSA driver

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Generated on Sun Sep 29 12:29:30 2002 for ALSA project - the C library reference by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002