[sdl_omap.git] / docs / html / sdlgetaudiostatus.html

<HTML
><HEAD
><TITLE
>SDL_GetAudioStatus</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Audio"
HREF="audio.html"><LINK
REL="PREVIOUS"
TITLE="SDL_PauseAudio"
HREF="sdlpauseaudio.html"><LINK
REL="NEXT"
TITLE="SDL_LoadWAV"
HREF="sdlloadwav.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlpauseaudio.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlloadwav.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLGETAUDIOSTATUS"
></A
>SDL_GetAudioStatus</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN6790"
></A
><H2
>Name</H2
>SDL_GetAudioStatus&nbsp;--&nbsp;Get the current audio state</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN6793"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN6794"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>SDL_audiostatus<B
CLASS="FSFUNC"
>SDL_GetAudioStatus</B
></CODE
>(void);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6800"
></A
><H2
>Description</H2
><PRE
CLASS="PROGRAMLISTING"
>typedef enum{
  SDL_AUDIO_STOPPED,
  SDL_AUDIO_PAUSED,
  SDL_AUDIO_PLAYING
} SDL_audiostatus;</PRE
><P
>Returns either <TT
CLASS="LITERAL"
>SDL_AUDIO_STOPPED</TT
>, <TT
CLASS="LITERAL"
>SDL_AUDIO_PAUSED</TT
> or <TT
CLASS="LITERAL"
>SDL_AUDIO_PLAYING</TT
> depending on the current audio state.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6807"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlpauseaudio.html"
><TT
CLASS="FUNCTION"
>SDL_PauseAudio</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlpauseaudio.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlloadwav.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_PauseAudio</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="audio.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_LoadWAV</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_GetAudioStatus</TITLE
	5	><META
	6	NAME="GENERATOR"
	7	CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
	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
	31	SUMMARY="Header navigation table"
	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"
	49	ACCESSKEY="P"
	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"
	63	ACCESSKEY="N"
	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"
74	></A
75	>SDL_GetAudioStatus</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN6790"
80	></A
81	><H2
82	>Name</H2
83	>SDL_GetAudioStatus -- Get the current audio state</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN6793"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN6794"
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
118	NAME="AEN6800"
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
144	NAME="AEN6807"
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
162	SUMMARY="Footer navigation table"
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"
174	ACCESSKEY="P"
175	>Prev</A
176	></TD
177	><TD
178	WIDTH="34%"
179	ALIGN="center"
180	VALIGN="top"
181	><A
182	HREF="index.html"
183	ACCESSKEY="H"
184	>Home</A
185	></TD
186	><TD
187	WIDTH="33%"
188	ALIGN="right"
189	VALIGN="top"
190	><A
191	HREF="sdlloadwav.html"
192	ACCESSKEY="N"
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"
208	ACCESSKEY="U"
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	>