AFWRITEFRAMES(3)

💖 AFWRITEFRAMES(3) 💖

okay bestie, so this is afWriteFrames — it's a lil function from the Audio File Library and its whole job is writing sample frames to a track in an audio file. she's the write-side twin of afReadFrames(3), iykyk. 🎀

✨ SYNOPSIS ✨

#include <audiofile.h>

AFframecount afWriteFrames(AFfilehandle file, int track, const void *data,
    AFframecount count);

like… that's the whole vibe right there. include the header, call the function, boom. 💅

🌸 DESCRIPTION 🌸

afWriteFrames attempts to write up to count frames of audio data from the buffer data into the audio file handle file.

that's it. that's the function. she writes frames. she's not complicated, she's just important. ✨

note the "attempts" bestie — that's not me being dramatic, that's literally the wording. you get back how many actually made it. 🫶

🦋 PARAMETERS 🦋

• file — a valid file handle, and it has to be one that afOpenFile(3) gave you. no random handles, no vibes-based file descriptors. 👑
• track — for every file format that's currently supported, this is always AF_DEFAULT_TRACK. yes, every time. it's giving "parameter for future reasons." 🙈
• data — the buffer of sample frames you wanna write into the file. your actual audio, right there. 🍓
• count — how many sample frames you're writing. the number. the amount. the quantity. ✨

💜 RETURN VALUE 💜

afWriteFrames returns the number of sample frames that were successfully written to file.

so like — check it! don't just assume all count of them went through, bestie. read the number, respect the number. 😭

💀 ERRORS 💀

afWriteFrames can produce these errors, and when she does, she does NOT play:

• AF_BAD_FILEHANDLE — the file handle was invalid. it wasn't a real handle, it was a fake one, a little impostor. 🙈
• AF_BAD_TRACKID — the track is not AF_DEFAULT_TRACK. you tried to be different and the library said no. 💀
• AF_BAD_WRITE — writing the audio data to the file failed. the write itself just did not happen. 🔥
• AF_BAD_LSEEK — seeking within the file failed. couldn't move around in there, tragic. 😭

🌈 SEE ALSO 🌈

• afReadFrames(3) — her sister, the read one. go say hi. 🫶

🧚 AUTHOR 🧚

Michael Pruett <michael@68k.org> — thank you king, we appreciate you. 👑

Audio File Library 0.3.6 🌸 03/06/2013 — yeah she's an elder but she still slays, and that's the version + date this whole page is serving. periodt. 💅✨