snd_pcm_plugin_status()

Get the runtime status of a PCM channel (plugin aware)

Synopsis:

#include <sys/asoundlib.h>

int snd_pcm_plugin_status( 
       snd_pcm_t *handle, 
       snd_pcm_channel_status_t *status );

Arguments:

handle

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

status

A pointer to a snd_pcm_channel_status_t structure that snd_pcm_plugin_status() fills with information about the PCM channel's status.

Fill in the status structure's channel member to specify the direction. All other members are read-only.

Library:

libasound.so

Description:

The snd_pcm_plugin_status() function fills the status structure with runtime status information about the PCM channel selected by handle.

Returns:

Zero on success, or a negative error code.

Errors:

-EBADFD

The pcm device state isn't ready.

-EFAULT

Failed to copy data.

-EINVAL

Invalid handle or the data pointer is NULL.

Examples:

See the wave.c example in the appendix.

Classification:

QNX Neutrino

Caveats:

This function is the plugin-aware version of snd_pcm_channel_status(). It functions exactly the same way. However, make sure that you don't mix and match plugin- and nonplugin-aware functions in your application, or you may get undefined behavior and misleading results.

See also:

snd_pcm_channel_status(), snd_pcm_channel_status_t, snd_pcm_open(), snd_pcm_open_preferred()