ALSA project - the C library reference
Macros | Functions
control.c File Reference

CTL interface - primitive controls. More...

Include dependency graph for control.c:

Macros

#define validate_element_member_dimension(info)   true
 
#define USER_ACCESS_DEFAULT
 
#define USER_ACCESS_SETTABLE
 

Functions

const char * snd_ctl_name (snd_ctl_t *ctl)
 get identifier of CTL handle More...
 
snd_ctl_type_t snd_ctl_type (snd_ctl_t *ctl)
 get type of CTL handle More...
 
int snd_ctl_close (snd_ctl_t *ctl)
 close CTL handle More...
 
int snd_ctl_nonblock (snd_ctl_t *ctl, int nonblock)
 set nonblock mode More...
 
int snd_ctl_poll_descriptors_count (snd_ctl_t *ctl)
 get count of poll descriptors for CTL handle More...
 
int snd_ctl_poll_descriptors (snd_ctl_t *ctl, struct pollfd *pfds, unsigned int space)
 get poll descriptors More...
 
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 More...
 
int snd_ctl_subscribe_events (snd_ctl_t *ctl, int subscribe)
 Ask to be informed about events (poll, snd_async_add_ctl_handler, snd_ctl_read) More...
 
int snd_ctl_card_info (snd_ctl_t *ctl, snd_ctl_card_info_t *info)
 Get information about the sound card. More...
 
int snd_ctl_elem_list (snd_ctl_t *ctl, snd_ctl_elem_list_t *list)
 Get a list of element identifiers. More...
 
int snd_ctl_elem_info (snd_ctl_t *ctl, snd_ctl_elem_info_t *info)
 Get CTL element information. More...
 
int __snd_ctl_add_elem_set (snd_ctl_t *ctl, snd_ctl_elem_info_t *info, unsigned int element_count, unsigned int member_count)
 
int snd_ctl_add_integer_elem_set (snd_ctl_t *ctl, snd_ctl_elem_info_t *info, unsigned int element_count, unsigned int member_count, long min, long max, long step)
 Create and add some user-defined control elements of integer type. More...
 
int snd_ctl_add_integer64_elem_set (snd_ctl_t *ctl, snd_ctl_elem_info_t *info, unsigned int element_count, unsigned int member_count, long long min, long long max, long long step)
 Create and add some user-defined control elements of integer64 type. More...
 
int snd_ctl_add_boolean_elem_set (snd_ctl_t *ctl, snd_ctl_elem_info_t *info, unsigned int element_count, unsigned int member_count)
 Create and add some user-defined control elements of boolean type. More...
 
int snd_ctl_add_enumerated_elem_set (snd_ctl_t *ctl, snd_ctl_elem_info_t *info, unsigned int element_count, unsigned int member_count, unsigned int items, const char *const labels[])
 Create and add some user-defined control elements of enumerated type. More...
 
int snd_ctl_add_bytes_elem_set (snd_ctl_t *ctl, snd_ctl_elem_info_t *info, unsigned int element_count, unsigned int member_count)
 Create and add some user-defined control elements of bytes type. More...
 
int snd_ctl_elem_add_integer (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int member_count, long min, long max, long step)
 Create and add an user-defined control element of integer type. More...
 
int snd_ctl_elem_add_integer64 (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int member_count, long long min, long long max, long long step)
 Create and add an user-defined control element of integer64 type. More...
 
int snd_ctl_elem_add_boolean (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int member_count)
 Create and add an user-defined control element of boolean type. More...
 
int snd_ctl_elem_add_enumerated (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int member_count, unsigned int items, const char *const labels[])
 Create and add a user-defined control element of enumerated type. More...
 
int snd_ctl_elem_add_iec958 (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id)
 Create and add a user-defined control element of IEC958 type. More...
 
