mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-10-29 05:40:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added more stop threshold comments

Browse source
This commit is contained in:
Jaroslav Kysela 2003-12-29 09:10:48 +00:00
parent d0facfde2b
commit 56c0ba4371
1 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/pcm/pcm.c
View file

@ -5270,7 +5270,9 @@ int snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_t *params, snd
* \return 0 otherwise a negative error code * \return 0 otherwise a negative error code
* *
* PCM is automatically stopped in #SND_PCM_STATE_XRUN state when available * PCM is automatically stopped in #SND_PCM_STATE_XRUN state when available
* frames is >= threshold * frames is >= threshold. If the stop threshold is equal to boundary (also
* software parameter - sw_param) then automatic stop will be disabled
* (thus device will do the endless loop in the ring buffer).
*/ */
#ifndef DOXYGEN #ifndef DOXYGEN
int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val) int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
@ -5290,7 +5292,9 @@ int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *pa
* \return 0 otherwise a negative error code * \return 0 otherwise a negative error code
* *
* PCM is automatically stopped in #SND_PCM_STATE_XRUN state when available * PCM is automatically stopped in #SND_PCM_STATE_XRUN state when available
* frames is >= threshold * frames is >= threshold. If the stop threshold is equal to boundary (also
* software parameter - sw_param) then automatic stop will be disabled
* (thus device will do the endless loop in the ring buffer).
*/ */
#ifndef DOXYGEN #ifndef DOXYGEN
int INTERNAL(snd_pcm_sw_params_get_stop_threshold)(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) int INTERNAL(snd_pcm_sw_params_get_stop_threshold)(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
@ -5313,7 +5317,7 @@ int snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t *params, snd_
* *
* A portion of playback buffer is overwritten with silence (see * A portion of playback buffer is overwritten with silence (see
* #snd_pcm_sw_params_set_silence_size) when playback underrun is nearer * #snd_pcm_sw_params_set_silence_size) when playback underrun is nearer
* than silence threshold * than silence threshold.
*/ */
#ifndef DOXYGEN #ifndef DOXYGEN
int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val) int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
@ -5334,8 +5338,8 @@ int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t
* \return 0 otherwise a negative error value * \return 0 otherwise a negative error value
* *
* A portion of playback buffer is overwritten with silence (see * A portion of playback buffer is overwritten with silence (see
* #snd_pcm_sw_params_get_silence_size) when playback underrun is nearer * #snd_pcm_sw_params_set_silence_size) when playback underrun is nearer
* than silence threshold * than silence threshold.
*/ */
#ifndef DOXYGEN #ifndef DOXYGEN
int INTERNAL(snd_pcm_sw_params_get_silence_threshold)(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) int INTERNAL(snd_pcm_sw_params_get_silence_threshold)(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)