AuSoundRecordToFileN(3)

💖 AuSoundRecordToFileN(3) 💖

okay bestie, welcome to the Library Functions Manual, section 3 — this is the one and only AuSoundRecordToFileN page and it's gonna record audio straight into a file, no cap. 🎀 sit down, grab a strawberry, we're doing this. 🍓

✨ Name ✨

AuSoundRecordToFileN — the girlies' fave way to record sound from the audio server straight into a file. 🦋

✨ 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 ✨

okay so she takes a LOT of arguments, but like, we go through them one by one, we don't skip. 💅

• server — the connection to the audio server. like, your link to the whole situation. 🔌
• filename — the name of the file we're recording into. yes, an actual name. ✨
• source — the input device we're recording from. where the sound comes in, bestie. 🎤
• gain — the gain for the input device. turning it up (or down, respectfully). 🔊
• num_samples — the number of samples to record. and if you want no limit at all, pass AuUnlimitedSamples and she just keeps going. ♾️
• callback — the procedure that gets called for additional event processing. your little helper function. 🫶
• callback_data — any additional arguments that get passed along to callback. the lil goodie bag. 🎁
• mode — the line mode for the input device. currently the following line modes are defined: AuDeviceInputModeNone, AuDeviceInputModeLineIn, AuDeviceInputModeMicrophone. pick your vibe. 🌈
• file_format — the file format. currently, the following file formats are supported: SoundFileFormatSnd, SoundFileFormatVoc, SoundFileFormatWave, SoundFileFormatAiff, SoundFileFormatSvx. so many options, iconic honestly. 💜
• comment — a comment to be embedded in the file. cute little note-to-self energy. 📝
• rate — the sample rate to record at. ⏱️
• data_format — the data format. currently, the following data formats are defined: AuFormatULAW8, AuFormatLinearUnsigned8, AuFormatLinearSigned8, AuFormatLinearSigned16MSB, AuFormatLinearUnsigned16MSB, AuFormatSignedLinear16LSB, and AuFormatLinearUnsigned16LSB. that's seven. we counted. 👑
• flow — if non-NULL, returns the flow ID. 🌀
• volume_mult_elem — accord to the comment in the source, not implemented. yeah. she said what she said. 💀
• 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.

that's it, that's the whole thing. she builds the flow, she does the recording, she hands you back a handler pointer — or NULL if it went sideways. main character behaviour fr fr. 🔥

✨ Errors ✨

AuBadDevice.

bestie if you get this one it's giving "that device? never heard of her." 🙈

✨ See Also ✨

• AuSoundRecord
• AuSoundRecordToBucket
• AuSoundRecordToData
• AuSoundRecordToFile

audiolib — Network Audio System C Language Interface 🌸

and that's the whole page, periodt. 💅 this one's from soundlib, version 1.9.4, so go forth and record something gorgeous. mwah. 🎀✨💖