Sound_AudioInfo - Man Page

Information about an existing sample's format.

Synopsis

#include <SDL_sound.h>

Data Fields

Uint16 format
Uint8 channels
Uint32 rate

Detailed Description

Information about an existing sample's format.

These are the basics of a decoded sample's data structure: data format (see AUDIO_U8 and friends in SDL_audio.h), number of channels, and sample rate. If you need more explanation than that, you should stop developing sound code right now.

See also

Sound_SampleNew

Sound_SampleNewFromFile

Field Documentation

Uint8 Sound_AudioInfo::channels

Number of sound channels. 1 == mono, 2 == stereo.

Uint16 Sound_AudioInfo::format

Equivalent of SDL_AudioSpec.format.

Uint32 Sound_AudioInfo::rate

Sample rate; frequency of sample points per second.

Author

Generated automatically by Doxygen for SDL_sound from the source code.

Referenced By

The man pages Sound_AudioInfo::channels(3), Sound_AudioInfo::format(3) and Sound_AudioInfo::rate(3) are aliases of Sound_AudioInfo(3).

Version unknown version (build with 'make docs' next time!) SDL_sound