Sound_Sample Struct Reference

Represents sound data in the process of being decoded. More...

#include <SDL_sound.h>

List of all members.

Public Attributes
void *	opaque
	Internal use only.
const Sound_DecoderInfo *	decoder
	Decoder used for this sample.
Sound_AudioInfo	desired
	Desired audio format for conversion.
Sound_AudioInfo	actual
	Actual audio format of sample.
void *	buffer
	Decoded sound data lands in here.
Uint32	buffer_size
	Current size of (buffer), in bytes (Uint8).
Sound_SampleFlags	flags
	Flags relating to this sample.

---

Detailed Description

Represents sound data in the process of being decoded.

The Sound_Sample structure is the heart of SDL_sound. This holds information about a source of sound data as it is being decoded. EVERY FIELD IN THIS IS READ-ONLY. Please use the API functions to change them.

Definition at line 179 of file SDL_sound.h.

---

Member Data Documentation

Sound_AudioInfo Sound_Sample::actual

Actual audio format of sample. Definition at line 184 of file SDL_sound.h.

void* Sound_Sample::buffer

Decoded sound data lands in here. Definition at line 185 of file SDL_sound.h. Referenced by loadWave().

Uint32 Sound_Sample::buffer_size

Current size of (buffer), in bytes (Uint8). Definition at line 186 of file SDL_sound.h. Referenced by loadWave().

const Sound_DecoderInfo* Sound_Sample::decoder

Decoder used for this sample. Definition at line 182 of file SDL_sound.h.

Sound_AudioInfo Sound_Sample::desired

Desired audio format for conversion. Definition at line 183 of file SDL_sound.h.

Sound_SampleFlags Sound_Sample::flags

Flags relating to this sample. Definition at line 187 of file SDL_sound.h.

void* Sound_Sample::opaque

Internal use only. Don't touch. Definition at line 181 of file SDL_sound.h.

---

The documentation for this struct was generated from the following file:

• SDL_sound.h

---