snd_afm_get_audio

Get the currently applied audio mode

Synopsis:

#include <sys/asoundlib.h>

int snd_afm_get_audio_mode( snd_afm_t *handle,
                            char *mode,
                            int size );

Arguments:

handle: The handle for the AFM device, which you must have opened by calling snd_afm_open_name() or snd_afm_open().
mode: A buffer where the function can store the mode.
size: The size of the mode buffer, in bytes.

Library:

libasound

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

Description:

Note: This function can only be used if you have QNX Acoustic Management Platform 3.0 installed.

The snd_afm_get_audio_mode() function gets the currently applied audio mode that's used to tune acoustic processing parameters.

Returns:

EOK on success, or a negative errno value upon failure.

This function can also return the return values of devctl() (see devctl() in the QNX Neutrino C Library Reference).

Errors:

-EINVAL: The value of handle or mode is NULL.
-ENOMEM: The mode buffer isn't big enough to hold the mode.

Classification:

QNX Neutrino

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

Caveats:

This function is not thread safe if the handle (snd_afm_t) is used across multiple threads.