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

Name

6       AuSoundRecordToFileN -
7

Synopsis

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

Arguments

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

Description

81       AuSoundRecordToFileN creates a flow to record from source into filename
82       and returns a pointer to the event handler created or NULL if there was
83       an error.
84

Errors

86       AuBadDevice.
87

See Also

89       AuSoundRecord,       AuSoundRecordToBucket,        AuSoundRecordToData,
90       AuSoundRecordToFile.
91
92       audiolib - Network Audio System C Language Interface
93
94
95
96soundlib                             1.9.4             AuSoundRecordToFileN(3)
Impressum