ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
pcm_file.c File Reference

PCM File Plugin Interface. More...

Functions

int snd_pcm_file_open (snd_pcm_t **pcmp, const char *name, const char *fname, int fd, const char *ifname, int ifd, int trunc, const char *fmt, int perm, snd_pcm_t *slave, int close_slave, snd_pcm_stream_t stream)
 Creates a new File PCM.
int _snd_pcm_file_open (snd_pcm_t **pcmp, const char *name, snd_config_t *root, snd_config_t *conf, snd_pcm_stream_t stream, int mode)
 Creates a new File PCM.

Detailed Description

PCM File Plugin Interface.

Author:
Abramo Bagnara abram.nosp@m.o@al.nosp@m.sa-pr.nosp@m.ojec.nosp@m.t.org
Date:
2000-2001

Function Documentation

int _snd_pcm_file_open ( snd_pcm_t **  pcmp,
const char *  name,
snd_config_t root,
snd_config_t conf,
snd_pcm_stream_t  stream,
int  mode 
)

Creates a new File PCM.

Parameters:
pcmpReturns created PCM handle
nameName of PCM
rootRoot configuration node
confConfiguration node with File PCM description
streamStream type
modeStream mode
Return values:
zeroon success otherwise a negative error code
Warning:
Using of this function might be dangerous in the sense of compatibility reasons. The prototype might be freely changed in future.
int snd_pcm_file_open ( snd_pcm_t **  pcmp,
const char *  name,
const char *  fname,
int  fd,
const char *  ifname,
int  ifd,
int  trunc,
const char *  fmt,
int  perm,
snd_pcm_t slave,
int  close_slave,
snd_pcm_stream_t  stream 
)

Creates a new File PCM.

Parameters:
pcmpReturns created PCM handle
nameName of PCM
fnameOutput filename (or NULL if file descriptor fd is available)
fdOutput file descriptor
ifnameInput filename (or NULL if file descriptor ifd is available)
ifdInput file descriptor (if (ifd < 0) && (ifname == NULL), no input redirection will be performed)
truncTruncate the file if it already exists
fmtFile format ("raw" or "wav" are available)
permFile permission
slaveSlave PCM handle
close_slaveWhen set, the slave PCM handle is closed with copy PCM
streamthe direction of PCM stream
Return values:
zeroon success otherwise a negative error code
Warning:
Using of this function might be dangerous in the sense of compatibility reasons. The prototype might be freely changed in future.