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

<HTML
><HEAD
><TITLE
>SDL_PauseAudio</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_OpenAudio"
HREF="sdlopenaudio.html"><LINK
REL="NEXT"
TITLE="SDL_GetAudioStatus"
HREF="sdlgetaudiostatus.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="sdlopenaudio.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlgetaudiostatus.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLPAUSEAUDIO"
></A
>SDL_PauseAudio</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN6765"
></A
><H2
>Name</H2
>SDL_PauseAudio&nbsp;--&nbsp;Pauses and unpauses the audio callback processing</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN6768"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN6769"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <B
CLASS="FSFUNC"
>SDL_PauseAudio</B
></CODE
>(int pause_on);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6775"
></A
><H2
>Description</H2
><P
>This function pauses and unpauses the audio callback processing.
It should be called with <TT
CLASS="PARAMETER"
><I
>pause_on</I
></TT
>=0 after opening the audio
device to start playing sound.  This is so you can safely initialize
data for your callback function after opening the audio device.
Silence will be written to the audio device during the pause.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN6779"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlgetaudiostatus.html"
><TT
CLASS="FUNCTION"
>SDL_GetAudioStatus</TT
></A
>,
<A
HREF="sdlopenaudio.html"
><TT
CLASS="FUNCTION"
>SDL_OpenAudio</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="sdlopenaudio.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="sdlgetaudiostatus.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_OpenAudio</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_GetAudioStatus</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_PauseAudio</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_OpenAudio"
	17	HREF="sdlopenaudio.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_GetAudioStatus"
	20	HREF="sdlgetaudiostatus.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="sdlopenaudio.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="sdlgetaudiostatus.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="SDLPAUSEAUDIO"
74	></A
75	>SDL_PauseAudio</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN6765"
80	></A
81	><H2
82	>Name</H2
83	>SDL_PauseAudio -- Pauses and unpauses the audio callback processing</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN6768"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN6769"
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_PauseAudio</B
108	></CODE
109	>(int pause_on);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN6775"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>This function pauses and unpauses the audio callback processing.
124	It should be called with <TT
125	CLASS="PARAMETER"
126	><I
127	>pause_on</I
128	></TT
129	>=0 after opening the audio
130	device to start playing sound. This is so you can safely initialize
131	data for your callback function after opening the audio device.
132	Silence will be written to the audio device during the pause.</P
133	></DIV
134	><DIV
135	CLASS="REFSECT1"
136	><A
137	NAME="AEN6779"
138	></A
139	><H2
140	>See Also</H2
141	><P
142	><A
143	HREF="sdlgetaudiostatus.html"
144	><TT
145	CLASS="FUNCTION"
146	>SDL_GetAudioStatus</TT
147	></A
148	>,
149	<A
150	HREF="sdlopenaudio.html"
151	><TT
152	CLASS="FUNCTION"
153	>SDL_OpenAudio</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="sdlopenaudio.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="sdlgetaudiostatus.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_OpenAudio</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_GetAudioStatus</TD
216	></TR
217	></TABLE
218	></DIV
219	></BODY
220	></HTML
221	>