snd_pcm_playback_pause()

Pause a channel that's playing back

Synopsis:

#include <sys/asoundlib.h>

int snd_pcm_playback_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_playback_pause() function pauses a channel that's playing back. Unlike draining or flushing, this preserves all data that has not yet played out within the audio driver, to be played out 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 or an invalid state change occurred. The other reason this value is returned is because the specified channel isn't being played.
-EIO
The channel isn't valid that was passed in was not set to SND_PCM_CHANNEL_PLAYBACK or SND_PCM_CHANNEL_CAPTURE.
-ENOTSUP
Pause isn't supported on the PCM device that's referenced by the PCM handle (pcm).

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 handle (snd_pcm_t) is used across multiple threads.