Mercurial > sdl-ios-xcode
annotate docs/html/sdlfreewav.html @ 2866:e532417a6977
Fixed SDL 1.2 compatibility problem.
The API specifies that SDL_OpenAudio() will fill out the 'desired' audio spec
with the correct samples and size set by the driver. This value is important
since it may be used by applications that size audio buffers, etc.
However, we want to allow advanced applications to call SDL_OpenAudioDevice()
which gets passed a const 'desired' parameter, and have the correct data filled
into the 'obtained' parameter, possibly allowing or not allowing format changes.
So... 'obtained' becomes the audio format the user callback is expected to use,
and we add flags to allow the application to specify which format changes are
allowed.
Note: We really need to add a way to query the 'obtained' audio spec.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 13 Dec 2008 06:36:47 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_FreeWAV</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
0 | 8 "><LINK |
9 REL="HOME" | |
10 TITLE="SDL Library Documentation" | |
11 HREF="index.html"><LINK | |
12 REL="UP" | |
13 TITLE="Audio" | |
14 HREF="audio.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_LoadWAV" | |
17 HREF="sdlloadwav.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_AudioCVT" | |
20 HREF="sdlaudiocvt.html"></HEAD | |
21 ><BODY | |
22 CLASS="REFENTRY" | |
23 BGCOLOR="#FFF8DC" | |
24 TEXT="#000000" | |
25 LINK="#0000ee" | |
26 VLINK="#551a8b" | |
27 ALINK="#ff0000" | |
28 ><DIV | |
29 CLASS="NAVHEADER" | |
30 ><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 32 WIDTH="100%" |
33 BORDER="0" | |
34 CELLPADDING="0" | |
35 CELLSPACING="0" | |
36 ><TR | |
37 ><TH | |
38 COLSPAN="3" | |
39 ALIGN="center" | |
40 >SDL Library Documentation</TH | |
41 ></TR | |
42 ><TR | |
43 ><TD | |
44 WIDTH="10%" | |
45 ALIGN="left" | |
46 VALIGN="bottom" | |
47 ><A | |
48 HREF="sdlloadwav.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 50 >Prev</A |
51 ></TD | |
52 ><TD | |
53 WIDTH="80%" | |
54 ALIGN="center" | |
55 VALIGN="bottom" | |
56 ></TD | |
57 ><TD | |
58 WIDTH="10%" | |
59 ALIGN="right" | |
60 VALIGN="bottom" | |
61 ><A | |
62 HREF="sdlaudiocvt.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 64 >Next</A |
65 ></TD | |
66 ></TR | |
67 ></TABLE | |
68 ><HR | |
69 ALIGN="LEFT" | |
70 WIDTH="100%"></DIV | |
71 ><H1 | |
72 ><A | |
73 NAME="SDLFREEWAV" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_FreeWAV</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN6857" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_FreeWAV -- Frees previously opened WAV data</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN6860" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN6861" |
0 | 95 ></A |
96 ><P | |
97 ></P | |
98 ><PRE | |
99 CLASS="FUNCSYNOPSISINFO" | |
100 >#include "SDL.h"</PRE | |
101 ><P | |
102 ><CODE | |
103 ><CODE | |
104 CLASS="FUNCDEF" | |
105 >void <B | |
106 CLASS="FSFUNC" | |
107 >SDL_FreeWAV</B | |
108 ></CODE | |
109 >(Uint8 *audio_buf);</CODE | |
110 ></P | |
111 ><P | |
112 ></P | |
113 ></DIV | |
114 ></DIV | |
115 ><DIV | |
116 CLASS="REFSECT1" | |
117 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN6867" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >After a WAVE file has been opened with <A | |
124 HREF="sdlloadwav.html" | |
125 ><TT | |
126 CLASS="FUNCTION" | |
127 >SDL_LoadWAV</TT | |
128 ></A | |
129 > its data can eventually be freed with <TT | |
130 CLASS="FUNCTION" | |
131 >SDL_FreeWAV</TT | |
132 >. <TT | |
133 CLASS="PARAMETER" | |
134 ><I | |
135 >audio_buf</I | |
136 ></TT | |
137 > is a pointer to the buffer created by <TT | |
138 CLASS="FUNCTION" | |
139 >SDL_LoadWAV</TT | |
140 >.</P | |
141 ></DIV | |
142 ><DIV | |
143 CLASS="REFSECT1" | |
144 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
145 NAME="AEN6875" |
0 | 146 ></A |
147 ><H2 | |
148 >See Also</H2 | |
149 ><P | |
150 ><A | |
151 HREF="sdlloadwav.html" | |
152 ><TT | |
153 CLASS="FUNCTION" | |
154 >SDL_LoadWAV</TT | |
155 ></A | |
156 ></P | |
157 ></DIV | |
158 ><DIV | |
159 CLASS="NAVFOOTER" | |
160 ><HR | |
161 ALIGN="LEFT" | |
162 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
163 SUMMARY="Footer navigation table" |
0 | 164 WIDTH="100%" |
165 BORDER="0" | |
166 CELLPADDING="0" | |
167 CELLSPACING="0" | |
168 ><TR | |
169 ><TD | |
170 WIDTH="33%" | |
171 ALIGN="left" | |
172 VALIGN="top" | |
173 ><A | |
174 HREF="sdlloadwav.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
175 ACCESSKEY="P" |
0 | 176 >Prev</A |
177 ></TD | |
178 ><TD | |
179 WIDTH="34%" | |
180 ALIGN="center" | |
181 VALIGN="top" | |
182 ><A | |
183 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
184 ACCESSKEY="H" |
0 | 185 >Home</A |
186 ></TD | |
187 ><TD | |
188 WIDTH="33%" | |
189 ALIGN="right" | |
190 VALIGN="top" | |
191 ><A | |
192 HREF="sdlaudiocvt.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
193 ACCESSKEY="N" |
0 | 194 >Next</A |
195 ></TD | |
196 ></TR | |
197 ><TR | |
198 ><TD | |
199 WIDTH="33%" | |
200 ALIGN="left" | |
201 VALIGN="top" | |
202 >SDL_LoadWAV</TD | |
203 ><TD | |
204 WIDTH="34%" | |
205 ALIGN="center" | |
206 VALIGN="top" | |
207 ><A | |
208 HREF="audio.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
209 ACCESSKEY="U" |
0 | 210 >Up</A |
211 ></TD | |
212 ><TD | |
213 WIDTH="33%" | |
214 ALIGN="right" | |
215 VALIGN="top" | |
216 >SDL_AudioCVT</TD | |
217 ></TR | |
218 ></TABLE | |
219 ></DIV | |
220 ></BODY | |
221 ></HTML | |
222 > |