1AuSoundRecordToFile(3)     Library Functions Manual     AuSoundRecordToFile(3)
2
3
4

Name

6       AuSoundRecordToFile - create a flow to record to a file.
7

Synopsis

9       #include <audio/audiolib.h>
10       #include <audio/soundlib.h>
11
12       AuEventHandlerRec  *AuSoundRecordToFile(server, filename, source, gain,
13       callback, callback_data, mode, file_format, comment, rate, data_format,
14       flow, volume_mult_elem, status)
15           AuServer *server;
16           char *filename;
17           AuDeviceID source;
18           AuFixedPoint gain;
19           void  (*callback)  (AuServer  *,  AuEventHandlerRec  *,  AuEvent *,
20       AuPointer);
21           AuPointer callback_data;
22           int mode;
23           int file_format;
24           char *comment;
25           AuUint32 rate;
26           int data_format;
27           AuFlowID *flow; /* RETURN */
28           int *volume_mult_elem; /* RETURN */
29           AuStatus *status; /* RETURN */
30

Arguments

32       server    Specifies the connection to the audio server.
33
34       filename  Specifies the name of the file to record to.
35
36       source    Specifies the input device to use.
37
38       gain      Specifies the gain for the input device.
39
40       callback  Specifies the procedure to be  called  for  additional  event
41                 processing.
42
43       callback_data
44                 Specifies  any additional arguments to be passed to the call‐
45                 back.
46
47       mode      Specifies the line mode for the input device.  Currently  the
48                 following  line  modes  are  defined:  AuDeviceInputModeNone,
49                 AuDeviceInputModeLineIn, AuDeviceInputModeMicrophone.
50
51       file_format
52                 Specifies the file format.   Currently,  the  following  file
53                 formats   are  supported:  SoundFileFormatSnd,  SoundFileFor‐
54                 matVoc, SoundFileFormatWave, SoundFileFormatAiff,  SoundFile‐
55                 FormatSvx.
56
57       comment   Specifies a comment to embedded in the file.
58
59       rate      Specifies the sample rate to record at.
60
61       data_format
62                 Specifies  the  data  format.   Currently, the following data
63                 formats are defined: AuFormatULAW8,  AuFormatLinearUnsigned8,
64                 AuFormatLinearSigned8,  AuFormatLinearSigned16MSB,  AuFormat‐
65                 LinearUnsigned16MSB, AuFormatSignedLinear16LSB, and AuFormat‐
66                 LinearUnsigned16LSB.
67
68       flow      If non-NULL, returns the flow ID.
69
70       volume_mult_elem
71                 Accord to the comment in the source, not implemented.
72
73       status    If  non-NULL,  flush  the output buffer and return the status
74                 from the server.
75

Description

77       AuSoundRecordToFile creates a flow to record from  source  to  filename
78       and returns a pointer to the event handler created or NULL if there was
79       an error.
80

Errors

82       AuBadDevice.
83

See Also

85       AuSoundRecord,       AuSoundRecordToBucket,        AuSoundRecordToData,
86       AuSoundRecordToFileN.
87
88       audiolib - Network Audio System C Language Interface
89
90
91
92soundlib                             1.9.1              AuSoundRecordToFile(3)
Impressum