Status Functions
[PCM Interface]

Defines
#define	snd_pcm_status_alloca(ptr)
	allocate an invalid snd_pcm_status_t using standard alloca
Functions
size_t	snd_pcm_status_sizeof (void)
int	snd_pcm_status_malloc (snd_pcm_status_t **ptr)
void	snd_pcm_status_free (snd_pcm_status_t *obj)
void	snd_pcm_status_copy (snd_pcm_status_t *dst, const snd_pcm_status_t *src)
snd_pcm_state_t	snd_pcm_status_get_state (const snd_pcm_status_t *obj)
void	snd_pcm_status_get_trigger_tstamp (const snd_pcm_status_t *obj, snd_timestamp_t *ptr)
void	snd_pcm_status_get_trigger_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
void	snd_pcm_status_get_tstamp (const snd_pcm_status_t *obj, snd_timestamp_t *ptr)
	Get "now" timestamp from a PCM status container.
void	snd_pcm_status_get_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
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).
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).
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.
snd_pcm_uframes_t	snd_pcm_status_get_overrange (const snd_pcm_status_t *obj)
	Get count of ADC overrange detections since last call.

---

Detailed Description

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

---

Define Documentation

#define snd_pcm_status_alloca (  ptr   )

allocate an invalid snd_pcm_status_t using standard alloca Parameters: ptr  returned pointer Examples: /test/latency.c.

---

Function Documentation

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). Returns: Number of frames ready to be read/written

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. Returns: Maximum number of frames ready to be read/written

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). Returns: Delay in frames Delay is distance between current application frame position and sound frame position. It's positive and less than buffer size in normal situation, negative on playback underrun and greater than buffer size on capture overrun.

snd_pcm_uframes_t snd_pcm_status_get_overrange (  const snd_pcm_status_t *  obj  )

Get count of ADC overrange detections since last call. Returns: Count of ADC overrange detections

void snd_pcm_status_get_tstamp (  const snd_pcm_status_t *  obj, snd_timestamp_t *  ptr )

Get "now" timestamp from a PCM status container. Parameters: obj  snd_pcm_status_t pointer ptr  Pointer to returned timestamp

---