AuSoundRecordToFileN.3x - Man Page
Name
AuSoundRecordToFileN -
Synopsis
#include <audio/audiolib.h>
#include <audio/soundlib.h>
AuEventHandlerRec *AuSoundRecordToFileN(server, filename, source, gain, num_samples, callback, callback_data, mode, file_format, comment, rate, data_format, flow, volume_mult_elem, status)
   AuServer *server;
   char *filename;
   AuDeviceID source;
   AuFixedPoint gain;
   AuUint32 num_samples;
   void (*callback)(AuServer *, AuEventHandlerRec *, AuEvent *, AuPointer);
   AuPointer callback_data;
   int mode;
   int file_format;
   char * comment;
   AuUint32 rate;
   int data_format;
   AuFlowID *flow;
   int *volume_mult_elem;
   AuStatus *status;
Arguments
- server
- Specifies the connection to the audio server. 
- filename
- Specifies the name of the file to record to. 
- source
- Specifies the input device to record from. 
- gain
- Specifies the gain for the input device. 
- num_samples
- Specifies the number of samples to record. Use AuUnlimitedSamples to record an unlimited number of samples. 
- callback
- Specifies the procedure to be called for additional event processing. 
- callback_data
- Specifies any additional arguments to be passed to callback. 
- mode
- Specifies the line mode for the input device. Currently the following line modes are defined: AuDeviceInputModeNone, AuDeviceInputModeLineIn, AuDeviceInputModeMicrophone. 
- file_format
- Specifies the file format. Currently, the following file formats are supported: SoundFileFormatSnd, SoundFileFormatVoc, SoundFileFormatWave, SoundFileFormatAiff, SoundFileFormatSvx. 
- comment
- Specifies a comment to embedded in the file. 
- rate
- Specifies the sample rate to record at. 
- data_format
- Specifies the data format. Currently, the following data formats are defined: AuFormatULAW8, AuFormatLinearUnsigned8, AuFormatLinearSigned8, AuFormatLinearSigned16MSB, AuFormatLinearUnsigned16MSB, AuFormatSignedLinear16LSB, and AuFormatLinearUnsigned16LSB. 
- flow
- If non-NULL, returns the flow ID. 
- volume_mult_elem
- Accord to the comment in the source, not implemented. 
- status
- If non-NULL, flush the output buffer and return the status from the server. 
Description
AuSoundRecordToFileN creates a flow to record from source into filename and returns a pointer to the event handler created or NULL if there was an error.
Errors
AuBadDevice.
See Also
AuSoundRecord, AuSoundRecordToBucket, AuSoundRecordToData, AuSoundRecordToFile.
audiolib - Network Audio System C Language Interface
Referenced By
AuSoundRecord.3x(3), AuSoundRecordToBucket.3x(3), AuSoundRecordToData.3x(3), AuSoundRecordToFile.3x(3).