Simple setup functions

Overview

See the PCM (digital audio) interface page for more details. More…

// enums

enum snd_spcm_duplex_type_t;
enum snd_spcm_latency_t;
enum snd_spcm_xrun_type_t;

// global functions

int
snd_spcm_init(
    snd_pcm_t* pcm,
    unsigned int rate,
    unsigned int channels,
    snd_pcm_format_t format,
    snd_pcm_subformat_t subformat,
    snd_spcm_latency_t latency,
    snd_pcm_access_t _access,
    snd_spcm_xrun_type_t xrun_type
);

int
snd_spcm_init_duplex(
    snd_pcm_t* playback_pcm,
    snd_pcm_t* capture_pcm,
    unsigned int rate,
    unsigned int channels,
    snd_pcm_format_t format,
    snd_pcm_subformat_t subformat,
    snd_spcm_latency_t latency,
    snd_pcm_access_t _access,
    snd_spcm_xrun_type_t xrun_type,
    snd_spcm_duplex_type_t duplex_type
);

int
snd_spcm_init_get_params(
    snd_pcm_t* pcm,
    unsigned int* rate,
    snd_pcm_uframes_t* buffer_size,
    snd_pcm_uframes_t* period_size
);

Detailed Documentation

See the PCM (digital audio) interface page for more details.

Global Functions

int
snd_spcm_init(
    snd_pcm_t* pcm,
    unsigned int rate,
    unsigned int channels,
    snd_pcm_format_t format,
    snd_pcm_subformat_t subformat,
    snd_spcm_latency_t latency,
    snd_pcm_access_t _access,
    snd_spcm_xrun_type_t xrun_type
)

Set up a simple PCM.

Warning

The simple PCM API may be broken in the current release.

Parameters:

pcm	PCM handle
rate	Sample rate
channels	Number of channels
format	PCM format
subformat	PCM subformat
latency	Latency type
access	PCM acceess type
xrun_type	XRUN type

Returns:

0 if successful, or a negative error code

int
snd_spcm_init_duplex(
    snd_pcm_t* playback_pcm,
    snd_pcm_t* capture_pcm,
    unsigned int rate,
    unsigned int channels,
    snd_pcm_format_t format,
    snd_pcm_subformat_t subformat,
    snd_spcm_latency_t latency,
    snd_pcm_access_t _access,
    snd_spcm_xrun_type_t xrun_type,
    snd_spcm_duplex_type_t duplex_type
)

Initialize simple PCMs in the duplex mode.

Warning

The simple PCM API may be broken in the current release.

Parameters:

playback_pcm	PCM handle for playback
capture_pcm	PCM handle for capture
rate	Sample rate
channels	Number of channels
format	PCM format
subformat	PCM subformat
latency	Latency type
access	PCM acceess type
xrun_type	XRUN type
duplex_type	Duplex mode

Returns:

0 if successful, or a negative error code

int
snd_spcm_init_get_params(
    snd_pcm_t* pcm,
    unsigned int* rate,
    snd_pcm_uframes_t* buffer_size,
    snd_pcm_uframes_t* period_size
)

Get the set up of simple PCM.

Warning

The simple PCM API may be broken in the current release.

Parameters:

pcm	PCM handle
rate	Pointer to store the current sample rate
buffer_size	Pointer to store the current buffer size
period_size	Pointer to store the current period size

Returns:

0 if successful, or a negative error code