Stream Information

Overview

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

// global functions

size_t
snd_pcm_info_sizeof(void);

int
snd_pcm_info_malloc(snd_pcm_info_t** ptr);

void
snd_pcm_info_free(snd_pcm_info_t* obj);

void
snd_pcm_info_copy(
    snd_pcm_info_t* dst,
    const snd_pcm_info_t* src
);

unsigned int
snd_pcm_info_get_device(const snd_pcm_info_t* obj);

unsigned int
snd_pcm_info_get_subdevice(const snd_pcm_info_t* obj);

snd_pcm_stream_t
snd_pcm_info_get_stream(const snd_pcm_info_t* obj);

int
snd_pcm_info_get_card(const snd_pcm_info_t* obj);

const char*
snd_pcm_info_get_id(const snd_pcm_info_t* obj);

const char*
snd_pcm_info_get_name(const snd_pcm_info_t* obj);

const char*
snd_pcm_info_get_subdevice_name(const snd_pcm_info_t* obj);

snd_pcm_class_t
snd_pcm_info_get_class(const snd_pcm_info_t* obj);

snd_pcm_subclass_t
snd_pcm_info_get_subclass(const snd_pcm_info_t* obj);

unsigned int
snd_pcm_info_get_subdevices_count(const snd_pcm_info_t* obj);

unsigned int
snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t* obj);

snd_pcm_sync_id_t
snd_pcm_info_get_sync(const snd_pcm_info_t* obj);

void
snd_pcm_info_set_device(
    snd_pcm_info_t* obj,
    unsigned int val
);

void
snd_pcm_info_set_subdevice(
    snd_pcm_info_t* obj,
    unsigned int val
);

void
snd_pcm_info_set_stream(
    snd_pcm_info_t* obj,
    snd_pcm_stream_t val
);

// macros

#define snd_pcm_info_alloca(ptr)

Detailed Documentation

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

Global Functions

size_t
snd_pcm_info_sizeof(void)

get size of snd_pcm_info_t

Returns:

size in bytes

int
snd_pcm_info_malloc(snd_pcm_info_t** ptr)

allocate an invalid snd_pcm_info_t using standard malloc

Parameters:

ptr	returned pointer

Returns:

0 on success otherwise negative error code

void
snd_pcm_info_free(snd_pcm_info_t* obj)

frees a previously allocated snd_pcm_info_t

Parameters:

obj	pointer to object to free

void
snd_pcm_info_copy(
    snd_pcm_info_t* dst,
    const snd_pcm_info_t* src
)

copy one snd_pcm_info_t to another

Parameters:

dst	pointer to destination
src	pointer to source

unsigned int
snd_pcm_info_get_device(const snd_pcm_info_t* obj)

Get device from a PCM info container.

Parameters:

obj	PCM info container

Returns:

device number

unsigned int
snd_pcm_info_get_subdevice(const snd_pcm_info_t* obj)

Get subdevice from a PCM info container.

Parameters:

obj	PCM info container

Returns:

subdevice number

snd_pcm_stream_t
snd_pcm_info_get_stream(const snd_pcm_info_t* obj)

Get stream (direction) from a PCM info container.

Parameters:

obj	PCM info container

Returns:

stream

int
snd_pcm_info_get_card(const snd_pcm_info_t* obj)

Get card from a PCM info container.

Parameters:

obj	PCM info container

Returns:

card number otherwise a negative error code if not associable to a card

const char*
snd_pcm_info_get_id(const snd_pcm_info_t* obj)

Get id from a PCM info container.

Parameters:

obj	PCM info container

Returns:

short id of PCM

const char*
snd_pcm_info_get_name(const snd_pcm_info_t* obj)

Get name from a PCM info container.

Parameters:

obj	PCM info container

Returns:

name of PCM

const char*
snd_pcm_info_get_subdevice_name(const snd_pcm_info_t* obj)

Get subdevice name from a PCM info container.

Parameters:

obj	PCM info container

Returns:

name of used PCM subdevice

snd_pcm_class_t
snd_pcm_info_get_class(const snd_pcm_info_t* obj)

Get class from a PCM info container.

Parameters:

obj	PCM info container

Returns:

class of PCM

snd_pcm_subclass_t
snd_pcm_info_get_subclass(const snd_pcm_info_t* obj)

Get subclass from a PCM info container.

Parameters:

obj	PCM info container

Returns:

subclass of PCM

unsigned int
snd_pcm_info_get_subdevices_count(const snd_pcm_info_t* obj)

Get subdevices count from a PCM info container.

Parameters:

obj	PCM info container

Returns:

subdevices total count of PCM

unsigned int
snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t* obj)

Get available subdevices count from a PCM info container.

Parameters:

obj	PCM info container

Returns:

available subdevices count of PCM

snd_pcm_sync_id_t
snd_pcm_info_get_sync(const snd_pcm_info_t* obj)

Get hardware synchronization ID from a PCM info container.

Parameters:

obj	PCM info container

Returns:

hardware synchronization ID

void
snd_pcm_info_set_device(
    snd_pcm_info_t* obj,
    unsigned int val
)

Set wanted device inside a PCM info container (see snd_ctl_pcm_info)

Parameters:

obj	PCM info container
val	Device number

void
snd_pcm_info_set_subdevice(
    snd_pcm_info_t* obj,
    unsigned int val
)

Set wanted subdevice inside a PCM info container (see snd_ctl_pcm_info)

Parameters:

obj	PCM info container
val	Subdevice number

void
snd_pcm_info_set_stream(
    snd_pcm_info_t* obj,
    snd_pcm_stream_t val
)

Set wanted stream inside a PCM info container (see snd_ctl_pcm_info)

Parameters:

obj	PCM info container
val	Stream

Macros

#define snd_pcm_info_alloca(ptr)

allocate an invalid snd_pcm_info_t using standard alloca

Parameters:

ptr	returned pointer