int snd_ctl_elem_remove (snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
 Remove an user CTL element. More...
 
int snd_ctl_elem_read (snd_ctl_t *ctl, snd_ctl_elem_value_t *data)
 Get CTL element value. More...
 
int snd_ctl_elem_write (snd_ctl_t *ctl, snd_ctl_elem_value_t *data)
 Set CTL element value. More...
 
int snd_ctl_elem_tlv_read (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int *tlv, unsigned int tlv_size)
 Read structured data from an element set to given buffer. More...
 
int snd_ctl_elem_tlv_write (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, const unsigned int *tlv)
 Write structured data from given buffer to an element set. More...
 
int snd_ctl_elem_tlv_command (snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, const unsigned int *tlv)
 Process structured data from given buffer for an element set. More...
 
int snd_ctl_elem_lock (snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
 Lock CTL element. More...
 
int snd_ctl_elem_unlock (snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
 Unlock CTL element. More...
 
int snd_ctl_hwdep_next_device (snd_ctl_t *ctl, int *device)
 Get next hardware dependent device number. More...
 
int snd_ctl_hwdep_info (snd_ctl_t *ctl, snd_hwdep_info_t *info)
 Get info about a hardware dependent device. More...
 
int snd_ctl_pcm_next_device (snd_ctl_t *ctl, int *device)
 Get next PCM device number. More...
 
int snd_ctl_pcm_info (snd_ctl_t *ctl, snd_pcm_info_t *info)
 Get info about a PCM device. More...
 
int snd_ctl_pcm_prefer_subdevice (snd_ctl_t *ctl, int subdev)
 Set preferred PCM subdevice number of successive PCM open. More...
 
int snd_ctl_rawmidi_next_device (snd_ctl_t *ctl, int *device)
 Get next RawMidi device number. More...
 
int snd_ctl_rawmidi_info (snd_ctl_t *ctl, snd_rawmidi_info_t *info)
 Get info about a RawMidi device. More...
 
int snd_ctl_rawmidi_prefer_subdevice (snd_ctl_t *ctl, int subdev)
 Set preferred RawMidi subdevice number of successive RawMidi open. More...
 
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. More...
 
int snd_ctl_get_power_state (snd_ctl_t *ctl, unsigned int *state)
 Get actual Power State. More...
 
int snd_ctl_read (snd_ctl_t *ctl, snd_ctl_event_t *event)
 Read an event. More...
 
int snd_ctl_wait (snd_ctl_t *ctl, int timeout)
 Wait for a CTL to become ready (i.e. at least one event pending) More...
 
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. More...
 
snd_ctl_tsnd_async_handler_get_ctl (snd_async_handler_t *handler)
 Return CTL handle related to an async handler. More...
 
int snd_ctl_open (snd_ctl_t **ctlp, const char *name, int mode)
 Opens a sound card. More...
 
int snd_ctl_open_lconf (snd_ctl_t **ctlp, const char *name, int mode, snd_config_t *lconf)
 Opens a CTL using local configuration. More...
 
int snd_ctl_open_fallback (snd_ctl_t **ctlp, snd_config_t *root, const char *name, const char *orig_name, int mode)
 Opens a fallback CTL. More...
 
const char * snd_ctl_elem_type_name (snd_ctl_elem_type_t type)
 get name of a CTL element type More...
 
const char * snd_ctl_elem_iface_name (snd_ctl_elem_iface_t iface)
 get name of a CTL element related interface More...
 
const char * snd_ctl_event_type_name (snd_ctl_event_type_t type)
 get name of a CTL event type More...
 
int snd_ctl_elem_list_alloc_space (snd_ctl_elem_list_t *obj, unsigned int entries)
 allocate space for CTL element identifiers list More...
 
void snd_ctl_elem_list_free_space (snd_ctl_elem_list_t *obj)
 free previously allocated space for CTL element identifiers list More...
 
unsigned int snd_ctl_event_elem_get_mask (const snd_ctl_event_t *obj)
 Get event mask for an element related event. More...
 
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. More...
 
unsigned int snd_ctl_event_elem_get_numid (const snd_ctl_event_t *obj)
 Get element numeric identifier for an element related event. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
size_t snd_ctl_elem_id_sizeof ()
 get size of snd_ctl_elem_id_t More...
 
int snd_ctl_elem_id_malloc (snd_ctl_elem_id_t **ptr)
 allocate an invalid snd_ctl_elem_id_t using standard malloc More...
 
void snd_ctl_elem_id_free (snd_ctl_elem_id_t *obj)
 frees a previously allocated snd_ctl_elem_id_t More...
 
void snd_ctl_elem_id_clear (snd_ctl_elem_id_t *obj)
 clear given snd_ctl_elem_id_t object More...
 
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 More...
 
int snd_ctl_elem_id_compare_numid (const snd_ctl_elem_id_t *id1, const snd_ctl_elem_id_t *id2)
 compare one snd_ctl_elem_id_t to another using numid More...
 
int snd_ctl_elem_id_compare_set (const snd_ctl_elem_id_t *id1, const snd_ctl_elem_id_t *id2)
 compare one snd_ctl_elem_id_t to another More...
 
unsigned int snd_ctl_elem_id_get_numid (const snd_ctl_elem_id_t *obj)
 Get numeric identifier from a CTL element identifier. More...
 
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. More...
 
unsigned int snd_ctl_elem_id_get_device (const snd_ctl_elem_id_t *obj)
 Get device part of a CTL element identifier. More...
 
unsigned int snd_ctl_elem_id_get_subdevice (const snd_ctl_elem_id_t *obj)
 Get subdevice part of a CTL element identifier. More...
 
const char * snd_ctl_elem_id_get_name (const snd_ctl_elem_id_t *obj)
 Get name part of a CTL element identifier. More...
 
unsigned int snd_ctl_elem_id_get_index (const snd_ctl_elem_id_t *obj)
 Get index part of a CTL element identifier. More...
 
void snd_ctl_elem_id_set_numid (snd_ctl_elem_id_t *obj, unsigned int val)
 Set numeric identifier for a CTL element identifier. More...
 
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. More...
 
void snd_ctl_elem_id_set_device (snd_ctl_elem_id_t *obj, unsigned int val)
 Set device part for a CTL element identifier. More...
 
void snd_ctl_elem_id_set_subdevice (snd_ctl_elem_id_t *obj, unsigned int val)
 Set subdevice part for a CTL element identifier. More...
 
void snd_ctl_elem_id_set_name (snd_ctl_elem_id_t *obj, const char *val)
 Set name part for a CTL element identifier. More...
 
void snd_ctl_elem_id_set_index (snd_ctl_elem_id_t *obj, unsigned int val)
 Set index part for a CTL element identifier. More...
 
size_t snd_ctl_card_info_sizeof ()
 get size of snd_ctl_card_info_t. More...
 
int snd_ctl_card_info_malloc (snd_ctl_card_info_t **ptr)
 Allocate an invalid snd_ctl_card_info_t on the heap. More...
 
void snd_ctl_card_info_free (snd_ctl_card_info_t *obj)
 Free an snd_ctl_card_info_t previously allocated using snd_ctl_card_info_malloc(). More...
 
void snd_ctl_card_info_clear (snd_ctl_card_info_t *obj)
 Clear given card info object. More...
 
void snd_ctl_card_info_copy (snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src)
 Bitwise copy of a snd_ctl_card_info_t object. More...
 
int snd_ctl_card_info_get_card (const snd_ctl_card_info_t *obj)
 Get the sound card index from the given info object. More...
 
const char * snd_ctl_card_info_get_id (const snd_ctl_card_info_t *obj)
 Get the sound card ID from the given info object. More...
 
const char * snd_ctl_card_info_get_driver (const snd_ctl_card_info_t *obj)
 Get the sound card driver from the given info object. More...
 
const char * snd_ctl_card_info_get_name (const snd_ctl_card_info_t *obj)
 Get the sound card name from the given info object. More...
 
const char * snd_ctl_card_info_get_longname (const snd_ctl_card_info_t *obj)
 Get the sound cards long name from the given info object. More...
 
const char * snd_ctl_card_info_get_mixername (const snd_ctl_card_info_t *obj)
 Get the sound card mixer name from the given info object. More...
 
const char * snd_ctl_card_info_get_components (const snd_ctl_card_info_t *obj)
 Get the sound cards "components" property from the given info object. More...
 
size_t snd_ctl_event_sizeof ()
 get size of snd_ctl_event_t More...
 
int snd_ctl_event_malloc (snd_ctl_event_t **ptr)
 allocate an invalid snd_ctl_event_t using standard malloc More...
 
void snd_ctl_event_free (snd_ctl_event_t *obj)
 frees a previously allocated snd_ctl_event_t More...
 
void snd_ctl_event_clear (snd_ctl_event_t *obj)
 clear given snd_ctl_event_t object More...
 
void snd_ctl_event_copy (snd_ctl_event_t *dst, const snd_ctl_event_t *src)
 copy one snd_ctl_event_t to another More...
 
snd_ctl_event_type_t snd_ctl_event_get_type (const snd_ctl_event_t *obj)
 Get type of a CTL event. More...
 
size_t snd_ctl_elem_list_sizeof ()
 get size of snd_ctl_elem_list_t. More...
 
int snd_ctl_elem_list_malloc (snd_ctl_elem_list_t **ptr)
 allocate a snd_ctl_elem_list_t using standard malloc. More...
 
void snd_ctl_elem_list_free (snd_ctl_elem_list_t *obj)
 frees a previously allocated snd_ctl_elem_list_t. More...
 
void snd_ctl_elem_list_clear (snd_ctl_elem_list_t *obj)
 Clear given snd_ctl_elem_list_t object. More...
 
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. More...
 
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. More...
 
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. More...
 
unsigned int snd_ctl_elem_list_get_count (const snd_ctl_elem_list_t *obj)
 Get total count of elements present in CTL device. More...
 
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. More...
 
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. More...
 
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. More...
 
unsigned int snd_ctl_elem_list_get_device (const snd_ctl_elem_list_t *obj, unsigned int idx)
 Get the device part of CTL element identifier for an entry of a CTL element identifiers list. More...
 
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. More...
 
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. More...
 
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. More...
 
size_t snd_ctl_elem_info_sizeof ()
 get size of snd_ctl_elem_info_t More...
 
int snd_ctl_elem_info_malloc (snd_ctl_elem_info_t **ptr)
 allocate an invalid snd_ctl_elem_info_t using standard malloc More...
 
void snd_ctl_elem_info_free (snd_ctl_elem_info_t *obj)
 frees a previously allocated snd_ctl_elem_info_t More...
 
void snd_ctl_elem_info_clear (snd_ctl_elem_info_t *obj)
 clear given snd_ctl_elem_info_t object More...
 
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 More...
 
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. More...
 
int snd_ctl_elem_info_is_readable (const snd_ctl_elem_info_t *obj)
 Get info about readability from a CTL element id/info. More...
 
int snd_ctl_elem_info_is_writable (const snd_ctl_elem_info_t *obj)
 Get info about writability from a CTL element id/info. More...
 
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. More...
 
int snd_ctl_elem_info_is_inactive (const snd_ctl_elem_info_t *obj)
 Get info about status from a CTL element id/info. More...
 
int snd_ctl_elem_info_is_locked (const snd_ctl_elem_info_t *obj)
 Get info whether an element is locked. More...
 
int snd_ctl_elem_info_is_owner (const snd_ctl_elem_info_t *obj)
 Get info if I own an element. More...
 
int snd_ctl_elem_info_is_user (const snd_ctl_elem_info_t *obj)
 Get info if it's a user element. More...
 
int snd_ctl_elem_info_is_tlv_readable (const snd_ctl_elem_info_t *obj)
 Get info about TLV readability from a CTL element id/info. More...
 
int snd_ctl_elem_info_is_tlv_writable (const snd_ctl_elem_info_t *obj)
 Get info about TLV writeability from a CTL element id/info. More...
 
int snd_ctl_elem_info_is_tlv_commandable (const snd_ctl_elem_info_t *obj)
 Get info about TLV command possibility from a CTL element id/info. More...
 
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 More...
 
pid_t snd_ctl_elem_info_get_owner (const snd_ctl_elem_info_t *obj)
 Get owner of a locked element. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
int snd_ctl_elem_info_get_dimensions (const snd_ctl_elem_info_t *obj)
 Get count of dimensions for given element. More...
 
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. More...
 
int snd_ctl_elem_info_set_dimension (snd_ctl_elem_info_t *info, const int dimension[4])
 Set width to a specified dimension level of given element information. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void snd_ctl_elem_info_set_read_write (snd_ctl_elem_info_t *obj, int rval, int wval)
 Set readability/writeability parameter of a CTL element id/info. More...
 
void snd_ctl_elem_info_set_tlv_read_write (snd_ctl_elem_info_t *obj, int rval, int wval)
 Set TLV readability/writeability parameter of a CTL element id/info. More...
 
void snd_ctl_elem_info_set_inactive (snd_ctl_elem_info_t *obj, int val)
 Set inactive parameter of a CTL element id/info. More...
 
size_t snd_ctl_elem_value_sizeof ()
 Get size of data structure for an element. More...
 
int snd_ctl_elem_value_malloc (snd_ctl_elem_value_t **ptr)
 Allocate an invalid snd_ctl_elem_value_t on the heap. More...
 
void snd_ctl_elem_value_free (snd_ctl_elem_value_t *obj)
 Free an snd_ctl_elem_value_t previously allocated using snd_ctl_elem_value_malloc(). More...
 
void snd_ctl_elem_value_clear (snd_ctl_elem_value_t *obj)
 Clear given data of an element. More...
 
void snd_ctl_elem_value_copy (snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src)
 Bitwise copy of a snd_ctl_elem_value_t value. More...
 
int snd_ctl_elem_value_compare (snd_ctl_elem_value_t *left, const snd_ctl_elem_value_t *right)
 Compare two snd_ctl_elem_value_t values, bytewise. More...
 
void snd_ctl_elem_value_get_id (const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr)
 Get the element identifier from the given element value. More...
 
unsigned int snd_ctl_elem_value_get_numid (const snd_ctl_elem_value_t *obj)
 Get the identifiers 'numid' part from the given element value. More...
 
snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface (const snd_ctl_elem_value_t *obj)
 Get the identifiers 'interface' part from the given element value. More...
 
unsigned int snd_ctl_elem_value_get_device (const snd_ctl_elem_value_t *obj)
 Get the identifiers 'device' part from the given element value. More...
 
unsigned int snd_ctl_elem_value_get_subdevice (const snd_ctl_elem_value_t *obj)
 Get the identifiers 'subdevice' part from the given element value. More...
 
const char * snd_ctl_elem_value_get_name (const snd_ctl_elem_value_t *obj)
 Get the identifiers 'name' part from the given element value. More...
 
unsigned int snd_ctl_elem_value_get_index (const snd_ctl_elem_value_t *obj)
 Get the identifiers 'index' part from the given element value. More...
 
void snd_ctl_elem_value_set_id (snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr)
 Set the element identifier within the given element value. More...
 
void snd_ctl_elem_value_set_numid (snd_ctl_elem_value_t *obj, unsigned int val)
 Set the identifiers 'numid' part within the given element value. More...
 
void snd_ctl_elem_value_set_interface (snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val)
 Set the identifiers 'interface' part within the given element value. More...
 
void snd_ctl_elem_value_set_device (snd_ctl_elem_value_t *obj, unsigned int val)
 Set the identifiers 'device' part within the given element value. More...
 
void snd_ctl_elem_value_set_subdevice (snd_ctl_elem_value_t *obj, unsigned int val)
 Set the identifiers 'subdevice' part within the given element value. More...
 
void snd_ctl_elem_value_set_name (snd_ctl_elem_value_t *obj, const char *val)
 Set the identifiers 'name' part within the given element value. More...
 
void snd_ctl_elem_value_set_index (snd_ctl_elem_value_t *obj, unsigned int val)
 Set the identifiers 'index' part within the given element value. More...
 
int snd_ctl_elem_value_get_boolean (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get an element members value. More...
 
long snd_ctl_elem_value_get_integer (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get an element members value. More...
 
long long snd_ctl_elem_value_get_integer64 (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get an element members value. More...
 
unsigned int snd_ctl_elem_value_get_enumerated (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get an element members value. More...
 
unsigned char snd_ctl_elem_value_get_byte (const snd_ctl_elem_value_t *obj, unsigned int idx)
 Get an element members value. More...
 
void snd_ctl_elem_value_set_boolean (snd_ctl_elem_value_t *obj, unsigned int idx, long val)
 Set an element members value. More...
 
void snd_ctl_elem_value_set_integer (snd_ctl_elem_value_t *obj, unsigned int idx, long val)
 Set an element members value. More...
 
void snd_ctl_elem_value_set_integer64 (snd_ctl_elem_value_t *obj, unsigned int idx, long long val)
 Set an element members value. More...
 
void snd_ctl_elem_value_set_enumerated (snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val)
 Set an element members value. More...
 
void snd_ctl_elem_value_set_byte (snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val)
 Set an element members value. More...
 
void snd_ctl_elem_set_bytes (snd_ctl_elem_value_t *obj, void *data, size_t size)
 Replace the data stored within the element. More...
 
const void * snd_ctl_elem_value_get_bytes (const snd_ctl_elem_value_t *obj)
 Get the data stored within the element. More...
 
void snd_ctl_elem_value_get_iec958 (const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr)
 Get an elements IEC958 data. More...
 
void snd_ctl_elem_value_set_iec958 (snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr)
 Set an elements IEC958 data. More...
 

Detailed Description

CTL interface - primitive controls.

CTL interface - parse ASCII identifiers and values.

Author
Abramo Bagnara abram.nosp@m.o@al.nosp@m.sa-pr.nosp@m.ojec.nosp@m.t.org
Date
2000

CTL interface is designed to access primitive controls. See Control interface page for more details.

Author
Jaroslav Kysela perex.nosp@m.@per.nosp@m.ex.cz
Date
2010

Macro Definition Documentation

◆ USER_ACCESS_DEFAULT

#define USER_ACCESS_DEFAULT
Value:
(\
SNDRV_CTL_ELEM_ACCESS_READWRITE |\
SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE |\
SNDRV_CTL_ELEM_ACCESS_USER)

◆ USER_ACCESS_SETTABLE

#define USER_ACCESS_SETTABLE
Value:
(\
SNDRV_CTL_ELEM_ACCESS_READWRITE |\
SNDRV_CTL_ELEM_ACCESS_VOLATILE |\
SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE |\
SNDRV_CTL_ELEM_ACCESS_INACTIVE |\
SNDRV_CTL_ELEM_ACCESS_USER)

Function Documentation

◆ snd_ctl_elem_info_is_indirect()

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
objCTL element id/info
Returns
0 if element value need to be passed by contents, 1 if need to be passed with a pointer

◆ snd_ctl_hwdep_info()

int snd_ctl_hwdep_info ( snd_ctl_t ctl,
snd_hwdep_info_t info 
)

Get info about a hardware dependent device.

Parameters
ctlCTL handle
infoHardware dependent device id/info pointer
Returns
0 on success otherwise a negative error code

◆ snd_ctl_hwdep_next_device()

int snd_ctl_hwdep_next_device ( snd_ctl_t ctl,
int *  device 
)

Get next hardware dependent device number.

Parameters
ctlCTL handle
devicecurrent device on entry and next device on return
Returns
0 on success otherwise a negative error code

◆ snd_ctl_pcm_info()

int snd_ctl_pcm_info ( snd_ctl_t ctl,
snd_pcm_info_t info 
)

Get info about a PCM device.

Parameters
ctlCTL handle
infoPCM device id/info pointer
Returns
0 on success otherwise a negative error code

◆ snd_ctl_pcm_next_device()

int snd_ctl_pcm_next_device ( snd_ctl_t ctl,
int *  device 
)

Get next PCM device number.

Parameters
ctlCTL handle
devicecurrent device on entry and next device on return
Returns
0 on success otherwise a negative error code

◆ snd_ctl_pcm_prefer_subdevice()

int snd_ctl_pcm_prefer_subdevice ( snd_ctl_t ctl,
int  subdev 
)

Set preferred PCM subdevice number of successive PCM open.

Parameters
ctlCTL handle
subdevPreferred PCM subdevice number
Returns
0 on success otherwise a negative error code

◆ snd_ctl_rawmidi_info()

int snd_ctl_rawmidi_info ( snd_ctl_t ctl,
snd_rawmidi_info_t info 
)

Get info about a RawMidi device.

Parameters
ctlCTL handle
infoRawMidi device id/info pointer
Returns
0 on success otherwise a negative error code

◆ snd_ctl_rawmidi_next_device()

int snd_ctl_rawmidi_next_device ( snd_ctl_t ctl,
int *  device 
)

Get next RawMidi device number.

Parameters
ctlCTL handle
devicecurrent device on entry and next device on return
Returns
0 on success otherwise a negative error code

◆ snd_ctl_rawmidi_prefer_subdevice()

int snd_ctl_rawmidi_prefer_subdevice ( snd_ctl_t ctl,
int  subdev 
)

Set preferred RawMidi subdevice number of successive RawMidi open.

Parameters
ctlCTL handle
subdevPreferred RawMidi subdevice number
Returns
0 on success otherwise a negative error code