Sound_Sample man page

Sound_Sample — Represents sound data in the process of being decoded.


#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

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.

Field Documentation

Sound_AudioInfo Sound_Sample::actual

Actual audio format of sample.

void* Sound_Sample::buffer

Decoded sound data lands in here.

Uint32 Sound_Sample::buffer_size

Current size of (buffer), in bytes (Uint8).

const Sound_DecoderInfo* Sound_Sample::decoder

Decoder used for this sample.

Sound_AudioInfo Sound_Sample::desired

Desired audio format for conversion.

Sound_SampleFlags Sound_Sample::flags

Flags relating to this sample.

void* Sound_Sample::opaque

Internal use only. Don't touch.


Generated automatically by Doxygen for SDL_sound from the source code.

Referenced By

Sound_Sameple::buffer_size(3), Sound_Sample::actual(3), Sound_Sample::buffer(3), Sound_Sample::decoder(3), Sound_Sample::desired(3), Sound_Sample::flags(3) and Sound_Sample::opaque(3) are aliases of Sound_Sample(3).

SDL_sound Version 1.0.1 Wed Feb 3 2016