SDL_AudioSpec — Audio Specification Structure
| typedef | struct { | |||
| int |
freq; |
|||
| Uint16 |
format; |
|||
| Uint8 |
channels; |
|||
| Uint8 |
silence; |
|||
| Uint16 |
samples; |
|||
| Uint32 |
size; |
|||
| void | (* |
callback)(void *userdata, Uint8 *stream, int len); |
||
| void | * |
userdata; |
||
| } SDL_AudioSpec; | ||||
freqAudio frequency in samples per second
formatAudio data format
channelsNumber of channels: 1 mono, 2 stereo
silenceAudio buffer silence value (calculated)
samplesAudio buffer size in samples
sizeAudio buffer size in bytes (calculated)
callback(..)Callback function for filling the audio buffer
userdataPointer the user data which is passed to the callback function
The SDL_AudioSpec
structure is used to describe the format of some audio data.
This structure is used by SDL_OpenAudio and SDL_LoadWAV. While all fields are used by
SDL_OpenAudio only freq, format, samples and channels are used by
SDL_LoadWAV. We will detail
these common members here.
freqThe number of samples sent to the sound device every second. Common values are 11025, 22050 and 44100. The higher the better.
formatSpecifies the size and type of each sample element
AUDIO_U8AUDIO_S8AUDIO_U16 or AUDIO_U16LSBAUDIO_S16 or AUDIO_S16LSBAUDIO_U16MSBAUDIO_S16MSBAUDIO_U16SYSAUDIO_S16SYSchannelsThe number of seperate sound channels. 1 is mono (single channel), 2 is stereo (dual channel).
samplesWhen used with SDL_OpenAudio this refers to the size
of the audio buffer in samples. A sample a chunk of
audio data of the size specified in format mulitplied by the
number of channels. When the SDL_AudioSpec is used with
SDL_LoadWAV samples is set to
4096.
SDL_OpenAudio(3), SDL_LoadWAV(3)
| COPYRIGHT |
|---|
|
This manual page is taken from the SDL library, licensed under GNU LGPL. |