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

control.c File Reference

CTL interface - primitive controls. More...


Functions

const char * snd_ctl_name (snd_ctl_t *ctl)
 get identifier of CTL handle

snd_ctl_type_t snd_ctl_type (snd_ctl_t *ctl)
 get type of CTL handle

int snd_ctl_close (snd_ctl_t *ctl)
 close CTL handle

int snd_ctl_nonblock (snd_ctl_t *ctl, int nonblock)
 set nonblock mode

int snd_ctl_poll_descriptors_count (snd_ctl_t *ctl)
 get count of poll descriptors for CTL handle

int snd_ctl_poll_descriptors (snd_ctl_t *ctl, struct pollfd *pfds, unsigned int space)
 get poll descriptors

int snd_ctl_poll_descriptors_revents (snd_ctl_t *ctl, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
 get returned events from poll descriptors

int snd_ctl_subscribe_events (snd_ctl_t *ctl, int subscribe)
 Ask to be informed about events (poll, snd_ctl_async, snd_ctl_read).

int snd_ctl_card_info (snd_ctl_t *ctl, snd_ctl_card_info_t *info)
 Get card related information.

int snd_ctl_elem_list (snd_ctl_t *ctl, snd_ctl_elem_list_t *list)
 Get a list of element identifiers.

int snd_ctl_elem_info (snd_ctl_t *ctl, snd_ctl_elem_info_t *info)
 Get CTL element information.

int snd_ctl_elem_read (snd_ctl_t *ctl, snd_ctl_elem_value_t *control)
 Get CTL element value.

int snd_ctl_elem_write (snd_ctl_t *ctl, snd_ctl_elem_value_t *control)
 Set CTL element value.

int snd_ctl_elem_lock (snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
 Lock CTL element.

int snd_ctl_elem_unlock (snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
 Unlock CTL element.

int snd_ctl_hwdep_next_device (snd_ctl_t *ctl, int *device)
 Get next hardware dependent device number.

int snd_ctl_hwdep_info (snd_ctl_t *ctl, snd_hwdep_info_t *info)
 Get info about a hardware dependent device.

int snd_ctl_pcm_next_device (snd_ctl_t *ctl, int *device)
 Get next PCM device number.

int snd_ctl_pcm_info (snd_ctl_t *ctl, snd_pcm_info_t *info)
 Get info about a PCM device.

int snd_ctl_pcm_prefer_subdevice (snd_ctl_t *ctl, int subdev)
 Set preferred PCM subdevice number of successive PCM open.

int snd_ctl_rawmidi_next_device (snd_ctl_t *ctl, int *device)
 Get next RawMidi device number.

int snd_ctl_rawmidi_info (snd_ctl_t *ctl, snd_rawmidi_info_t *info)
 Get info about a RawMidi device.

int snd_ctl_rawmidi_prefer_subdevice (snd_ctl_t *ctl, int subdev)
 Set preferred RawMidi subdevice number of successive RawMidi open.

int snd_ctl_set_power_state (snd_ctl_t *ctl, unsigned int state)
 Set Power State to given SND_CTL_POWER_* value and do the power management.

int snd_ctl_get_power_state (snd_ctl_t *ctl, unsigned int *state)
 Get actual Power State.

int snd_ctl_read (snd_ctl_t *ctl, snd_ctl_event_t *event)
 Read an event.

int snd_ctl_wait (snd_ctl_t *ctl, int timeout)
 Wait for a CTL to become ready (i.e. at least one event pending).

int snd_async_add_ctl_handler (snd_async_handler_t **handler, snd_ctl_t *ctl, snd_async_callback_t callback, void *private_data)
 Add an async handler for a CTL.

snd_ctl_tsnd_async_handler_get_ctl (snd_async_handler_t *handler)
 Return CTL handle related to an async handler.

int snd_ctl_open (snd_ctl_t **ctlp, const char *name, int mode)
 Opens a CTL.

int snd_ctl_open_lconf (snd_ctl_t **ctlp, const char *name, int mode, snd_config_t *lconf)
 Opens a CTL using local configuration.

void snd_ctl_elem_set_bytes (snd_ctl_elem_value_t *obj, void *data, size_t size)
 Set CTL element SND_CTL_ELEM_TYPE_BYTES value.

const char * snd_ctl_elem_type_name (snd_ctl_elem_type_t type)
 get name of a CTL element type

const char * snd_ctl_elem_iface_name (snd_ctl_elem_iface_t iface)
 get name of a CTL element related interface

const char * snd_ctl_event_type_name (snd_ctl_event_type_t type)
 get name of a CTL event type

int snd_ctl_elem_list_alloc_space (snd_ctl_elem_list_t *obj, unsigned int entries)
 allocate space for CTL element identifiers list

void snd_ctl_elem_list_free_space (snd_ctl_elem_list_t *obj)
 free previously allocated space for CTL element identifiers list

unsigned int snd_ctl_event_elem_get_mask (const snd_ctl_event_t *obj)
 Get event mask for an element related event.

void snd_ctl_event_elem_get_id (const snd_ctl_event_t *obj, snd_ctl_elem_id_t *ptr)
 Get CTL element identifier for an element related event.

unsigned int snd_ctl_event_elem_get_numid (const snd_ctl_event_t *obj)
 Get element numeric identifier for an element related event.

snd_ctl_elem_iface_t snd_ctl_event_elem_get_interface (const snd_ctl_event_t *obj)
 Get interface part of CTL element identifier for an element related event.

unsigned int snd_ctl_event_elem_get_device (const snd_ctl_event_t *obj)
 Get device part of CTL element identifier for an element related event.

unsigned int snd_ctl_event_elem_get_subdevice (const snd_ctl_event_t *obj)
 Get subdevice part of CTL element identifier for an element related event.

const char * snd_ctl_event_elem_get_name (const snd_ctl_event_t *obj)
 Get name part of CTL element identifier for an element related event.

unsigned int snd_ctl_event_elem_get_index (const snd_ctl_event_t *obj)
 Get index part of CTL element identifier for an element related event.

size_t snd_ctl_elem_id_sizeof ()
 get size of snd_ctl_elem_id_t

int snd_ctl_elem_id_malloc (snd_ctl_elem_id_t **ptr)
 allocate an invalid snd_ctl_elem_id_t using standard malloc

void snd_ctl_elem_id_free (snd_ctl_elem_id_t *obj)
 frees a previously allocated snd_ctl_elem_id_t

void snd_ctl_elem_id_clear (snd_ctl_elem_id_t *obj)
 clear given snd_ctl_elem_id_t object

void snd_ctl_elem_id_copy (snd_ctl_elem_id_t *dst, const snd_ctl_elem_id_t *src)
 copy one snd_ctl_elem_id_t to another

unsigned int snd_ctl_elem_id_get_numid (const snd_ctl_elem_id_t *obj)
 Get numeric identifier from a CTL element identifier.

snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface (const snd_ctl_elem_id_t *obj)
 Get interface part of a CTL element identifier.

unsigned int snd_ctl_elem_id_get_device (const snd_ctl_elem_id_t *obj)
 Get device part of a CTL element identifier.

unsigned int snd_ctl_elem_id_get_subdevice (const snd_ctl_elem_id_t *obj)
 Get subdevice part of a CTL element identifier.

const char * snd_ctl_elem_id_get_name (const snd_ctl_elem_id_t *obj)
 Get name part of a CTL element identifier.

unsigned int snd_ctl_elem_id_get_index (const snd_ctl_elem_id_t *obj)
 Get index part of a CTL element identifier.

void snd_ctl_elem_id_set_numid (snd_ctl_elem_id_t *obj, unsigned int val)
 Set numeric identifier for a CTL element identifier.

void snd_ctl_elem_id_set_interface (snd_ctl_elem_id_t *obj, snd_ctl_elem_iface_t val)
 Set interface part for a CTL element identifier.

void snd_ctl_elem_id_set_device (snd_ctl_elem_id_t *obj, unsigned int val)
 Set device part for a CTL element identifier.

void snd_ctl_elem_id_set_subdevice (snd_ctl_elem_id_t *obj, unsigned int val)
 Set subdevice part for a CTL element identifier.

void snd_ctl_elem_id_set_name (snd_ctl_elem_id_t *obj, const char *val)
 Set name part for a CTL element identifier.

void snd_ctl_elem_id_set_index (snd_ctl_elem_id_t *obj, unsigned int val)
 Set index part for a CTL element identifier.

size_t snd_ctl_card_info_sizeof ()
 get size of snd_ctl_card_info_t

int snd_ctl_card_info_malloc (snd_ctl_card_info_t **ptr)
 allocate an invalid snd_ctl_card_info_t using standard malloc

void snd_ctl_card_info_free (snd_ctl_card_info_t *obj)
 frees a previously allocated snd_ctl_card_info_t

void snd_ctl_card_info_clear (snd_ctl_card_info_t *obj)
 clear given snd_ctl_card_info_t object

void snd_ctl_card_info_copy (snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src)
 copy one snd_ctl_card_info_t to another

int snd_ctl_card_info_get_card (const snd_ctl_card_info_t *obj)
 Get card number from a CTL card info.

const char * snd_ctl_card_info_get_id (const snd_ctl_card_info_t *obj)
 Get card identifier from a CTL card info.

const char * snd_ctl_card_info_get_driver (const snd_ctl_card_info_t *obj)
 Get card driver name from a CTL card info.

const char * snd_ctl_card_info_get_name (const snd_ctl_card_info_t *obj)
 Get card name from a CTL card info.

const char * snd_ctl_card_info_get_longname (const snd_ctl_card_info_t *obj)
 Get card long name from a CTL card info.

const char * snd_ctl_card_info_get_mixername (const snd_ctl_card_info_t *obj)
 Get card mixer name from a CTL card info.

const char * snd_ctl_card_info_get_components (const snd_ctl_card_info_t *obj)
 Get card component list from a CTL card info.

size_t snd_ctl_event_sizeof ()
 get size of snd_ctl_event_t

int snd_ctl_event_malloc (snd_ctl_event_t **ptr)
 allocate an invalid snd_ctl_event_t using standard malloc

void snd_ctl_event_free (snd_ctl_event_t *obj)
 frees a previously allocated snd_ctl_event_t

void snd_ctl_event_clear (snd_ctl_event_t *obj)
 clear given snd_ctl_event_t object

void snd_ctl_event_copy (snd_ctl_event_t *dst, const snd_ctl_event_t *src)
 copy one snd_ctl_event_t to another

snd_ctl_event_type_t snd_ctl_event_get_type (const snd_ctl_event_t *obj)
 Get type of a CTL event.

size_t snd_ctl_elem_list_sizeof ()
 get size of snd_ctl_elem_list_t

int snd_ctl_elem_list_malloc (snd_ctl_elem_list_t **ptr)
 allocate an invalid snd_ctl_elem_list_t using standard malloc

void snd_ctl_elem_list_free (snd_ctl_elem_list_t *obj)
 frees a previously allocated snd_ctl_elem_list_t

void snd_ctl_elem_list_clear (snd_ctl_elem_list_t *obj)
 clear given snd_ctl_elem_list_t object

void snd_ctl_elem_list_copy (snd_ctl_elem_list_t *dst, const snd_ctl_elem_list_t *src)
 copy one snd_ctl_elem_list_t to another

void snd_ctl_elem_list_set_offset (snd_ctl_elem_list_t *obj, unsigned int val)
 Set index of first wanted CTL element identifier in a CTL element identifiers list.

unsigned int snd_ctl_elem_list_get_used (const snd_ctl_elem_list_t *obj)
 Get number of used entries in CTL element identifiers list.

unsigned int snd_ctl_elem_list_get_count (const snd_ctl_elem_list_t *obj)
 Get total count of elements present in CTL device (information present in every filled CTL element identifiers list).

void snd_ctl_elem_list_get_id (const snd_ctl_elem_list_t *obj, unsigned int idx, snd_ctl_elem_id_t *ptr)
 Get CTL element identifier for an entry of a CTL element identifiers list.

unsigned int snd_ctl_elem_list_get_numid (const snd_ctl_elem_list_t *obj, unsigned int idx)
 Get CTL element numeric identifier for an entry of a CTL element identifiers list.

snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface (const snd_ctl_elem_list_t *obj, unsigned int idx)
 Get interface part of CTL element identifier for an entry of a CTL element identifiers list.

unsigned int snd_ctl_elem_list_get_device (const snd_ctl_elem_list_t *obj, unsigned int idx)
 Get device part of CTL element identifier for an entry of a CTL element identifiers list.

unsigned int snd_ctl_elem_list_get_subdevice (const snd_ctl_elem_list_t *obj, unsigned int idx)
 Get subdevice part of CTL element identifier for an entry of a CTL element identifiers list.

const char * snd_ctl_elem_list_get_name (const snd_ctl_elem_list_t *obj, unsigned int idx)
 Get name part of CTL element identifier for an entry of a CTL element identifiers list.

unsigned int snd_ctl_elem_list_get_index (const snd_ctl_elem_list_t *obj, unsigned int idx)
 Get index part of CTL element identifier for an entry of a CTL element identifiers list.

size_t snd_ctl_elem_info_sizeof ()
 get size of snd_ctl_elem_info_t

int snd_ctl_elem_info_malloc (snd_ctl_elem_info_t **ptr)
 allocate an invalid snd_ctl_elem_info_t using standard malloc

void snd_ctl_elem_info_free (snd_ctl_elem_info_t *obj)
 frees a previously allocated snd_ctl_elem_info_t

void snd_ctl_elem_info_clear (snd_ctl_elem_info_t *obj)
 clear given snd_ctl_elem_info_t object

void snd_ctl_elem_info_copy (snd_ctl_elem_info_t *dst, const snd_ctl_elem_info_t *src)
 copy one snd_ctl_elem_info_t to another

snd_ctl_elem_type_t snd_ctl_elem_info_get_type (const snd_ctl_elem_info_t *obj)
 Get type from a CTL element id/info.

int snd_ctl_elem_info_is_readable (const snd_ctl_elem_info_t *obj)
 Get info about readability from a CTL element id/info.

int snd_ctl_elem_info_is_writable (const snd_ctl_elem_info_t *obj)
 Get info about writability from a CTL element id/info.

int snd_ctl_elem_info_is_volatile (const snd_ctl_elem_info_t *obj)
 Get info about notification feasibility from a CTL element id/info.

int snd_ctl_elem_info_is_inactive (const snd_ctl_elem_info_t *obj)
 Get info about status from a CTL element id/info.

int snd_ctl_elem_info_is_locked (const snd_ctl_elem_info_t *obj)
 Get info whether an element is locked.

int snd_ctl_elem_info_is_owner (const snd_ctl_elem_info_t *obj)
 Get info if I own an element.

int snd_ctl_elem_info_is_indirect (const snd_ctl_elem_info_t *obj)
 (DEPRECATED) Get info about values passing policy from a CTL element value

pid_t snd_ctl_elem_info_get_owner (const snd_ctl_elem_info_t *obj)
 Get owner of a locked element.

unsigned int snd_ctl_elem_info_get_count (const snd_ctl_elem_info_t *obj)
 Get number of value entries from a CTL element id/info.

long snd_ctl_elem_info_get_min (const snd_ctl_elem_info_t *obj)
 Get minimum value from a SND_CTL_ELEM_TYPE_INTEGER CTL element id/info.

long snd_ctl_elem_info_get_max (const snd_ctl_elem_info_t *obj)
 Get maximum value from a SND_CTL_ELEM_TYPE_INTEGER CTL element id/info.

long snd_ctl_elem_info_get_step (const snd_ctl_elem_info_t *obj)
 Get value step from a SND_CTL_ELEM_TYPE_INTEGER CTL element id/info.

long long snd_ctl_elem_info_get_min64 (const snd_ctl_elem_info_t *obj)
 Get minimum value from a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/info.

long long snd_ctl_elem_info_get_max64 (const snd_ctl_elem_info_t *obj)
 Get maximum value from a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/info.

long long snd_ctl_elem_info_get_step64 (const snd_ctl_elem_info_t *obj)
 Get value step from a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/info.

unsigned int snd_ctl_elem_info_get_items (const snd_ctl_elem_info_t *obj)
 Get number of items available from a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/info.

void snd_ctl_elem_info_set_item (snd_ctl_elem_info_t *obj, unsigned int val)
 Select item in a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/info.

const char * snd_ctl_elem_info_get_item_name (const snd_ctl_elem_info_t *obj)
 Get name for selected item in a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/info.

int snd_ctl_elem_info_get_dimensions (const snd_ctl_elem_info_t *obj)
 Get count of dimensions for given element.

int snd_ctl_elem_info_get_dimension (const snd_ctl_elem_info_t *obj, unsigned int idx)
 Get specified of dimension width for given element.

void snd_ctl_elem_info_get_id (const snd_ctl_elem_info_t *obj, snd_ctl_elem_id_t *ptr)
 Get CTL element identifier of a CTL element id/info.

unsigned int snd_ctl_elem_info_get_numid (const snd_ctl_elem_info_t *obj)
 Get element numeric identifier of a CTL element id/info.

snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface (const snd_ctl_elem_info_t *obj)
 Get interface part of CTL element identifier of a CTL element id/info.

unsigned int snd_ctl_elem_info_get_device (const snd_ctl_elem_info_t *obj)
 Get device part of CTL element identifier of a CTL element id/info.

unsigned int snd_ctl_elem_info_get_subdevice (const snd_ctl_elem_info_t *obj)
 Get subdevice part of CTL element identifier of a CTL element id/info.

const char * snd_ctl_elem_info_get_name (const snd_ctl_elem_info_t *obj)
 Get name part of CTL element identifier of a CTL element id/info.

unsigned int snd_ctl_elem_info_get_index (const snd_ctl_elem_info_t *obj)
 Get index part of CTL element identifier of a CTL element id/info.

void snd_ctl_elem_info_set_id (snd_ctl_elem_info_t *obj, const snd_ctl_elem_id_t *ptr)
 Set CTL element identifier of a CTL element id/info.

void snd_ctl_elem_info_set_numid (snd_ctl_elem_info_t *obj, unsigned int val)
 Set element numeric identifier of a CTL element id/info.

void snd_ctl_elem_info_set_interface (snd_ctl_elem_info_t *obj, snd_ctl_elem_iface_t val)
 Set interface part of CTL element identifier of a CTL element id/info.

void snd_ctl_elem_info_set_device (snd_ctl_elem_info_t *obj, unsigned int val)
 Set device part of CTL element identifier of a CTL element id/info.

void snd_ctl_elem_info_set_subdevice (snd_ctl_elem_info_t *obj, unsigned int val)
 Set subdevice part of CTL element identifier of a CTL element id/info.

void snd_ctl_elem_info_set_name (snd_ctl_elem_info_t *obj, const char *val)
 Set name part of CTL element identifier of a CTL element id/info.

void snd_ctl_elem_info_set_index (snd_ctl_elem_info_t *obj, unsigned int val)
 Set index part of CTL element identifier of a CTL element id/info.

size_t snd_ctl_elem_value_sizeof ()
 get size of snd_ctl_elem_value_t

int snd_ctl_elem_value_malloc (snd_ctl_elem_value_t **ptr)
 allocate an invalid snd_ctl_elem_value_t using standard malloc

void snd_ctl_elem_value_free (snd_ctl_elem_value_t *obj)
 frees a previously allocated snd_ctl_elem_value_t

void snd_ctl_elem_value_clear (snd_ctl_elem_value_t *obj)
 clear given snd_ctl_elem_value_t object

void snd_ctl_elem_value_copy (snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src)
 copy one snd_ctl_elem_value_t to another

void snd_ctl_elem_value_get_id (const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr)
 Get CTL element identifier of a CTL element id/value.

unsigned int snd_ctl_elem_value_get_numid (const snd_ctl_elem_value_t *obj)
 Get element numeric identifier of a CTL element id/value.

snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface (const snd_ctl_elem_value_t *obj)
 Get interface part of CTL element identifier of a CTL element id/value.

unsigned int snd_ctl_elem_value_get_device (const snd_ctl_elem_value_t *obj)
 Get device part of CTL element identifier of a CTL element id/value.

unsigned int snd_ctl_elem_value_get_subdevice (const snd_ctl_elem_value_t *obj)
 Get subdevice part of CTL element identifier of a CTL element id/value.

const char * snd_ctl_elem_value_get_name (const snd_ctl_elem_value_t *obj)
 Get name part of CTL element identifier of a CTL element id/value.

unsigned int snd_ctl_elem_value_get_index (const snd_ctl_elem_value_t *obj)
 Get index part of CTL element identifier of a CTL element id/value.

void snd_ctl_elem_value_set_id (snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr)
 Set CTL element identifier of a CTL element id/value.

void snd_ctl_elem_value_set_numid (snd_ctl_elem_value_t *obj, unsigned int val)
 Set element numeric identifier of a CTL element id/value.

void snd_ctl_elem_value_set_interface (snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val)
 Set interface part of CTL element identifier of a CTL element id/value.

void snd_ctl_elem_value_set_device (snd_ctl_elem_value_t *obj, unsigned int val)
 Set device part of CTL element identifier of a CTL element id/value.

void snd_ctl_elem_value_set_subdevice (snd_ctl_elem_value_t *obj, unsigned int val)
 Set subdevice part of CTL element identifier of a CTL element id/value.

void snd_ctl_elem_value_set_name (snd_ctl_elem_value_t *obj, const char *val)
 Set name part of CTL element identifier of a CTL element id/value.

void snd_ctl_elem_value_set_index (snd_ctl_elem_value_t *obj, unsigned int val)
 Set index part of CTL element identifier of a CTL element id/value.

int snd_ctl_elem_value_get_boolean (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get value for an entry of a SND_CTL_ELEM_TYPE_BOOLEAN CTL element id/value.

long snd_ctl_elem_value_get_integer (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get value for an entry of a SND_CTL_ELEM_TYPE_INTEGER CTL element id/value.

long long snd_ctl_elem_value_get_integer64 (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get value for an entry of a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/value.

unsigned int snd_ctl_elem_value_get_enumerated (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get value for an entry of a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/value.

unsigned char snd_ctl_elem_value_get_byte (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get value for an entry of a SND_CTL_ELEM_TYPE_BYTES CTL element id/value.

void snd_ctl_elem_value_set_boolean (snd_ctl_elem_value_t *obj, unsigned int idx, long val)
 Set value for an entry of a SND_CTL_ELEM_TYPE_BOOLEAN CTL element id/value.

void snd_ctl_elem_value_set_integer (snd_ctl_elem_value_t *obj, unsigned int idx, long val)
 Set value for an entry of a SND_CTL_ELEM_TYPE_INTEGER CTL element id/value.

void snd_ctl_elem_value_set_integer64 (snd_ctl_elem_value_t *obj, unsigned int idx, long long val)
 Set value for an entry of a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/value.

void snd_ctl_elem_value_set_enumerated (snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val)
 Set value for an entry of a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/value.

void snd_ctl_elem_value_set_byte (snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val)
 Set value for an entry of a SND_CTL_ELEM_TYPE_BYTES CTL element id/value.

const void * snd_ctl_elem_value_get_bytes (const snd_ctl_elem_value_t *obj)
 Get value for a SND_CTL_ELEM_TYPE_BYTES CTL element id/value.

void snd_ctl_elem_value_get_iec958 (const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr)
 Get value for a SND_CTL_ELEM_TYPE_IEC958 CTL element id/value.

void snd_ctl_elem_value_set_iec958 (snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr)
 Set value for a SND_CTL_ELEM_TYPE_IEC958 CTL element id/value.


Detailed Description

CTL interface - primitive controls.

Author:
Abramo Bagnara <abramo@alsa-project.org>
Date:
2000
CTL interface is designed to access primitive controls. See Control interface page for more details.


Function Documentation

int snd_async_add_ctl_handler snd_async_handler_t **    handler,
snd_ctl_t   ctl,
snd_async_callback_t    callback,
void *    private_data
 

Add an async handler for a CTL.

Parameters:
handler  Returned handler handle
ctl  CTL handle
callback  Callback function
private_data  Callback private data
Returns:
0 otherwise a negative error code on failure

snd_ctl_t* snd_async_handler_get_ctl snd_async_handler_t   handler
 

Return CTL handle related to an async handler.

Parameters:
handler  Async handler handle
Returns:
CTL handle

int snd_ctl_card_info snd_ctl_t   ctl,
snd_ctl_card_info_t   info
 

Get card related information.

Parameters:
ctl  CTL handle
info  Card info pointer
Returns:
0 on success otherwise a negative error code

void snd_ctl_card_info_clear snd_ctl_card_info_t   obj
 

clear given snd_ctl_card_info_t object

Parameters:
obj  pointer to object to clear

void snd_ctl_card_info_copy snd_ctl_card_info_t   dst,
const snd_ctl_card_info_t   src
 

copy one snd_ctl_card_info_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_ctl_card_info_free snd_ctl_card_info_t   obj
 

frees a previously allocated snd_ctl_card_info_t

Parameters:
pointer  to object to free

int snd_ctl_card_info_get_card const snd_ctl_card_info_t   obj
 

Get card number from a CTL card info.

Parameters:
obj  CTL card info
Returns:
card number

const char* snd_ctl_card_info_get_components const snd_ctl_card_info_t   obj
 

Get card component list from a CTL card info.

Parameters:
obj  CTL card info
Returns:
card mixer identifier

const char* snd_ctl_card_info_get_driver const snd_ctl_card_info_t   obj
 

Get card driver name from a CTL card info.

Parameters:
obj  CTL card info
Returns:
card driver name

const char* snd_ctl_card_info_get_id const snd_ctl_card_info_t   obj
 

Get card identifier from a CTL card info.

Parameters:
obj  CTL card info
Returns:
card identifier

const char* snd_ctl_card_info_get_longname const snd_ctl_card_info_t   obj
 

Get card long name from a CTL card info.

Parameters:
obj  CTL card info
Returns:
card long name

const char* snd_ctl_card_info_get_mixername const snd_ctl_card_info_t   obj
 

Get card mixer name from a CTL card info.

Parameters:
obj  CTL card info
Returns:
card mixer name

const char* snd_ctl_card_info_get_name const snd_ctl_card_info_t   obj
 

Get card name from a CTL card info.

Parameters:
obj  CTL card info
Returns:
card name

int snd_ctl_card_info_malloc snd_ctl_card_info_t **    ptr
 

allocate an invalid snd_ctl_card_info_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

size_t snd_ctl_card_info_sizeof void   
 

get size of snd_ctl_card_info_t

Returns:
size in bytes

int snd_ctl_close snd_ctl_t   ctl
 

close CTL handle

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

void snd_ctl_elem_id_clear snd_ctl_elem_id_t   obj
 

clear given snd_ctl_elem_id_t object

Parameters:
obj  pointer to object to clear

void snd_ctl_elem_id_copy snd_ctl_elem_id_t   dst,
const snd_ctl_elem_id_t   src
 

copy one snd_ctl_elem_id_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_ctl_elem_id_free snd_ctl_elem_id_t   obj
 

frees a previously allocated snd_ctl_elem_id_t

Parameters:
pointer  to object to free

unsigned int snd_ctl_elem_id_get_device const snd_ctl_elem_id_t   obj
 

Get device part of a CTL element identifier.

Parameters:
obj  CTL element identifier
Returns:
CTL element related device

unsigned int snd_ctl_elem_id_get_index const snd_ctl_elem_id_t   obj
 

Get index part of a CTL element identifier.

Parameters:
obj  CTL element identifier
Returns:
CTL element index

snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface const snd_ctl_elem_id_t   obj
 

Get interface part of a CTL element identifier.

Parameters:
obj  CTL element identifier
Returns:
CTL element related interface

const char* snd_ctl_elem_id_get_name const snd_ctl_elem_id_t   obj
 

Get name part of a CTL element identifier.

Parameters:
obj  CTL element identifier
Returns:
CTL element name

unsigned int snd_ctl_elem_id_get_numid const snd_ctl_elem_id_t   obj
 

Get numeric identifier from a CTL element identifier.

Parameters:
obj  CTL element identifier
Returns:
CTL element numeric identifier

unsigned int snd_ctl_elem_id_get_subdevice const snd_ctl_elem_id_t   obj
 

Get subdevice part of a CTL element identifier.

Parameters:
obj  CTL element identifier
Returns:
CTL element related subdevice

int snd_ctl_elem_id_malloc snd_ctl_elem_id_t **    ptr
 

allocate an invalid snd_ctl_elem_id_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_ctl_elem_id_set_device snd_ctl_elem_id_t   obj,
unsigned int    val
 

Set device part for a CTL element identifier.

Parameters:
obj  CTL element identifier
val  CTL element related device

void snd_ctl_elem_id_set_index snd_ctl_elem_id_t   obj,
unsigned int    val
 

Set index part for a CTL element identifier.

Parameters:
obj  CTL element identifier
val  CTL element index

void snd_ctl_elem_id_set_interface snd_ctl_elem_id_t   obj,
snd_ctl_elem_iface_t    val
 

Set interface part for a CTL element identifier.

Parameters:
obj  CTL element identifier
val  CTL element related interface

void snd_ctl_elem_id_set_name snd_ctl_elem_id_t   obj,
const char *    val
 

Set name part for a CTL element identifier.

Parameters:
obj  CTL element identifier
val  CTL element name

void snd_ctl_elem_id_set_numid snd_ctl_elem_id_t   obj,
unsigned int    val
 

Set numeric identifier for a CTL element identifier.

Parameters:
obj  CTL element identifier
val  CTL element numeric identifier

void snd_ctl_elem_id_set_subdevice snd_ctl_elem_id_t   obj,
unsigned int    val
 

Set subdevice part for a CTL element identifier.

Parameters:
obj  CTL element identifier
val  CTL element related subdevice

size_t snd_ctl_elem_id_sizeof void   
 

get size of snd_ctl_elem_id_t

Returns:
size in bytes

const char* snd_ctl_elem_iface_name snd_ctl_elem_iface_t    iface
 

get name of a CTL element related interface

Parameters:
iface  CTL element related interface
Returns:
ascii name of CTL element related interface

int snd_ctl_elem_info snd_ctl_t   ctl,
snd_ctl_elem_info_t   info
 

Get CTL element information.

Parameters:
ctl  CTL handle
info  CTL element id/information pointer
Returns:
0 on success otherwise a negative error code

void snd_ctl_elem_info_clear snd_ctl_elem_info_t   obj
 

clear given snd_ctl_elem_info_t object

Parameters:
obj  pointer to object to clear

void snd_ctl_elem_info_copy snd_ctl_elem_info_t   dst,
const snd_ctl_elem_info_t   src
 

copy one snd_ctl_elem_info_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_ctl_elem_info_free snd_ctl_elem_info_t   obj
 

frees a previously allocated snd_ctl_elem_info_t

Parameters:
pointer  to object to free

unsigned int snd_ctl_elem_info_get_count const snd_ctl_elem_info_t   obj
 

Get number of value entries from a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
value entries count

unsigned int snd_ctl_elem_info_get_device const snd_ctl_elem_info_t   obj
 

Get device part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
device part of element identifier

int snd_ctl_elem_info_get_dimension const snd_ctl_elem_info_t   obj,
unsigned int    idx
 

Get specified of dimension width for given element.

Parameters:
obj  CTL element id/info
Returns:
zero value if no dimension width is defined, otherwise positive value with with of specified dimension

int snd_ctl_elem_info_get_dimensions const snd_ctl_elem_info_t   obj
 

Get count of dimensions for given element.

Parameters:
obj  CTL element id/info
Returns:
zero value if no dimensions are defined, otherwise positive value with count of dimensions

void snd_ctl_elem_info_get_id const snd_ctl_elem_info_t   obj,
snd_ctl_elem_id_t   ptr
 

Get CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
ptr  Pointer to returned CTL element identifier

unsigned int snd_ctl_elem_info_get_index const snd_ctl_elem_info_t   obj
 

Get index part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
index part of element identifier

snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface const snd_ctl_elem_info_t   obj
 

Get interface part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
interface part of element identifier

const char* snd_ctl_elem_info_get_item_name const snd_ctl_elem_info_t   obj
 

Get name for selected item in a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
name of chosen item

unsigned int snd_ctl_elem_info_get_items const snd_ctl_elem_info_t   obj
 

Get number of items available from a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
items count

long snd_ctl_elem_info_get_max const snd_ctl_elem_info_t   obj
 

Get maximum value from a SND_CTL_ELEM_TYPE_INTEGER CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
Maximum value

long long snd_ctl_elem_info_get_max64 const snd_ctl_elem_info_t   obj
 

Get maximum value from a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
Maximum value

long snd_ctl_elem_info_get_min const snd_ctl_elem_info_t   obj
 

Get minimum value from a SND_CTL_ELEM_TYPE_INTEGER CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
Minimum value

long long snd_ctl_elem_info_get_min64 const snd_ctl_elem_info_t   obj
 

Get minimum value from a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
Minimum value

const char* snd_ctl_elem_info_get_name const snd_ctl_elem_info_t   obj
 

Get name part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
name part of element identifier

unsigned int snd_ctl_elem_info_get_numid const snd_ctl_elem_info_t   obj
 

Get element numeric identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
element numeric identifier

pid_t snd_ctl_elem_info_get_owner const snd_ctl_elem_info_t   obj
 

Get owner of a locked element.

Parameters:
obj  CTL element id/info
Returns:
value entries count

long snd_ctl_elem_info_get_step const snd_ctl_elem_info_t   obj
 

Get value step from a SND_CTL_ELEM_TYPE_INTEGER CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
Step

long long snd_ctl_elem_info_get_step64 const snd_ctl_elem_info_t   obj
 

Get value step from a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
Step

unsigned int snd_ctl_elem_info_get_subdevice const snd_ctl_elem_info_t   obj
 

Get subdevice part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
subdevice part of element identifier

snd_ctl_elem_type_t snd_ctl_elem_info_get_type const snd_ctl_elem_info_t   obj
 

Get type from a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
CTL element content type

int snd_ctl_elem_info_is_inactive const snd_ctl_elem_info_t   obj
 

Get info about status from a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
0 if element value is not active, 1 if is active

int snd_ctl_elem_info_is_indirect const snd_ctl_elem_info_t   obj
 

(DEPRECATED) Get info about values passing policy from a CTL element value

Parameters:
obj  CTL element id/info
Returns:
0 if element value need to be passed by contents, 1 if need to be passed with a pointer

int snd_ctl_elem_info_is_locked const snd_ctl_elem_info_t   obj
 

Get info whether an element is locked.

Parameters:
obj  CTL element id/info
Returns:
0 if element value is currently changeable, 1 if it's locked by another application

int snd_ctl_elem_info_is_owner const snd_ctl_elem_info_t   obj
 

Get info if I own an element.

Parameters:
obj  CTL element id/info
Returns:
0 if element value is currently changeable, 1 if it's locked by another application

int snd_ctl_elem_info_is_readable const snd_ctl_elem_info_t   obj
 

Get info about readability from a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
0 if element is not readable, 1 if element is readable

int snd_ctl_elem_info_is_volatile const snd_ctl_elem_info_t   obj
 

Get info about notification feasibility from a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
0 if all element value changes are notified to subscribed applications, 1 otherwise

int snd_ctl_elem_info_is_writable const snd_ctl_elem_info_t   obj
 

Get info about writability from a CTL element id/info.

Parameters:
obj  CTL element id/info
Returns:
0 if element is not writable, 1 if element is not writable

int snd_ctl_elem_info_malloc snd_ctl_elem_info_t **    ptr
 

allocate an invalid snd_ctl_elem_info_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_ctl_elem_info_set_device snd_ctl_elem_info_t   obj,
unsigned int    val
 

Set device part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
val  device part of element identifier

void snd_ctl_elem_info_set_id snd_ctl_elem_info_t   obj,
const snd_ctl_elem_id_t   ptr
 

Set CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
ptr  CTL element identifier

void snd_ctl_elem_info_set_index snd_ctl_elem_info_t   obj,
unsigned int    val
 

Set index part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
val  index part of element identifier

void snd_ctl_elem_info_set_interface snd_ctl_elem_info_t   obj,
snd_ctl_elem_iface_t    val
 

Set interface part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
val  interface part of element identifier

void snd_ctl_elem_info_set_item snd_ctl_elem_info_t   obj,
unsigned int    val
 

Select item in a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/info.

Parameters:
obj  CTL element id/info
val  item number

void snd_ctl_elem_info_set_name snd_ctl_elem_info_t   obj,
const char *    val
 

Set name part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
val  name part of element identifier

void snd_ctl_elem_info_set_numid snd_ctl_elem_info_t   obj,
unsigned int    val
 

Set element numeric identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
val  element numeric identifier

void snd_ctl_elem_info_set_subdevice snd_ctl_elem_info_t   obj,
unsigned int    val
 

Set subdevice part of CTL element identifier of a CTL element id/info.

Parameters:
obj  CTL element id/info
val  subdevice part of element identifier

size_t snd_ctl_elem_info_sizeof void   
 

get size of snd_ctl_elem_info_t

Returns:
size in bytes

int snd_ctl_elem_list snd_ctl_t   ctl,
snd_ctl_elem_list_t   list
 

Get a list of element identifiers.

Parameters:
ctl  CTL handle
list  CTL element identifiers list pointer
Returns:
0 on success otherwise a negative error code

int snd_ctl_elem_list_alloc_space snd_ctl_elem_list_t   obj,
unsigned int    entries
 

allocate space for CTL element identifiers list

Parameters:
obj  CTL element identifiers list
entries  Entries to allocate
Returns:
0 on success otherwise a negative error code

void snd_ctl_elem_list_clear snd_ctl_elem_list_t   obj
 

clear given snd_ctl_elem_list_t object

Parameters:
obj  pointer to object to clear

void snd_ctl_elem_list_copy snd_ctl_elem_list_t   dst,
const snd_ctl_elem_list_t   src
 

copy one snd_ctl_elem_list_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_ctl_elem_list_free snd_ctl_elem_list_t   obj
 

frees a previously allocated snd_ctl_elem_list_t

Parameters:
pointer  to object to free

void snd_ctl_elem_list_free_space snd_ctl_elem_list_t   obj
 

free previously allocated space for CTL element identifiers list

Parameters:
obj  CTL element identifiers list

unsigned int snd_ctl_elem_list_get_count const snd_ctl_elem_list_t   obj
 

Get total count of elements present in CTL device (information present in every filled CTL element identifiers list).

Parameters:
obj  CTL element identifier list
Returns:
total number of elements

unsigned int snd_ctl_elem_list_get_device const snd_ctl_elem_list_t   obj,
unsigned int    idx
 

Get device part of CTL element identifier for an entry of a CTL element identifiers list.

Parameters:
obj  CTL element identifier list
idx  Index of entry
Returns:
CTL element related device

void snd_ctl_elem_list_get_id const snd_ctl_elem_list_t   obj,
unsigned int    idx,
snd_ctl_elem_id_t   ptr
 

Get CTL element identifier for an entry of a CTL element identifiers list.

Parameters:
obj  CTL element identifier list
idx  Index of entry
ptr  Pointer to returned CTL element identifier

unsigned int snd_ctl_elem_list_get_index const snd_ctl_elem_list_t   obj,
unsigned int    idx
 

Get index part of CTL element identifier for an entry of a CTL element identifiers list.

Parameters:
obj  CTL element identifier list
idx  Index of entry
Returns:
CTL element index

snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface const snd_ctl_elem_list_t   obj,
unsigned int    idx
 

Get interface part of CTL element identifier for an entry of a CTL element identifiers list.

Parameters:
obj  CTL element identifier list
idx  Index of entry
Returns:
CTL element related interface

const char* snd_ctl_elem_list_get_name const snd_ctl_elem_list_t   obj,
unsigned int    idx
 

Get name part of CTL element identifier for an entry of a CTL element identifiers list.

Parameters:
obj  CTL element identifier list
idx  Index of entry
Returns:
CTL element name

unsigned int snd_ctl_elem_list_get_numid const snd_ctl_elem_list_t   obj,
unsigned int    idx
 

Get CTL element numeric identifier for an entry of a CTL element identifiers list.

Parameters:
obj  CTL element identifier list
idx  Index of entry
Returns:
CTL element numeric identifier

unsigned int snd_ctl_elem_list_get_subdevice const snd_ctl_elem_list_t   obj,
unsigned int    idx
 

Get subdevice part of CTL element identifier for an entry of a CTL element identifiers list.

Parameters:
obj  CTL element identifier list
idx  Index of entry
Returns:
CTL element related subdevice

unsigned int snd_ctl_elem_list_get_used const snd_ctl_elem_list_t   obj
 

Get number of used entries in CTL element identifiers list.

Parameters:
obj  CTL element identifier list
Returns:
number of used entries

int snd_ctl_elem_list_malloc snd_ctl_elem_list_t **    ptr
 

allocate an invalid snd_ctl_elem_list_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_ctl_elem_list_set_offset snd_ctl_elem_list_t   obj,
unsigned int    val
 

Set index of first wanted CTL element identifier in a CTL element identifiers list.

Parameters:
obj  CTL element identifiers list
val  index of CTL element to put at position 0 of list

size_t snd_ctl_elem_list_sizeof void   
 

get size of snd_ctl_elem_list_t

Returns:
size in bytes

int snd_ctl_elem_lock snd_ctl_t   ctl,
snd_ctl_elem_id_t   id
 

Lock CTL element.

Parameters:
ctl  CTL handle
control  CTL element id pointer
Returns:
0 on success otherwise a negative error code

int snd_ctl_elem_read snd_ctl_t   ctl,
snd_ctl_elem_value_t   control
 

Get CTL element value.

Parameters:
ctl  CTL handle
control  CTL element id/value pointer
Returns:
0 on success otherwise a negative error code

void snd_ctl_elem_set_bytes snd_ctl_elem_value_t   obj,
void *    data,
size_t    size
 

Set CTL element SND_CTL_ELEM_TYPE_BYTES value.

Parameters:
ctl  CTL handle
data  Bytes value
size  Size in bytes

const char* snd_ctl_elem_type_name snd_ctl_elem_type_t    type
 

get name of a CTL element type

Parameters:
type  CTL element type
Returns:
ascii name of CTL element type

int snd_ctl_elem_unlock snd_ctl_t   ctl,
snd_ctl_elem_id_t   id
 

Unlock CTL element.

Parameters:
ctl  CTL handle
control  CTL element id pointer
Returns:
0 on success otherwise a negative error code

void snd_ctl_elem_value_clear snd_ctl_elem_value_t   obj
 

clear given snd_ctl_elem_value_t object

Parameters:
obj  pointer to object to clear

void snd_ctl_elem_value_copy snd_ctl_elem_value_t   dst,
const snd_ctl_elem_value_t   src
 

copy one snd_ctl_elem_value_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_ctl_elem_value_free snd_ctl_elem_value_t   obj
 

frees a previously allocated snd_ctl_elem_value_t

Parameters:
pointer  to object to free

int snd_ctl_elem_value_get_boolean const snd_ctl_elem_value_t   obj,
unsigned int    idx
 

Get value for an entry of a SND_CTL_ELEM_TYPE_BOOLEAN CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
Returns:
value for the entry

unsigned char snd_ctl_elem_value_get_byte const snd_ctl_elem_value_t   obj,
unsigned int    idx
 

Get value for an entry of a SND_CTL_ELEM_TYPE_BYTES CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
Returns:
value for the entry

const void* snd_ctl_elem_value_get_bytes const snd_ctl_elem_value_t   obj
 

Get value for a SND_CTL_ELEM_TYPE_BYTES CTL element id/value.

Parameters:
obj  CTL element id/value
Returns:
Pointer to CTL element value

unsigned int snd_ctl_elem_value_get_device const snd_ctl_elem_value_t   obj
 

Get device part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
Returns:
device part of element identifier

unsigned int snd_ctl_elem_value_get_enumerated const snd_ctl_elem_value_t   obj,
unsigned int    idx
 

Get value for an entry of a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
Returns:
value for the entry

void snd_ctl_elem_value_get_id const snd_ctl_elem_value_t   obj,
snd_ctl_elem_id_t   ptr
 

Get CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
ptr  Pointer to returned CTL element identifier

void snd_ctl_elem_value_get_iec958 const snd_ctl_elem_value_t   obj,
snd_aes_iec958_t   ptr
 

Get value for a SND_CTL_ELEM_TYPE_IEC958 CTL element id/value.

Parameters:
obj  CTL element id/value
Pointer  to returned CTL element value

unsigned int snd_ctl_elem_value_get_index const snd_ctl_elem_value_t   obj
 

Get index part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
Returns:
index part of element identifier

long snd_ctl_elem_value_get_integer const snd_ctl_elem_value_t   obj,
unsigned int    idx
 

Get value for an entry of a SND_CTL_ELEM_TYPE_INTEGER CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
Returns:
value for the entry

long long snd_ctl_elem_value_get_integer64 const snd_ctl_elem_value_t   obj,
unsigned int    idx
 

Get value for an entry of a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
Returns:
value for the entry

snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface const snd_ctl_elem_value_t   obj
 

Get interface part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
Returns:
interface part of element identifier

const char* snd_ctl_elem_value_get_name const snd_ctl_elem_value_t   obj
 

Get name part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
Returns:
name part of element identifier

unsigned int snd_ctl_elem_value_get_numid const snd_ctl_elem_value_t   obj
 

Get element numeric identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
Returns:
element numeric identifier

unsigned int snd_ctl_elem_value_get_subdevice const snd_ctl_elem_value_t   obj
 

Get subdevice part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
Returns:
subdevice part of element identifier

int snd_ctl_elem_value_malloc snd_ctl_elem_value_t **    ptr
 

allocate an invalid snd_ctl_elem_value_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_ctl_elem_value_set_boolean snd_ctl_elem_value_t   obj,
unsigned int    idx,
long    val
 

Set value for an entry of a SND_CTL_ELEM_TYPE_BOOLEAN CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
val  value for the entry

void snd_ctl_elem_value_set_byte snd_ctl_elem_value_t   obj,
unsigned int    idx,
unsigned char    val
 

Set value for an entry of a SND_CTL_ELEM_TYPE_BYTES CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
val  value for the entry

void snd_ctl_elem_value_set_device snd_ctl_elem_value_t   obj,
unsigned int    val
 

Set device part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
val  device part of element identifier

void snd_ctl_elem_value_set_enumerated snd_ctl_elem_value_t   obj,
unsigned int    idx,
unsigned int    val
 

Set value for an entry of a SND_CTL_ELEM_TYPE_ENUMERATED CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
val  value for the entry

void snd_ctl_elem_value_set_id snd_ctl_elem_value_t   obj,
const snd_ctl_elem_id_t   ptr
 

Set CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
ptr  CTL element identifier

void snd_ctl_elem_value_set_iec958 snd_ctl_elem_value_t   obj,
const snd_aes_iec958_t   ptr
 

Set value for a SND_CTL_ELEM_TYPE_IEC958 CTL element id/value.

Parameters:
obj  CTL element id/value
Pointer  to CTL element value

void snd_ctl_elem_value_set_index snd_ctl_elem_value_t   obj,
unsigned int    val
 

Set index part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
val  index part of element identifier

void snd_ctl_elem_value_set_integer snd_ctl_elem_value_t   obj,
unsigned int    idx,
long    val
 

Set value for an entry of a SND_CTL_ELEM_TYPE_INTEGER CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
val  value for the entry

void snd_ctl_elem_value_set_integer64 snd_ctl_elem_value_t   obj,
unsigned int    idx,
long long    val
 

Set value for an entry of a SND_CTL_ELEM_TYPE_INTEGER64 CTL element id/value.

Parameters:
obj  CTL element id/value
idx  Entry index
val  value for the entry

void snd_ctl_elem_value_set_interface snd_ctl_elem_value_t   obj,
snd_ctl_elem_iface_t    val
 

Set interface part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
val  interface part of element identifier

void snd_ctl_elem_value_set_name snd_ctl_elem_value_t   obj,
const char *    val
 

Set name part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
val  name part of element identifier

void snd_ctl_elem_value_set_numid snd_ctl_elem_value_t   obj,
unsigned int    val
 

Set element numeric identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
val  element numeric identifier

void snd_ctl_elem_value_set_subdevice snd_ctl_elem_value_t   obj,
unsigned int    val
 

Set subdevice part of CTL element identifier of a CTL element id/value.

Parameters:
obj  CTL element id/value
val  subdevice part of element identifier

size_t snd_ctl_elem_value_sizeof void   
 

get size of snd_ctl_elem_value_t

Returns:
size in bytes

int snd_ctl_elem_write snd_ctl_t   ctl,
snd_ctl_elem_value_t   control
 

Set CTL element value.

Parameters:
ctl  CTL handle
control  CTL element id/value pointer
Returns:
0 on success otherwise a negative error code

void snd_ctl_event_clear snd_ctl_event_t   obj
 

clear given snd_ctl_event_t object

Parameters:
obj  pointer to object to clear

void snd_ctl_event_copy snd_ctl_event_t   dst,
const snd_ctl_event_t   src
 

copy one snd_ctl_event_t to another

Parameters:
dst  pointer to destination
src  pointer to source

unsigned int snd_ctl_event_elem_get_device const snd_ctl_event_t   obj
 

Get device part of CTL element identifier for an element related event.

Parameters:
obj  CTL event
Returns:
device part of element identifier

void snd_ctl_event_elem_get_id const snd_ctl_event_t   obj,
snd_ctl_elem_id_t   ptr
 

Get CTL element identifier for an element related event.

Parameters:
obj  CTL event
ptr  Pointer to returned CTL element identifier

unsigned int snd_ctl_event_elem_get_index const snd_ctl_event_t   obj
 

Get index part of CTL element identifier for an element related event.

Parameters:
obj  CTL event
Returns:
index part of element identifier

snd_ctl_elem_iface_t snd_ctl_event_elem_get_interface const snd_ctl_event_t   obj
 

Get interface part of CTL element identifier for an element related event.

Parameters:
obj  CTL event
Returns:
interface part of element identifier

unsigned int snd_ctl_event_elem_get_mask const snd_ctl_event_t   obj
 

Get event mask for an element related event.

Parameters:
obj  CTL event
Returns:
event mask for element related event

const char* snd_ctl_event_elem_get_name const snd_ctl_event_t   obj
 

Get name part of CTL element identifier for an element related event.

Parameters:
obj  CTL event
Returns:
name part of element identifier

unsigned int snd_ctl_event_elem_get_numid const snd_ctl_event_t   obj
 

Get element numeric identifier for an element related event.

Parameters:
obj  CTL event
Returns:
element numeric identifier

unsigned int snd_ctl_event_elem_get_subdevice const snd_ctl_event_t   obj
 

Get subdevice part of CTL element identifier for an element related event.

Parameters:
obj  CTL event
Returns:
subdevice part of element identifier

void snd_ctl_event_free snd_ctl_event_t   obj
 

frees a previously allocated snd_ctl_event_t

Parameters:
pointer  to object to free

snd_ctl_event_type_t snd_ctl_event_get_type const snd_ctl_event_t   obj
 

Get type of a CTL event.

Parameters:
obj  CTL event
Returns:
CTL event type

int snd_ctl_event_malloc snd_ctl_event_t **    ptr
 

allocate an invalid snd_ctl_event_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

size_t snd_ctl_event_sizeof void   
 

get size of snd_ctl_event_t

Returns:
size in bytes

const char* snd_ctl_event_type_name snd_ctl_event_type_t    type
 

get name of a CTL event type

Parameters:
type  CTL event type
Returns:
ascii name of CTL event type

int snd_ctl_get_power_state snd_ctl_t   ctl,
unsigned int *    state
 

Get actual Power State.

Parameters:
ctl  CTL handle
state  Destination value
Returns:
0 on success otherwise a negative error code

int snd_ctl_hwdep_info snd_ctl_t   ctl,
snd_hwdep_info_t   info
 

Get info about a hardware dependent device.

Parameters:
ctl  CTL handle
info  Hardware dependent device id/info pointer
Returns:
0 on success otherwise a negative error code

int snd_ctl_hwdep_next_device snd_ctl_t   ctl,
int *    device
 

Get next hardware dependent device number.

Parameters:
ctl  CTL handle
device  current device on entry and next device on return
Returns:
0 on success otherwise a negative error code

const char* snd_ctl_name snd_ctl_t   ctl
 

get identifier of CTL handle

Parameters:
ctl  CTL handle
Returns:
ascii identifier of CTL handle
Returns the ASCII identifier of given CTL handle. It's the same identifier specified in snd_ctl_open().

int snd_ctl_nonblock snd_ctl_t   ctl,
int    nonblock
 

set nonblock mode

Parameters:
ctl  CTL handle
nonblock  0 = block, 1 = nonblock mode
Returns:
0 on success otherwise a negative error code

int snd_ctl_open snd_ctl_t **    ctlp,
const char *    name,
int    mode
 

Opens a CTL.

Parameters:
ctlp  Returned CTL handle
name  ASCII identifier of the CTL handle
mode  Open mode (see SND_CTL_NONBLOCK, SND_CTL_ASYNC)
Returns:
0 on success otherwise a negative error code

int snd_ctl_open_lconf snd_ctl_t **    ctlp,
const char *    name,
int    mode,
snd_config_t   lconf
 

Opens a CTL using local configuration.

Parameters:
ctlp  Returned CTL handle
name  ASCII identifier of the CTL handle
mode  Open mode (see SND_CTL_NONBLOCK, SND_CTL_ASYNC)
lconf  Local configuration
Returns:
0 on success otherwise a negative error code

int snd_ctl_pcm_info snd_ctl_t   ctl,
snd_pcm_info_t   info
 

Get info about a PCM device.

Parameters:
ctl  CTL handle
info  PCM device id/info pointer
Returns:
0 on success otherwise a negative error code

int snd_ctl_pcm_next_device snd_ctl_t   ctl,
int *    device
 

Get next PCM device number.

Parameters:
ctl  CTL handle
device  current device on entry and next device on return
Returns:
0 on success otherwise a negative error code

int snd_ctl_pcm_prefer_subdevice snd_ctl_t   ctl,
int    subdev
 

Set preferred PCM subdevice number of successive PCM open.

Parameters:
ctl  CTL handle
subdev  Preferred PCM subdevice number
Returns:
0 on success otherwise a negative error code

int snd_ctl_poll_descriptors snd_ctl_t   ctl,
struct pollfd *    pfds,
unsigned int    space
 

get poll descriptors

Parameters:
ctl  CTL handle
pfds  array of poll descriptors
space  space in the poll descriptor array
Returns:
count of filled descriptors

int snd_ctl_poll_descriptors_count snd_ctl_t   ctl
 

get count of poll descriptors for CTL handle

Parameters:
ctl  CTL handle
Returns:
count of poll descriptors

int snd_ctl_poll_descriptors_revents snd_ctl_t   ctl,
struct pollfd *    pfds,
unsigned int    nfds,
unsigned short *    revents
 

get returned events from poll descriptors

Parameters:
ctl  CTL handle
pfds  array of poll descriptors
nfds  count of poll descriptors
revents  returned events
Returns:
zero if success, otherwise a negative error code

int snd_ctl_rawmidi_info snd_ctl_t   ctl,
snd_rawmidi_info_t   info
 

Get info about a RawMidi device.

Parameters:
ctl  CTL handle
info  RawMidi device id/info pointer
Returns:
0 on success otherwise a negative error code

int snd_ctl_rawmidi_next_device snd_ctl_t   ctl,
int *    device
 

Get next RawMidi device number.

Parameters:
ctl  CTL handle
device  current device on entry and next device on return
Returns:
0 on success otherwise a negative error code

int snd_ctl_rawmidi_prefer_subdevice snd_ctl_t   ctl,
int    subdev
 

Set preferred RawMidi subdevice number of successive RawMidi open.

Parameters:
ctl  CTL handle
subdev  Preferred RawMidi subdevice number
Returns:
0 on success otherwise a negative error code

int snd_ctl_read snd_ctl_t   ctl,
snd_ctl_event_t   event
 

Read an event.

Parameters:
ctl  CTL handle
event  Event pointer
Returns:
number of events read otherwise a negative error code on failure

int snd_ctl_set_power_state snd_ctl_t   ctl,
unsigned int    state
 

Set Power State to given SND_CTL_POWER_* value and do the power management.

Parameters:
ctl  CTL handle
state  Desired Power State
Returns:
0 on success otherwise a negative error code

int snd_ctl_subscribe_events snd_ctl_t   ctl,
int    subscribe
 

Ask to be informed about events (poll, snd_ctl_async, snd_ctl_read).

Parameters:
ctl  CTL handle
subscribe  0 = unsubscribe, 1 = subscribe
Returns:
0 on success otherwise a negative error code

snd_ctl_type_t snd_ctl_type snd_ctl_t   ctl
 

get type of CTL handle

Parameters:
ctl  CTL handle
Returns:
type of CTL handle
Returns the type snd_ctl_type_t of given CTL handle.

int snd_ctl_wait snd_ctl_t   ctl,
int    timeout
 

Wait for a CTL to become ready (i.e. at least one event pending).

Parameters:
ctl  CTL handle
timeout  maximum time in milliseconds to wait
Returns:
0 otherwise a negative error code on failure


Generated on Thu Jun 12 17:17:10 2003 for ALSA project - the C library reference by doxygen1.2.18