Sound_Sample(3)

💖 Sound_Sample(3) — the literal heart of SDL_sound 💖

Welcome to the Sound_Sample(3) page from the Library Functions Manual, bestie. Buckle up, because this struct is kind of a big deal. 🫶

---

🌸 NAME 🌸

Sound_Sample — represents sound data in the process of being decoded. It’s giving “audio in motion,” fr fr. 🎧✨

---

✨ SYNOPSIS ✨

#include <SDL_sound.h>

🎀 Data Fields 🎀

• void * opaque
• const Sound_DecoderInfo * decoder
• Sound_AudioInfo desired
• Sound_AudioInfo actual
• void * buffer
• Uint32 buffer_size
• Sound_SampleFlags flags

---

💫 Detailed Description 💫

Okay so bestie, the Sound_Sample structure is the heart of SDL_sound. 💅 It holds information about a source of sound data as it is being decoded. Like, it’s literally the main character of the decoding process. 👑

EVERY FIELD IN THIS IS READ-ONLY. Please use the API functions to change them. No cap, do not just go touching fields directly. That is not the vibe. 🚫🙈

---

🎀 Field Documentation 🎀

Sound_AudioInfo Sound_Sample::actual

The actual audio format of the sample. What it really is, not just what you wished for. ✨

void* Sound_Sample::buffer

Decoded sound data lands in here. It’s the little landing pad for your audio bytes. 🛬🎶

Uint32 Sound_Sample::buffer_size

Current size of (buffer), in bytes (Uint8). Size matters, bestie. 📏💛

const Sound_DecoderInfo* Sound_Sample::decoder

Decoder used for this sample. The decoder that showed up and did the work. 🧚‍♀️

Sound_AudioInfo Sound_Sample::desired

Desired audio format for conversion. This is the format you’re asking for. 💙

Sound_SampleFlags Sound_Sample::flags

Flags relating to this sample. Little flaggy details, iykyk. 🚩✨

void* Sound_Sample::opaque

Internal use only. Don’t touch. Seriously. Hands off. 🙅‍♀️ 💀

---

🫶 Author 🫶

Generated automatically by Doxygen for SDL_sound from the source code. Iconic, automated, and honestly kind of slay. 🤖💖

---

💅 That’s the whole page — SDL_sound, Version 1.0.1, Sound_Sample(3) — bye bestie, go decode something cute! 🦋🌸