snd_pcm_capture_pause()

Pause a channel that's capturing

Synopsis:

#include <sys/asoundlib.h>

int snd_pcm_capture_pause ( snd_pcm_t *pcm );

Arguments:

pcm
The handle for the PCM device, which you must have opened by calling snd_pcm_open_name(), snd_pcm_open(), or snd_pcm_open_preferred().

Library:

libasound.so

Use the -l asound option to qcc to link against this library.

Description:

The snd_pcm_capture_pause() function pauses a channel that's capturing. Unlike draining or flushing, this preserves all data that has not yet been received within the audio driver, to be retrieved after resuming.

Returns:

EOK on success, a negative errno upon failure. The errno values are available in the errno.h file.

Errors:

Additional information for common error values:
-EINVAL
The state of handle is invalid, and invalid channel was provided isn't capturing, or an invalid state change occurred. You can call snd_pcm_channel_status() to check if the state change was invalid.

Classification:

QNX Neutrino

Safety:  
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Read the Caveats

Caveats:

This function is not thread safe if pcm (snd_pcm_t) is used across multiple threads.