Wiki Page Content

Revision 13 as of 2010-03-09 19:35:55

Clear message

DRAFT

SDL_AudioSpec

A structure that describes the audio output format. It contains a callback that is called when the audio device needs more data.

Data Fields

green

int

freq

DSP frequency (samples per second)

SDL_AudioFormat

format

audio data format

Uint8

channels

number of channels: 1 mono, 2 stereo

Uint8

silence

audio buffer silence value (calculated)

Uint16

samples

audio buffer size in samples (power of 2)

Uint16

padding

necessary for some compile environments

Uint32

size

audio buffer size in bytes (calculated)

SDL_AudioCallback

callback

a function that is called when the audio device needs more data; see Remarks for details

void*

userdata

a pointer that is passed as the first parameter to callback

Code Examples

You can add your code example here

Remarks

The calculated values silence and size are calculated by SDL_OpenAudio().

Stereo samples are stored in a LRLRLR ordering.

green

callback is of the form:

##alt 1st line from header rev 5387?
typedef void (SDLCALL * SDL_AudioCallback)(void*  userdata,
##w/ wiki formatting adjustments?
void* SDL_AudioCallback(void*  userdata,
##original content below 
void callback(void*  userdata, 
              Uint8* stream, 
              int    len);

userdata

an application-specific parameter saved in the SDL_AudioSpec structure

stream

a pointer to the audio data buffer to be filled in by the callback

len

the length of that buffer in bytes

Once the callback returns, the buffer will no longer be valid.


CategoryStruct

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit