1 .TH "SDL_LoadWAV" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" 

     2 .SH "NAME"

     3 SDL_LoadWAV \- Load a WAVE file

     4 .SH "SYNOPSIS"

     5 .PP

     6 \fB#include "SDL\&.h"

     7 .sp

     8 \fBSDL_AudioSpec *\fBSDL_LoadWAV\fP\fR(\fBconst char *file, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len\fR);

     9 .SH "DESCRIPTION"

    10 .PP

    11 \fBSDL_LoadWAV\fP This function loads a WAVE \fBfile\fR into memory\&.

    12 .PP

    13 If this function succeeds, it returns the given \fI\fBSDL_AudioSpec\fP\fR, filled with the audio data format of the wave data, and sets \fBaudio_buf\fR to a \fBmalloc\fP\&'d buffer containing the audio data, and sets \fBaudio_len\fR to the length of that audio buffer, in bytes\&. You need to free the audio buffer with \fI\fBSDL_FreeWAV\fP\fR when you are done with it\&.

    14 .PP

    15 This function returns \fBNULL\fP and sets the SDL error message if the wave file cannot be opened, uses an unknown data format, or is corrupt\&. Currently raw, MS-ADPCM and IMA-ADPCM WAVE files are supported\&.

    16 .SH "EXAMPLE"

    17 .PP

    18 .nf

    19 \f(CWSDL_AudioSpec wav_spec;

    20 Uint32 wav_length;

    21 Uint8 *wav_buffer;

    22 

    23 /* Load the WAV */

    24 if( SDL_LoadWAV("test\&.wav", &wav_spec, &wav_buffer, &wav_length) == NULL ){

    25   fprintf(stderr, "Could not open test\&.wav: %s

    26 ", SDL_GetError());

    27   exit(-1);

    28 }

    29 \&.

    30 \&.

    31 \&.

    32 /* Do stuff with the WAV */

    33 \&.

    34 \&.

    35 /* Free It */

    36 SDL_FreeWAV(wav_buffer);\fR

    37 .fi

    38 .PP

    39 .SH "SEE ALSO"

    40 .PP

    41 \fI\fBSDL_AudioSpec\fR\fR, \fI\fBSDL_OpenAudio\fP\fR, \fI\fBSDL_FreeWAV\fP\fR

    42 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58