ALSA project - the C library reference
Macros | Functions
Subformat Mask Functions
Collaboration diagram for Subformat Mask Functions:

Macros

#define snd_pcm_subformat_mask_alloca(ptr)
 allocate an empty snd_pcm_subformat_mask_t using standard alloca More...
 

Functions

size_t snd_pcm_subformat_mask_sizeof (void)
 get size of snd_pcm_subformat_mask_t More...
 
int snd_pcm_subformat_mask_malloc (snd_pcm_subformat_mask_t **ptr)
 allocate an empty snd_pcm_subformat_mask_t using standard malloc More...
 
void snd_pcm_subformat_mask_free (snd_pcm_subformat_mask_t *obj)
 frees a previously allocated snd_pcm_subformat_mask_t More...
 
void snd_pcm_subformat_mask_copy (snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src)
 copy one snd_pcm_subformat_mask_t to another More...
 
void snd_pcm_subformat_mask_none (snd_pcm_subformat_mask_t *mask)
 reset all bits in a snd_pcm_subformat_mask_t More...
 
void snd_pcm_subformat_mask_any (snd_pcm_subformat_mask_t *mask)
 set all bits in a snd_pcm_subformat_mask_t More...
 
int snd_pcm_subformat_mask_test (const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 test the presence of a subformat in a snd_pcm_subformat_mask_t More...
 
int snd_pcm_subformat_mask_empty (const snd_pcm_subformat_mask_t *mask)
 test, if given a snd_pcm_subformat_mask_t is empty More...
 
void snd_pcm_subformat_mask_set (snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 make a subformat present in a snd_pcm_subformat_mask_t More...
 
void snd_pcm_subformat_mask_reset (snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 make a subformat missing from a snd_pcm_subformat_mask_t More...
 

Detailed Description

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

Macro Definition Documentation

◆ snd_pcm_subformat_mask_alloca

#define snd_pcm_subformat_mask_alloca (   ptr)

allocate an empty snd_pcm_subformat_mask_t using standard alloca

Parameters
ptrreturned pointer

Function Documentation

◆ snd_pcm_subformat_mask_any()

void snd_pcm_subformat_mask_any ( snd_pcm_subformat_mask_t mask)

set all bits in a snd_pcm_subformat_mask_t

Parameters
maskpointer to mask

◆ snd_pcm_subformat_mask_copy()

void snd_pcm_subformat_mask_copy ( snd_pcm_subformat_mask_t dst,
const snd_pcm_subformat_mask_t src 
)

copy one snd_pcm_subformat_mask_t to another

Parameters
dstpointer to destination
srcpointer to source

◆ snd_pcm_subformat_mask_empty()

int snd_pcm_subformat_mask_empty ( const snd_pcm_subformat_mask_t mask)

test, if given a snd_pcm_subformat_mask_t is empty

Parameters
maskpointer to mask
Return values
0not empty
1empty

◆ snd_pcm_subformat_mask_free()

void snd_pcm_subformat_mask_free ( snd_pcm_subformat_mask_t obj)

frees a previously allocated snd_pcm_subformat_mask_t

Parameters
objpointer to object to free

◆ snd_pcm_subformat_mask_malloc()

int snd_pcm_subformat_mask_malloc ( snd_pcm_subformat_mask_t **  ptr)

allocate an empty snd_pcm_subformat_mask_t using standard malloc

Parameters
ptrreturned pointer
Returns
0 on success otherwise negative error code

◆ snd_pcm_subformat_mask_none()

void snd_pcm_subformat_mask_none ( snd_pcm_subformat_mask_t mask)

reset all bits in a snd_pcm_subformat_mask_t

Parameters
maskpointer to mask

◆ snd_pcm_subformat_mask_reset()

void snd_pcm_subformat_mask_reset ( snd_pcm_subformat_mask_t mask,
snd_pcm_subformat_t  val 
)

make a subformat missing from a snd_pcm_subformat_mask_t

Parameters
maskpointer to mask
valsubformat

◆ snd_pcm_subformat_mask_set()

void snd_pcm_subformat_mask_set ( snd_pcm_subformat_mask_t mask,
snd_pcm_subformat_t  val 
)

make a subformat present in a snd_pcm_subformat_mask_t

Parameters
maskpointer to mask
valsubformat

◆ snd_pcm_subformat_mask_sizeof()

size_t snd_pcm_subformat_mask_sizeof ( void  )

get size of snd_pcm_subformat_mask_t

Returns
size in bytes

◆ snd_pcm_subformat_mask_test()

int snd_pcm_subformat_mask_test ( const snd_pcm_subformat_mask_t mask,
snd_pcm_subformat_t  val 
)

test the presence of a subformat in a snd_pcm_subformat_mask_t

Parameters
maskpointer to mask
valsubformat