Caution: This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

snd_pcm_plugin_setup()

Get the current configuration for the specified PCM channel (plugin aware)

Synopsis:

#include <sys/asoundlib.h>

int snd_pcm_plugin_setup(
       snd_pcm_t *handle,
       snd_pcm_channel_setup_t *setup );

Arguments:

handle
The handle for the PCM device, which you must have opened by calling snd_pcm_open() or snd_pcm_open_preferred().
setup
A pointer to a snd_pcm_channel_setup_t structure that snd_pcm_plugin_setup() fills with information about the current configuration of the PCM channel.

Set the setup structure's channel member to specify the direction. All other members are read-only.

Library:

libasound.so

Description:

The snd_pcm_plugin_setup() function fills the setup structure with information about the current configuration of the PCM channel selected by handle.

Returns:

Zero on success, or a negative error code.

Errors:

-EINVAL
Invalid handle; data pointer is NULL; setup->mode isn't SND_PCM_MODE_BLOCK.

Examples:

See the wave.c example in the appendix.

Classification:

QNX Neutrino

Safety:
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Yes

Caveats:

This function is the plugin-aware version of snd_pcm_channel_setup(). 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_params(), snd_pcm_channel_setup(), snd_pcm_channel_setup_t, snd_mixer_gid_t, snd_pcm_open(), snd_pcm_open_preferred()