Mercurial > sdl-ios-xcode
annotate docs/html/sdlgetaudiostatus.html @ 3164:c5b2884c26b4
Added an ifdef so that if you
#define SDL_NO_COMPAT
before you include SDL.h then SDL_compat.h will never be included in your code.
This is useful for making sure that your code uses only SDL 1.3 features.
It is also handy for finding things that are in SDL_compat.h that belong elsewhere.
author | Bob Pendleton <bob@pendleton.com> |
---|---|
date | Thu, 04 Jun 2009 21:00:45 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_GetAudioStatus</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_PauseAudio" | |
17 HREF="sdlpauseaudio.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_LoadWAV" | |
20 HREF="sdlloadwav.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="sdlpauseaudio.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="sdlloadwav.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="SDLGETAUDIOSTATUS" | |
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_GetAudioStatus</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="AEN6790" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_GetAudioStatus -- Get the current audio state</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="AEN6793" |
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="AEN6794" |
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 >SDL_audiostatus<B | |
106 CLASS="FSFUNC" | |
107 >SDL_GetAudioStatus</B | |
108 ></CODE | |
109 >(void);</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="AEN6800" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><PRE | |
123 CLASS="PROGRAMLISTING" | |
124 >typedef enum{ | |
125 SDL_AUDIO_STOPPED, | |
126 SDL_AUDIO_PAUSED, | |
127 SDL_AUDIO_PLAYING | |
128 } SDL_audiostatus;</PRE | |
129 ><P | |
130 >Returns either <TT | |
131 CLASS="LITERAL" | |
132 >SDL_AUDIO_STOPPED</TT | |
133 >, <TT | |
134 CLASS="LITERAL" | |
135 >SDL_AUDIO_PAUSED</TT | |
136 > or <TT | |
137 CLASS="LITERAL" | |
138 >SDL_AUDIO_PLAYING</TT | |
139 > depending on the current audio state.</P | |
140 ></DIV | |
141 ><DIV | |
142 CLASS="REFSECT1" | |
143 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
144 NAME="AEN6807" |
0 | 145 ></A |
146 ><H2 | |
147 >See Also</H2 | |
148 ><P | |
149 ><A | |
150 HREF="sdlpauseaudio.html" | |
151 ><TT | |
152 CLASS="FUNCTION" | |
153 >SDL_PauseAudio</TT | |
154 ></A | |
155 ></P | |
156 ></DIV | |
157 ><DIV | |
158 CLASS="NAVFOOTER" | |
159 ><HR | |
160 ALIGN="LEFT" | |
161 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
162 SUMMARY="Footer navigation table" |
0 | 163 WIDTH="100%" |
164 BORDER="0" | |
165 CELLPADDING="0" | |
166 CELLSPACING="0" | |
167 ><TR | |
168 ><TD | |
169 WIDTH="33%" | |
170 ALIGN="left" | |
171 VALIGN="top" | |
172 ><A | |
173 HREF="sdlpauseaudio.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
174 ACCESSKEY="P" |
0 | 175 >Prev</A |
176 ></TD | |
177 ><TD | |
178 WIDTH="34%" | |
179 ALIGN="center" | |
180 VALIGN="top" | |
181 ><A | |
182 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
183 ACCESSKEY="H" |
0 | 184 >Home</A |
185 ></TD | |
186 ><TD | |
187 WIDTH="33%" | |
188 ALIGN="right" | |
189 VALIGN="top" | |
190 ><A | |
191 HREF="sdlloadwav.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
192 ACCESSKEY="N" |
0 | 193 >Next</A |
194 ></TD | |
195 ></TR | |
196 ><TR | |
197 ><TD | |
198 WIDTH="33%" | |
199 ALIGN="left" | |
200 VALIGN="top" | |
201 >SDL_PauseAudio</TD | |
202 ><TD | |
203 WIDTH="34%" | |
204 ALIGN="center" | |
205 VALIGN="top" | |
206 ><A | |
207 HREF="audio.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
208 ACCESSKEY="U" |
0 | 209 >Up</A |
210 ></TD | |
211 ><TD | |
212 WIDTH="33%" | |
213 ALIGN="right" | |
214 VALIGN="top" | |
215 >SDL_LoadWAV</TD | |
216 ></TR | |
217 ></TABLE | |
218 ></DIV | |
219 ></BODY | |
220 ></HTML | |
221 > |