ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Functions
Format Mask Functions
PCM Interface

Macros

#define snd_pcm_format_mask_alloca(ptr)
 allocate an empty snd_pcm_format_mask_t using standard alloca

Functions

size_t snd_pcm_format_mask_sizeof (void)
 get size of snd_pcm_format_mask_t
int snd_pcm_format_mask_malloc (snd_pcm_format_mask_t **ptr)
 allocate an empty snd_pcm_format_mask_t using standard malloc
void snd_pcm_format_mask_free (snd_pcm_format_mask_t *obj)
 frees a previously allocated snd_pcm_format_mask_t
void snd_pcm_format_mask_copy (snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src)
 copy one snd_pcm_format_mask_t to another
void snd_pcm_format_mask_none (snd_pcm_format_mask_t *mask)
 reset all bits in a snd_pcm_format_mask_t
void snd_pcm_format_mask_any (snd_pcm_format_mask_t *mask)
 set all bits in a snd_pcm_format_mask_t
int snd_pcm_format_mask_test (const snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 test the presence of a format in a snd_pcm_format_mask_t
int snd_pcm_format_mask_empty (const snd_pcm_format_mask_t *mask)
 test, if given a snd_pcm_format_mask_t is empty
void snd_pcm_format_mask_set (snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 make a format present in a snd_pcm_format_mask_t
void snd_pcm_format_mask_reset (snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 make a format missing from a snd_pcm_format_mask_t

Detailed Description

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


Macro Definition Documentation

#define snd_pcm_format_mask_alloca (   ptr)

allocate an empty snd_pcm_format_mask_t using standard alloca

Parameters:
ptrreturned pointer

Function Documentation

void snd_pcm_format_mask_any ( snd_pcm_format_mask_t mask)

set all bits in a snd_pcm_format_mask_t

Parameters:
maskpointer to mask
void snd_pcm_format_mask_copy ( snd_pcm_format_mask_t dst,
const snd_pcm_format_mask_t src 
)

copy one snd_pcm_format_mask_t to another

Parameters:
dstpointer to destination
srcpointer to source
int snd_pcm_format_mask_empty ( const snd_pcm_format_mask_t mask)

test, if given a snd_pcm_format_mask_t is empty

Parameters:
maskpointer to mask
Return values:
0not empty
1empty
void snd_pcm_format_mask_free ( snd_pcm_format_mask_t obj)

frees a previously allocated snd_pcm_format_mask_t

Parameters:
objpointer to object to free
int snd_pcm_format_mask_malloc ( snd_pcm_format_mask_t **  ptr)

allocate an empty snd_pcm_format_mask_t using standard malloc

Parameters:
ptrreturned pointer
Returns:
0 on success otherwise negative error code
void snd_pcm_format_mask_none ( snd_pcm_format_mask_t mask)

reset all bits in a snd_pcm_format_mask_t

Parameters:
maskpointer to mask
void snd_pcm_format_mask_reset ( snd_pcm_format_mask_t mask,
snd_pcm_format_t  val 
)

make a format missing from a snd_pcm_format_mask_t

Parameters:
maskpointer to mask
valformat
void snd_pcm_format_mask_set ( snd_pcm_format_mask_t mask,
snd_pcm_format_t  val 
)

make a format present in a snd_pcm_format_mask_t

Parameters:
maskpointer to mask
valformat
size_t snd_pcm_format_mask_sizeof ( void  )

get size of snd_pcm_format_mask_t

Returns:
size in bytes
int snd_pcm_format_mask_test ( const snd_pcm_format_mask_t mask,
snd_pcm_format_t  val 
)

test the presence of a format in a snd_pcm_format_mask_t

Parameters:
maskpointer to mask
valformat