Wiki Page Content

Revision 11 as of 2009-11-08 05:33:12

Clear message

SDL_BuildAudioCVT

Use this function to initialize a SDL_AudioCVT structure for conversion.

Syntax

int SDL_BuildAudioCVT (SDL_AudioCVT*   cvt, 
                       SDL_AudioFormat src_format, 
                       Uint8           src_channels, 
                       int             src_rate, 
                       SDL_AudioFormat dst_format, 
                       Uint8           dst_channels, 
                       int             dst_rate)

Function Parameters

cvt

a pointer to an SDL_AudioCVT structure that is filled in with audio conversion information

src_format

the source format of the audio data; for more info see SDL_AudioFormat

src_channels

the number of channels in the source

src_rate

the frequency or samples-per-second of the source

dst_format

the destination format of the audio data

dst_channels

the number of channels in the destination

dst_rate

the frequency or samples-per-second of the destination

Return Value

Returns -1 if the format conversion is not supported, 0 if there's no conversion needed, or 1 if the audio filter is set up.

Code Examples

You can add your code example here

Remarks

Before an SDL_AudioCVT structure can be used to convert audio data it must be initialized with source and destination information.

For information on audio formats see SDL_AudioSpec.

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