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

snd_pcm_get_format_name()

Convert a format value into a human-readable text string

Synopsis:

#include <sys/asoundlib.h>

const char *snd_pcm_get_format_name( int format );

Arguments:

format: The format number (one of the SND_PCM_SFMT_* constants).

Library:

libasound.so

Description:

The snd_pcm_get_format_name() function converts a format member or manifest of the form SND_PCM_SFMT_* to a text string suitable for displaying to a human user:

SND_PCM_SFMT_U8: Unsigned 8-bit
SND_PCM_SFMT_S8: Signed 8-bit
SND_PCM_SFMT_U16_LE: Unsigned 16-bit Little Endian
SND_PCM_SFMT_U16_BE: Unsigned 16-bit Big Endian
SND_PCM_SFMT_S16_LE: Signed 16-bit Little Endian
SND_PCM_SFMT_S16_BE: Signed 16-bit Big Endian
SND_PCM_SFMT_U24_LE: Unsigned 24-bit Little Endian
SND_PCM_SFMT_U24_BE: Unsigned 24-bit Big Endian
SND_PCM_SFMT_S24_LE: Signed 24-bit Little Endian
SND_PCM_SFMT_S24_BE: Signed 24-bit Big Endian
SND_PCM_SFMT_U32_LE: Unsigned 32-bit Little Endian
SND_PCM_SFMT_U32_BE: Unsigned 32-bit Big Endian
SND_PCM_SFMT_S32_LE: Signed 32-bit Little Endian
SND_PCM_SFMT_S32_BE: Signed 32-bit Big Endian
SND_PCM_SFMT_A_LAW: A-Law
SND_PCM_SFMT_MU_LAW: Mu-Law
SND_PCM_SFMT_FLOAT_LE: Float Little Endian
SND_PCM_SFMT_FLOAT_BE: Float Big Endian
SND_PCM_SFMT_FLOAT64_LE: Float64 Little Endian
SND_PCM_SFMT_FLOAT64_BE: Float64 Big Endian
SND_PCM_SFMT_IEC958_SUBFRAME_LE: IEC-958 Little Endian
SND_PCM_SFMT_IEC958_SUBFRAME_BE: IEC-958 Big Endian
SND_PCM_SFMT_IMA_ADPCM: Ima-ADPCM
SND_PCM_SFMT_GSM: GSM
SND_PCM_SFMT_MPEG: MPEG
SND_PCM_SFMT_SPECIAL: Special

Returns:

A character pointer to the text format name.

Don't modify the strings that this function returns.

Classification:

QNX Neutrino

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