ALSA project - the C library reference
Functions
pcm.c File Reference

PCM Interface. More...

Include dependency graph for pcm.c:

Functions

const char * snd_pcm_name (snd_pcm_t *pcm)
 get identifier of PCM handle More...
 
snd_pcm_type_t snd_pcm_type (snd_pcm_t *pcm)
 get type of PCM handle More...
 
snd_pcm_stream_t snd_pcm_stream (snd_pcm_t *pcm)
 get stream for a PCM handle More...
 
int snd_pcm_close (snd_pcm_t *pcm)
 close PCM handle More...
 
int snd_pcm_nonblock (snd_pcm_t *pcm, int nonblock)
 set nonblock mode More...
 
int snd_pcm_info (snd_pcm_t *pcm, snd_pcm_info_t *info)
 Obtain general (static) information for PCM handle. More...
 
int snd_pcm_hw_params_current (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Retreive current PCM hardware configuration chosen with snd_pcm_hw_params. More...
 
int snd_pcm_hw_params (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Install one PCM hardware configuration chosen from a configuration space and snd_pcm_prepare it. More...
 
int snd_pcm_hw_free (snd_pcm_t *pcm)
 Remove PCM hardware configuration and free associated resources. More...
 
int snd_pcm_sw_params (snd_pcm_t *pcm, snd_pcm_sw_params_t *params)
 Install PCM software configuration defined by params. More...
 
int snd_pcm_status (snd_pcm_t *pcm, snd_pcm_status_t *status)
 Obtain status (runtime) information for PCM handle. More...
 
snd_pcm_state_t snd_pcm_state (snd_pcm_t *pcm)
 Return PCM state. More...
 
int snd_pcm_hwsync (snd_pcm_t *pcm)
 (DEPRECATED) Synchronize stream position with hardware More...
 
int snd_pcm_delay (snd_pcm_t *pcm, snd_pcm_sframes_t *delayp)
 Obtain delay for a running PCM handle. More...
 
int snd_pcm_resume (snd_pcm_t *pcm)
 Resume from suspend, no samples are lost. More...
 
int snd_pcm_htimestamp (snd_pcm_t *pcm, snd_pcm_uframes_t *avail, snd_htimestamp_t *tstamp)
 Obtain last position update hi-res timestamp. More...
 
int snd_pcm_prepare (snd_pcm_t *pcm)
 Prepare PCM for use. More...
 
int snd_pcm_reset (snd_pcm_t *pcm)
 Reset PCM position. More...
 
int snd_pcm_start (snd_pcm_t *pcm)
 Start a PCM. More...
 
int snd_pcm_drop (snd_pcm_t *pcm)
 Stop a PCM dropping pending frames. More...
 
int snd_pcm_drain (snd_pcm_t *pcm)
 Stop a PCM preserving pending frames. More...
 
int snd_pcm_pause (snd_pcm_t *pcm, int enable)
 Pause/resume PCM. More...
 
snd_pcm_sframes_t snd_pcm_rewindable (snd_pcm_t *pcm)
 Get safe count of frames which can be rewinded. More...
 
snd_pcm_sframes_t snd_pcm_rewind (snd_pcm_t *pcm, snd_pcm_uframes_t frames)
 Move application frame position backward. More...
 
snd_pcm_sframes_t snd_pcm_forwardable (snd_pcm_t *pcm)
 Get safe count of frames which can be forwarded. More...
 
snd_pcm_sframes_t snd_pcm_forward (snd_pcm_t *pcm, snd_pcm_uframes_t frames)
 Move application frame position forward. More...
 
snd_pcm_sframes_t snd_pcm_writei (snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size)
 Write interleaved frames to a PCM. More...
 
snd_pcm_sframes_t snd_pcm_writen (snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size)
 Write non interleaved frames to a PCM. More...
 
snd_pcm_sframes_t snd_pcm_readi (snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size)
 Read interleaved frames from a PCM. More...
 
snd_pcm_sframes_t snd_pcm_readn (snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size)
 Read non interleaved frames to a PCM. More...
 
int snd_pcm_link (snd_pcm_t *pcm1, snd_pcm_t *pcm2)
 Link two PCMs. More...
 
int snd_pcm_unlink (snd_pcm_t *pcm)
 Remove a PCM from a linked group. More...
 
int snd_pcm_poll_descriptors_count (snd_pcm_t *pcm)
 get count of poll descriptors for PCM handle More...
 
int snd_pcm_poll_descriptors (snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space)
 get poll descriptors More...
 
int snd_pcm_poll_descriptors_revents (snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
 get returned events from poll descriptors More...
 
const char * snd_pcm_stream_name (const snd_pcm_stream_t stream)
 get name of PCM stream type More...
 
const char * snd_pcm_access_name (const snd_pcm_access_t acc)
 get name of PCM access type More...
 
const char * snd_pcm_format_name (const snd_pcm_format_t format)
 get name of PCM sample format More...
 
const char * snd_pcm_format_description (const snd_pcm_format_t format)
 get description of PCM sample format More...
 
snd_pcm_format_t snd_pcm_format_value (const char *name)
 get PCM sample format from name More...
 
const char * snd_pcm_subformat_name (const snd_pcm_subformat_t subformat)
 get name of PCM sample subformat More...
 
const char * snd_pcm_subformat_description (const snd_pcm_subformat_t subformat)
 get description of PCM sample subformat More...
 
const char * snd_pcm_start_mode_name (snd_pcm_start_t mode)
 (DEPRECATED) get name of PCM start mode setting More...
 
const char * snd_pcm_xrun_mode_name (snd_pcm_xrun_t mode)
 (DEPRECATED) get name of PCM xrun mode setting More...
 
const char * snd_pcm_tstamp_mode_name (const snd_pcm_tstamp_t mode)
 get name of PCM tstamp mode setting More...
 
const char * snd_pcm_tstamp_type_name (snd_pcm_tstamp_type_t type)
 get name of PCM tstamp type setting More...
 
const char * snd_pcm_state_name (const snd_pcm_state_t state)
 get name of PCM state More...
 
const char * snd_pcm_type_name (snd_pcm_type_t type)
 get name of PCM type More...
 
int snd_pcm_dump_hw_setup (snd_pcm_t *pcm, snd_output_t *out)
 Dump current hardware setup for PCM. More...
 
int snd_pcm_dump_sw_setup (snd_pcm_t *pcm, snd_output_t *out)
 Dump current software setup for PCM. More...
 
int snd_pcm_dump_setup (snd_pcm_t *pcm, snd_output_t *out)
 Dump current setup (hardware and software) for PCM. More...
 
int snd_pcm_status_dump (snd_pcm_status_t *status, snd_output_t *out)
 Dump status. More...
 
int snd_pcm_dump (snd_pcm_t *pcm, snd_output_t *out)
 Dump PCM info. More...
 
snd_pcm_sframes_t snd_pcm_bytes_to_frames (snd_pcm_t *pcm, ssize_t bytes)
 Convert bytes in frames for a PCM. More...
 
ssize_t snd_pcm_frames_to_bytes (snd_pcm_t *pcm, snd_pcm_sframes_t frames)
 Convert frames in bytes for a PCM. More...
 
long snd_pcm_bytes_to_samples (snd_pcm_t *pcm, ssize_t bytes)
 Convert bytes in samples for a PCM. More...
 
ssize_t snd_pcm_samples_to_bytes (snd_pcm_t *pcm, long samples)
 Convert samples in bytes for a PCM. More...
 
int snd_async_add_pcm_handler (snd_async_handler_t **handler, snd_pcm_t *pcm, snd_async_callback_t callback, void *private_data)
 Add an async handler for a PCM. More...
 
snd_pcm_tsnd_async_handler_get_pcm (snd_async_handler_t *handler)
 Return PCM handle related to an async handler. More...
 
int snd_pcm_open (snd_pcm_t **pcmp, const char *name, snd_pcm_stream_t stream, int mode)
 Opens a PCM. More...
 
int snd_pcm_open_lconf (snd_pcm_t **pcmp, const char *name, snd_pcm_stream_t stream, int mode, snd_config_t *lconf)
 Opens a PCM using local configuration. More...
 
int snd_pcm_open_fallback (snd_pcm_t **pcmp, snd_config_t *root, const char *name, const char *orig_name, snd_pcm_stream_t stream, int mode)
 Opens a fallback PCM. More...
 
int snd_pcm_wait (snd_pcm_t *pcm, int timeout)
 Wait for a PCM to become ready. More...
 
snd_pcm_sframes_t snd_pcm_avail_update (snd_pcm_t *pcm)
 Return number of frames ready to be read (capture) / written (playback) More...
 
snd_pcm_sframes_t snd_pcm_avail (snd_pcm_t *pcm)
 Return number of frames ready to be read (capture) / written (playback) More...
 
int snd_pcm_avail_delay (snd_pcm_t *pcm, snd_pcm_sframes_t *availp, snd_pcm_sframes_t *delayp)
 Combine snd_pcm_avail and snd_pcm_delay functions. More...
 
int snd_pcm_area_silence (const snd_pcm_channel_area_t *dst_area, snd_pcm_uframes_t dst_offset, unsigned int samples, snd_pcm_format_t format)
 Silence an area. More...
 
int snd_pcm_areas_silence (const snd_pcm_channel_area_t *dst_areas, snd_pcm_uframes_t dst_offset, unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format)
 Silence one or more areas. More...
 
int snd_pcm_area_copy (const snd_pcm_channel_area_t *dst_area, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t *src_area, snd_pcm_uframes_t src_offset, unsigned int samples, snd_pcm_format_t format)
 Copy an area. More...
 
int snd_pcm_areas_copy (const snd_pcm_channel_area_t *dst_areas, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t *src_areas, snd_pcm_uframes_t src_offset, unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format)
 Copy one or more areas. More...
 
int snd_pcm_areas_copy_wrap (const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset, const snd_pcm_uframes_t dst_size, const snd_pcm_channel_area_t *src_channels, snd_pcm_uframes_t src_offset, const snd_pcm_uframes_t src_size, const unsigned int channels, snd_pcm_uframes_t frames, const snd_pcm_format_t format)
 Copy one or more areas. More...
 
int snd_pcm_hw_params_dump (snd_pcm_hw_params_t *params, snd_output_t *out)
 Dump a PCM hardware configuration space. More...
 
int snd_pcm_hw_params_can_mmap_sample_resolution (const snd_pcm_hw_params_t *params)
 Check if hardware supports sample-resolution mmap for given configuration. More...
 
int snd_pcm_hw_params_is_double (const snd_pcm_hw_params_t *params)
 Check if hardware does double buffering for start/stop for given configuration. More...
 
int snd_pcm_hw_params_is_batch (const snd_pcm_hw_params_t *params)
 Check if hardware does double buffering for data transfers for given configuration. More...
 
int snd_pcm_hw_params_is_block_transfer (const snd_pcm_hw_params_t *params)
 Check if hardware does block transfers for samples for given configuration. More...
 
int snd_pcm_hw_params_is_monotonic (const snd_pcm_hw_params_t *params)
 Check if timestamps are monotonic for given configuration. More...
 
int snd_pcm_hw_params_can_overrange (const snd_pcm_hw_params_t *params)
 Check if hardware supports overrange detection. More...
 
int snd_pcm_hw_params_can_pause (const snd_pcm_hw_params_t *params)
 Check if hardware supports pause. More...
 
int snd_pcm_hw_params_can_resume (const snd_pcm_hw_params_t *params)
 Check if hardware supports resume. More...
 
int snd_pcm_hw_params_is_half_duplex (const snd_pcm_hw_params_t *params)
 Check if hardware does half-duplex only. More...
 
int snd_pcm_hw_params_is_joint_duplex (const snd_pcm_hw_params_t *params)
 Check if hardware does joint-duplex (playback and capture are somewhat correlated) More...
 
int snd_pcm_hw_params_can_sync_start (const snd_pcm_hw_params_t *params)
 Check if hardware supports synchronized start with sample resolution. More...
 
int snd_pcm_hw_params_can_disable_period_wakeup (const snd_pcm_hw_params_t *params)
 Check if hardware can disable period wakeups. More...
 
int snd_pcm_hw_params_supports_audio_wallclock_ts (const snd_pcm_hw_params_t *params)
 Check if hardware supports audio wallclock timestamps. More...
 
int snd_pcm_hw_params_supports_audio_ts_type (const snd_pcm_hw_params_t *params, int type)
 Check if hardware supports type of audio timestamps. More...
 
int snd_pcm_hw_params_get_rate_numden (const snd_pcm_hw_params_t *params, unsigned int *rate_num, unsigned int *rate_den)
 Get rate exact info from a configuration space. More...
 
int snd_pcm_hw_params_get_sbits (const snd_pcm_hw_params_t *params)
 Get sample resolution info from a configuration space. More...
 
int snd_pcm_hw_params_get_fifo_size (const snd_pcm_hw_params_t *params)
 Get hardware FIFO size info from a configuration space. More...
 
int snd_pcm_hw_params_any (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Fill params with a full configuration space for a PCM. More...
 
size_t snd_pcm_access_mask_sizeof ()
 get size of snd_pcm_access_mask_t More...
 
int snd_pcm_access_mask_malloc (snd_pcm_access_mask_t **ptr)
 allocate an empty snd_pcm_access_mask_t using standard malloc More...
 
void snd_pcm_access_mask_free (snd_pcm_access_mask_t *obj)
 frees a previously allocated snd_pcm_access_mask_t More...
 
void snd_pcm_access_mask_copy (snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src)
 copy one snd_pcm_access_mask_t to another More...
 
void snd_pcm_access_mask_none (snd_pcm_access_mask_t *mask)
 reset all bits in a snd_pcm_access_mask_t More...
 
void snd_pcm_access_mask_any (snd_pcm_access_mask_t *mask)
 set all bits in a snd_pcm_access_mask_t More...
 
int snd_pcm_access_mask_test (const snd_pcm_access_mask_t *mask, snd_pcm_access_t val)
 test the presence of an access type in a snd_pcm_access_mask_t More...
 
int snd_pcm_access_mask_empty (const snd_pcm_access_mask_t *mask)
 test, if given a snd_pcm_access_mask_t is empty More...
 
void snd_pcm_access_mask_set (snd_pcm_access_mask_t *mask, snd_pcm_access_t val)
 make an access type present in a snd_pcm_access_mask_t More...
 
void snd_pcm_access_mask_reset (snd_pcm_access_mask_t *mask, snd_pcm_access_t val)
 make an access type missing from a snd_pcm_access_mask_t More...
 
size_t snd_pcm_format_mask_sizeof ()
 get size of snd_pcm_format_mask_t More...
 
int snd_pcm_format_mask_malloc (snd_pcm_format_mask_t **ptr)
 allocate an empty snd_pcm_format_mask_t using standard malloc More...
 
void snd_pcm_format_mask_free (snd_pcm_format_mask_t *obj)
 frees a previously allocated snd_pcm_format_mask_t More...
 
void snd_pcm_format_mask_copy (snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src)
 copy one snd_pcm_format_mask_t to another More...
 
void snd_pcm_format_mask_none (snd_pcm_format_mask_t *mask)
 reset all bits in a snd_pcm_format_mask_t More...
 
void snd_pcm_format_mask_any (snd_pcm_format_mask_t *mask)
 set all bits in a snd_pcm_format_mask_t More...
 
int snd_pcm_format_mask_test (const snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 test the presence of a format in a snd_pcm_format_mask_t More...
 
int snd_pcm_format_mask_empty (const snd_pcm_format_mask_t *mask)
 test, if given a snd_pcm_format_mask_t is empty More...
 
void snd_pcm_format_mask_set (snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 make a format present in a snd_pcm_format_mask_t More...
 
void snd_pcm_format_mask_reset (snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 make a format missing from a snd_pcm_format_mask_t More...
 
size_t snd_pcm_subformat_mask_sizeof ()
 get size of snd_pcm_subformat_mask_t More...
 
int snd_pcm_subformat_mask_malloc (snd_pcm_subformat_mask_t **ptr)
 allocate an empty snd_pcm_subformat_mask_t using standard malloc More...
 
void snd_pcm_subformat_mask_free (snd_pcm_subformat_mask_t *obj)
 frees a previously allocated snd_pcm_subformat_mask_t More...
 
void snd_pcm_subformat_mask_copy (snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src)
 copy one snd_pcm_subformat_mask_t to another More...
 
void snd_pcm_subformat_mask_none (snd_pcm_subformat_mask_t *mask)
 reset all bits in a snd_pcm_subformat_mask_t More...
 
void snd_pcm_subformat_mask_any (snd_pcm_subformat_mask_t *mask)
 set all bits in a snd_pcm_subformat_mask_t More...
 
int snd_pcm_subformat_mask_test (const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 test the presence of a subformat in a snd_pcm_subformat_mask_t More...
 
int snd_pcm_subformat_mask_empty (const snd_pcm_subformat_mask_t *mask)
 test, if given a snd_pcm_subformat_mask_t is empty More...
 
void snd_pcm_subformat_mask_set (snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 make a subformat present in a snd_pcm_subformat_mask_t More...
 
void snd_pcm_subformat_mask_reset (snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 make a subformat missing from a snd_pcm_subformat_mask_t More...
 
size_t snd_pcm_hw_params_sizeof ()
 get size of snd_pcm_hw_params_t More...
 
int snd_pcm_hw_params_malloc (snd_pcm_hw_params_t **ptr)
 allocate an invalid snd_pcm_hw_params_t using standard malloc More...
 
void snd_pcm_hw_params_free (snd_pcm_hw_params_t *obj)
 frees a previously allocated snd_pcm_hw_params_t More...
 
void snd_pcm_hw_params_copy (snd_pcm_hw_params_t *dst, const snd_pcm_hw_params_t *src)
 copy one snd_pcm_hw_params_t to another More...
 
int snd_pcm_hw_params_get_access (const snd_pcm_hw_params_t *params, snd_pcm_access_t *access)
 Extract access type from a configuration space. More...
 
int snd_pcm_hw_params_test_access (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t access)
 Verify if an access type is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_access (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t access)
 Restrict a configuration space to contain only one access type. More...
 
int snd_pcm_hw_params_set_access_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *access)
 Restrict a configuration space to contain only its first access type. More...
 
int snd_pcm_hw_params_set_access_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *access)
 Restrict a configuration space to contain only its last access type. More...
 
int snd_pcm_hw_params_set_access_mask (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask)
 Restrict a configuration space to contain only a set of access types. More...
 
int snd_pcm_hw_params_get_access_mask (snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask)
 Get access mask from a configuration space. More...
 
int snd_pcm_hw_params_get_format (const snd_pcm_hw_params_t *params, snd_pcm_format_t *format)
 Extract format from a configuration space. More...
 
int snd_pcm_hw_params_test_format (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t format)
 Verify if a format is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_format (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t format)
 Restrict a configuration space to contain only one format. More...
 
int snd_pcm_hw_params_set_format_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format)
 Restrict a configuration space to contain only its first format. More...
 
int snd_pcm_hw_params_set_format_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format)
 Restrict a configuration space to contain only its last format. More...
 
int snd_pcm_hw_params_set_format_mask (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask)
 Restrict a configuration space to contain only a set of formats. More...
 
void snd_pcm_hw_params_get_format_mask (snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask)
 Get format mask from a configuration space. More...
 
int snd_pcm_hw_params_get_subformat (const snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat)
 Extract subformat from a configuration space. More...
 
int snd_pcm_hw_params_test_subformat (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat)
 Verify if a subformat is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_subformat (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat)
 Restrict a configuration space to contain only one subformat. More...
 
int snd_pcm_hw_params_set_subformat_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat)
 Restrict a configuration space to contain only its first subformat. More...
 
int snd_pcm_hw_params_set_subformat_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat)
 Restrict a configuration space to contain only its last subformat. More...
 
int snd_pcm_hw_params_set_subformat_mask (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask)
 Restrict a configuration space to contain only a set of subformats. More...
 
void snd_pcm_hw_params_get_subformat_mask (snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask)
 Get subformat mask from a configuration space. More...
 
int snd_pcm_hw_params_get_channels (const snd_pcm_hw_params_t *params, unsigned int *val)
 Extract channels from a configuration space. More...
 
int snd_pcm_hw_params_get_channels_min (const snd_pcm_hw_params_t *params, unsigned int *val)
 Extract minimum channels count from a configuration space. More...
 
int snd_pcm_hw_params_get_channels_max (const snd_pcm_hw_params_t *params, unsigned int *val)
 Extract maximum channels count from a configuration space. More...
 
int snd_pcm_hw_params_test_channels (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Verify if a channels count is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_channels (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to contain only one channels count. More...
 
int snd_pcm_hw_params_set_channels_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space with a minimum channels count. More...
 
int snd_pcm_hw_params_set_channels_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space with a maximum channels count. More...
 
int snd_pcm_hw_params_set_channels_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, unsigned int *max)
 Restrict a configuration space to have channels counts in a given range. More...
 
int snd_pcm_hw_params_set_channels_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space to have channels count nearest to a target. More...
 
int snd_pcm_hw_params_set_channels_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space to contain only its minimum channels count. More...
 
int snd_pcm_hw_params_set_channels_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space to contain only its maximum channels count. More...
 
int snd_pcm_hw_params_get_rate (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract rate from a configuration space. More...
 
int snd_pcm_hw_params_get_rate_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum rate from a configuration space. More...
 
int snd_pcm_hw_params_get_rate_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum rate from a configuration space. More...
 
int snd_pcm_hw_params_test_rate (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a rate is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_rate (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one rate. More...
 
int snd_pcm_hw_params_set_rate_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum rate. More...
 
int snd_pcm_hw_params_set_rate_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum rate. More...
 
int snd_pcm_hw_params_set_rate_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir)
 Restrict a configuration space to have rates in a given range. More...
 
int snd_pcm_hw_params_set_rate_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have rate nearest to a target. More...
 
int snd_pcm_hw_params_set_rate_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum rate. More...
 
int snd_pcm_hw_params_set_rate_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum rate. More...
 
int snd_pcm_hw_params_set_rate_resample (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to contain only real hardware rates. More...
 
int snd_pcm_hw_params_get_rate_resample (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Extract resample state from a configuration space. More...
 
int snd_pcm_hw_params_set_export_buffer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to allow the buffer to be accessible from outside. More...
 
int snd_pcm_hw_params_get_export_buffer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Extract buffer accessibility from a configuration space. More...
 
int snd_pcm_hw_params_set_period_wakeup (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to settings without period wakeups. More...
 
int snd_pcm_hw_params_get_period_wakeup (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Extract period wakeup flag from a configuration space. More...
 
int snd_pcm_hw_params_get_period_time (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract period time from a configuration space. More...
 
int snd_pcm_hw_params_get_period_time_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum period time from a configuration space. More...
 
int snd_pcm_hw_params_get_period_time_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum period time from a configuration space. More...
 
int snd_pcm_hw_params_test_period_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a period time is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_period_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one period time. More...
 
int snd_pcm_hw_params_set_period_time_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum period time. More...
 
int snd_pcm_hw_params_set_period_time_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum period time. More...
 
int snd_pcm_hw_params_set_period_time_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir)
 Restrict a configuration space to have period times in a given range. More...
 
int snd_pcm_hw_params_set_period_time_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have period time nearest to a target. More...
 
int snd_pcm_hw_params_set_period_time_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum period time. More...
 
int snd_pcm_hw_params_set_period_time_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum period time. More...
 
int snd_pcm_hw_params_get_period_size (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Extract period size from a configuration space. More...
 
int snd_pcm_hw_params_get_period_size_min (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Extract minimum period size from a configuration space. More...
 
int snd_pcm_hw_params_get_period_size_max (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Extract maximum period size from a configuration space. More...
 
int snd_pcm_hw_params_test_period_size (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val, int dir)
 Verify if a period size is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_period_size (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val, int dir)
 Restrict a configuration space to contain only one period size. More...
 
int snd_pcm_hw_params_set_period_size_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Restrict a configuration space with a minimum period size. More...
 
int snd_pcm_hw_params_set_period_size_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Restrict a configuration space with a maximum period size. More...
 
int snd_pcm_hw_params_set_period_size_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *min, int *mindir, snd_pcm_uframes_t *max, int *maxdir)
 Restrict a configuration space to have period sizes in a given range. More...
 
int snd_pcm_hw_params_set_period_size_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Restrict a configuration space to have period size nearest to a target. More...
 
int snd_pcm_hw_params_set_period_size_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Restrict a configuration space to contain only its minimum period size. More...
 
int snd_pcm_hw_params_set_period_size_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir)
 Restrict a configuration space to contain only its maximum period size. More...
 
int snd_pcm_hw_params_set_period_size_integer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Restrict a configuration space to contain only integer period sizes. More...
 
int snd_pcm_hw_params_get_periods (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract periods from a configuration space. More...
 
int snd_pcm_hw_params_get_periods_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum periods count from a configuration space. More...
 
int snd_pcm_hw_params_get_periods_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum periods count from a configuration space. More...
 
int snd_pcm_hw_params_test_periods (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a periods count is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_periods (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one periods count. More...
 
int snd_pcm_hw_params_set_periods_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum periods count. More...
 
int snd_pcm_hw_params_set_periods_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum periods count. More...
 
int snd_pcm_hw_params_set_periods_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir)
 Restrict a configuration space to have periods counts in a given range. More...
 
int snd_pcm_hw_params_set_periods_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have periods count nearest to a target. More...
 
int snd_pcm_hw_params_set_periods_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum periods count. More...
 
int snd_pcm_hw_params_set_periods_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum periods count. More...
 
int snd_pcm_hw_params_set_periods_integer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Restrict a configuration space to contain only integer periods counts. More...
 
int snd_pcm_hw_params_get_buffer_time (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract buffer time from a configuration space. More...
 
int snd_pcm_hw_params_get_buffer_time_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum buffer time from a configuration space. More...
 
int snd_pcm_hw_params_get_buffer_time_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum buffer time from a configuration space. More...
 
int snd_pcm_hw_params_test_buffer_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a buffer time is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_buffer_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one buffer time. More...
 
int snd_pcm_hw_params_set_buffer_time_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum buffer time. More...
 
int snd_pcm_hw_params_set_buffer_time_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum buffer time. More...
 
int snd_pcm_hw_params_set_buffer_time_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir)
 Restrict a configuration space to have buffer times in a given range. More...
 
int snd_pcm_hw_params_set_buffer_time_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have buffer time nearest to a target. More...
 
int snd_pcm_hw_params_set_buffer_time_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum buffer time. More...
 
int snd_pcm_hw_params_set_buffer_time_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum buffered time. More...
 
int snd_pcm_hw_params_get_buffer_size (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Extract buffer size from a configuration space. More...
 
int snd_pcm_hw_params_get_buffer_size_min (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Extract minimum buffer size from a configuration space. More...
 
int snd_pcm_hw_params_get_buffer_size_max (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Extract maximum buffer size from a configuration space. More...
 
int snd_pcm_hw_params_test_buffer_size (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val)
 Verify if a buffer size is available inside a configuration space for a PCM. More...
 
int snd_pcm_hw_params_set_buffer_size (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val)
 Restrict a configuration space to contain only one buffer size. More...
 
int snd_pcm_hw_params_set_buffer_size_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space with a minimum buffer size. More...
 
int snd_pcm_hw_params_set_buffer_size_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space with a maximum buffer size. More...
 
int snd_pcm_hw_params_set_buffer_size_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *min, snd_pcm_uframes_t *max)
 Restrict a configuration space to have buffer sizes in a given range. More...
 
int snd_pcm_hw_params_set_buffer_size_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space to have buffer size nearest to a target. More...
 
int snd_pcm_hw_params_set_buffer_size_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space to contain only its minimum buffer size. More...
 
int snd_pcm_hw_params_set_buffer_size_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space to contain only its maximum buffer size. More...
 
int snd_pcm_hw_params_get_tick_time (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Extract tick time from a configuration space More...
 
int snd_pcm_hw_params_get_tick_time_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Extract minimum tick time from a configuration space More...
 
int snd_pcm_hw_params_get_tick_time_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Extract maximum tick time from a configuration space More...
 
int snd_pcm_hw_params_test_tick_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 (DEPRECATED) Verify if a tick time is available inside a configuration space for a PCM More...
 
int snd_pcm_hw_params_set_tick_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 (DEPRECATED) Restrict a configuration space to contain only one tick time More...
 
int snd_pcm_hw_params_set_tick_time_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Restrict a configuration space with a minimum tick time More...
 
int snd_pcm_hw_params_set_tick_time_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Restrict a configuration space with a maximum tick time More...
 
int snd_pcm_hw_params_set_tick_time_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir)
 (DEPRECATED) Restrict a configuration space to have tick times in a given range More...
 
int snd_pcm_hw_params_set_tick_time_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Restrict a configuration space to have tick time nearest to a target More...
 
int snd_pcm_hw_params_set_tick_time_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Restrict a configuration space to contain only its minimum tick time More...
 
int snd_pcm_hw_params_set_tick_time_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 (DEPRECATED) Restrict a configuration space to contain only its maximum tick time More...
 
int snd_pcm_hw_params_get_min_align (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Get the minimum transfer align value in samples. More...
 
int snd_pcm_sw_params_current (snd_pcm_t *pcm, snd_pcm_sw_params_t *params)
 Return current software configuration for a PCM. More...
 
int snd_pcm_sw_params_dump (snd_pcm_sw_params_t *params, snd_output_t *out)
 Dump a software configuration. More...
 
size_t snd_pcm_sw_params_sizeof ()
 get size of snd_pcm_sw_params_t More...
 
int snd_pcm_sw_params_malloc (snd_pcm_sw_params_t **ptr)
 allocate an invalid snd_pcm_sw_params_t using standard malloc More...
 
void snd_pcm_sw_params_free (snd_pcm_sw_params_t *obj)
 frees a previously allocated snd_pcm_sw_params_t More...
 
void snd_pcm_sw_params_copy (snd_pcm_sw_params_t *dst, const snd_pcm_sw_params_t *src)
 copy one snd_pcm_sw_params_t to another More...
 
int snd_pcm_sw_params_get_boundary (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get boundary for ring pointers from a software configuration container. More...
 
int snd_pcm_sw_params_set_start_mode (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_start_t val)
 (DEPRECATED) Set start mode inside a software configuration container More...
 
snd_pcm_start_t snd_pcm_sw_params_get_start_mode (const snd_pcm_sw_params_t *params)
 (DEPRECATED) Get start mode from a software configuration container More...
 
int snd_pcm_sw_params_set_xrun_mode (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_xrun_t val)
 (DEPRECATED) Set xrun mode inside a software configuration container More...
 
snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode (const snd_pcm_sw_params_t *params)
 (DEPRECATED) Get xrun mode from a software configuration container More...
 
int snd_pcm_sw_params_set_tstamp_mode (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val)
 Set timestamp mode inside a software configuration container. More...
 
int snd_pcm_sw_params_get_tstamp_mode (const snd_pcm_sw_params_t *params, snd_pcm_tstamp_t *val)
 Get timestamp mode from a software configuration container. More...
 
int snd_pcm_sw_params_set_tstamp_type (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_type_t val)
 Set timestamp type inside a software configuration container. More...
 
int snd_pcm_sw_params_get_tstamp_type (const snd_pcm_sw_params_t *params, snd_pcm_tstamp_type_t *val)
 Get timestamp type from a software configuration container. More...
 
int snd_pcm_sw_params_set_sleep_min (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val)
 (DEPRECATED) Set minimum number of ticks to sleep inside a software configuration container More...
 
int snd_pcm_sw_params_get_sleep_min (const snd_pcm_sw_params_t *params, unsigned int *val)
 (DEPRECATED) Get minimum numbers of ticks to sleep from a software configuration container More...
 
int snd_pcm_sw_params_set_avail_min (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set avail min inside a software configuration container. More...
 
int snd_pcm_sw_params_get_avail_min (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get avail min from a software configuration container. More...
 
int snd_pcm_sw_params_set_period_event (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, int val)
 Set period event inside a software configuration container. More...
 
int snd_pcm_sw_params_get_period_event (const snd_pcm_sw_params_t *params, int *val)
 Get period event from a software configuration container. More...
 
int snd_pcm_sw_params_set_xfer_align (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 (DEPRECATED) Set xfer align inside a software configuration container More...
 
int snd_pcm_sw_params_get_xfer_align (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 (DEPRECATED) Get xfer align from a software configuration container More...
 
int snd_pcm_sw_params_set_start_threshold (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set start threshold inside a software configuration container. More...
 
int snd_pcm_sw_params_get_start_threshold (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get start threshold from a software configuration container. More...
 
int snd_pcm_sw_params_set_stop_threshold (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set stop threshold inside a software configuration container. More...
 
int snd_pcm_sw_params_get_stop_threshold (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get stop threshold from a software configuration container. More...
 
int snd_pcm_sw_params_set_silence_threshold (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set silence threshold inside a software configuration container. More...
 
int snd_pcm_sw_params_get_silence_threshold (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get silence threshold from a software configuration container. More...
 
int snd_pcm_sw_params_set_silence_size (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set silence size inside a software configuration container. More...
 
int snd_pcm_sw_params_get_silence_size (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get silence size from a software configuration container. More...
 
size_t snd_pcm_status_sizeof ()
 get size of snd_pcm_status_t More...
 
int snd_pcm_status_malloc (snd_pcm_status_t **ptr)
 allocate an invalid snd_pcm_status_t using standard malloc More...
 
void snd_pcm_status_free (snd_pcm_status_t *obj)
 frees a previously allocated snd_pcm_status_t More...
 
void snd_pcm_status_copy (snd_pcm_status_t *dst, const snd_pcm_status_t *src)
 copy one snd_pcm_status_t to another More...
 
snd_pcm_state_t snd_pcm_status_get_state (const snd_pcm_status_t *obj)
 Get state from a PCM status container (see snd_pcm_state) More...
 
void snd_pcm_status_get_trigger_tstamp (const snd_pcm_status_t *obj, snd_timestamp_t *ptr)
 Get trigger timestamp from a PCM status container. More...
 
void snd_pcm_status_get_trigger_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
 Get trigger hi-res timestamp from a PCM status container. More...
 
void snd_pcm_status_get_tstamp (const snd_pcm_status_t *obj, snd_timestamp_t *ptr)
 Get "now" timestamp from a PCM status container. More...
 
void snd_pcm_status_get_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
 Get "now" hi-res timestamp from a PCM status container. More...
 
void snd_pcm_status_get_audio_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
 Get "now" hi-res audio timestamp from a PCM status container. More...
 
void snd_pcm_status_get_driver_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
 Get "now" hi-res driver timestamp from a PCM status container. Defines when the status was generated by driver, may differ from normal timestamp. More...
 
void snd_pcm_status_get_audio_htstamp_report (const snd_pcm_status_t *obj, snd_pcm_audio_tstamp_report_t *audio_tstamp_report)
 Get audio_tstamp_report from a PCM status container. More...
 
void snd_pcm_status_set_audio_htstamp_config (snd_pcm_status_t *obj, snd_pcm_audio_tstamp_config_t *audio_tstamp_config)
 set audio_tstamp_config from a PCM status container More...
 
snd_pcm_sframes_t snd_pcm_status_get_delay (const snd_pcm_status_t *obj)
 Get delay from a PCM status container (see snd_pcm_delay) More...
 
snd_pcm_uframes_t snd_pcm_status_get_avail (const snd_pcm_status_t *obj)
 Get number of frames available from a PCM status container (see snd_pcm_avail_update) More...
 
snd_pcm_uframes_t snd_pcm_status_get_avail_max (const snd_pcm_status_t *obj)
 Get maximum number of frames available from a PCM status container after last snd_pcm_status call. More...
 
snd_pcm_uframes_t snd_pcm_status_get_overrange (const snd_pcm_status_t *obj)
 Get count of ADC overrange detections since last call. More...
 
size_t snd_pcm_info_sizeof ()
 get size of snd_pcm_info_t More...
 
int snd_pcm_info_malloc (snd_pcm_info_t **ptr)
 allocate an invalid snd_pcm_info_t using standard malloc More...
 
void snd_pcm_info_free (snd_pcm_info_t *obj)
 frees a previously allocated snd_pcm_info_t More...
 
void snd_pcm_info_copy (snd_pcm_info_t *dst, const snd_pcm_info_t *src)
 copy one snd_pcm_info_t to another More...
 
unsigned int snd_pcm_info_get_device (const snd_pcm_info_t *obj)
 Get device from a PCM info container. More...
 
unsigned int snd_pcm_info_get_subdevice (const snd_pcm_info_t *obj)
 Get subdevice from a PCM info container. More...
 
snd_pcm_stream_t snd_pcm_info_get_stream (const snd_pcm_info_t *obj)
 Get stream (direction) from a PCM info container. More...
 
int snd_pcm_info_get_card (const snd_pcm_info_t *obj)
 Get card from a PCM info container. More...
 
const char * snd_pcm_info_get_id (const snd_pcm_info_t *obj)
 Get id from a PCM info container. More...
 
const char * snd_pcm_info_get_name (const snd_pcm_info_t *obj)
 Get name from a PCM info container. More...
 
const char * snd_pcm_info_get_subdevice_name (const snd_pcm_info_t *obj)
 Get subdevice name from a PCM info container. More...
 
snd_pcm_class_t snd_pcm_info_get_class (const snd_pcm_info_t *obj)
 Get class from a PCM info container. More...
 
snd_pcm_subclass_t snd_pcm_info_get_subclass (const snd_pcm_info_t *obj)
 Get subclass from a PCM info container. More...
 
unsigned int snd_pcm_info_get_subdevices_count (const snd_pcm_info_t *obj)
 Get subdevices count from a PCM info container. More...
 
unsigned int snd_pcm_info_get_subdevices_avail (const snd_pcm_info_t *obj)
 Get available subdevices count from a PCM info container. More...
 
snd_pcm_sync_id_t snd_pcm_info_get_sync (const snd_pcm_info_t *obj)
 Get hardware synchronization ID from a PCM info container. More...
 
void snd_pcm_info_set_device (snd_pcm_info_t *obj, unsigned int val)
 Set wanted device inside a PCM info container (see snd_ctl_pcm_info) More...
 
void snd_pcm_info_set_subdevice (snd_pcm_info_t *obj, unsigned int val)
 Set wanted subdevice inside a PCM info container (see snd_ctl_pcm_info) More...
 
void snd_pcm_info_set_stream (snd_pcm_info_t *obj, snd_pcm_stream_t val)
 Set wanted stream inside a PCM info container (see snd_ctl_pcm_info) More...
 
int snd_pcm_mmap_begin (snd_pcm_t *pcm, const snd_pcm_channel_area_t **areas, snd_pcm_uframes_t *offset, snd_pcm_uframes_t *frames)
 Application request to access a portion of direct (mmap) area. More...
 
snd_pcm_sframes_t snd_pcm_mmap_commit (snd_pcm_t *pcm, snd_pcm_uframes_t offset, snd_pcm_uframes_t frames)
 Application has completed the access to area requested with snd_pcm_mmap_begin. More...
 
snd_pcm_chmap_query_t ** snd_pcm_query_chmaps (snd_pcm_t *pcm)
 
void snd_pcm_free_chmaps (snd_pcm_chmap_query_t **maps)
 
snd_pcm_chmap_tsnd_pcm_get_chmap (snd_pcm_t *pcm)
 
int snd_pcm_set_chmap (snd_pcm_t *pcm, const snd_pcm_chmap_t *map)
 
const char * snd_pcm_chmap_type_name (enum snd_pcm_chmap_type val)
 
const char * snd_pcm_chmap_name (enum snd_pcm_chmap_position val)
 
const char * snd_pcm_chmap_long_name (enum snd_pcm_chmap_position val)
 
int snd_pcm_chmap_print (const snd_pcm_chmap_t *map, size_t maxlen, char *buf)
 
unsigned int snd_pcm_chmap_from_string (const char *str)
 
snd_pcm_chmap_tsnd_pcm_chmap_parse_string (const char *str)
 
int snd_pcm_recover (snd_pcm_t *pcm, int err, int silent)
 Recover the stream state from an error or suspend. More...
 
int snd_pcm_set_params (snd_pcm_t *pcm, snd_pcm_format_t format, snd_pcm_access_t access, unsigned int channels, unsigned int rate, int soft_resample, unsigned int latency)
 Set the hardware and software parameters in a simple way. More...
 
int snd_pcm_get_params (snd_pcm_t *pcm, snd_pcm_uframes_t *buffer_size, snd_pcm_uframes_t *period_size)
 Get the transfer size parameters in a simple way. More...
 

Detailed Description

PCM Interface.

Author
Jaroslav Kysela perex.nosp@m.@per.nosp@m.ex.cz
Abramo Bagnara abram.nosp@m.o@al.nosp@m.sa-pr.nosp@m.ojec.nosp@m.t.org
Date
2000-2001

PCM Interface is designed to write or read digital audio frames. A frame is the data unit converted into/from sound in one time unit (1/rate seconds), by example if you set your playback PCM rate to 44100 you'll hear 44100 frames per second. The size in bytes of a frame may be obtained from bits needed to store a sample and channels count.

See the PCM (digital audio) interface page for more details.

Function Documentation

◆ snd_pcm_tstamp_type_name()

const char * snd_pcm_tstamp_type_name ( snd_pcm_tstamp_type_t  type)

get name of PCM tstamp type setting

Parameters
modePCM tstamp type
Returns
ascii name of PCM tstamp type setting