Mercurial > sdl-ios-xcode

view docs/html/sdlpauseaudio.html @ 2144:665c2669e6a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merged r3138:3139 from branches/SDL-1.2: Don't init audio callback buffer. (This already had a concession for devices opened via the 1.2 entry points, I've changed it to respect the environment variable and do it for all devices now.)
author Ryan C. Gordon <icculus@icculus.org>
date Thu, 05 Jul 2007 02:30:10 +0000
parents 355632dca928
children
line wrap: on
line source

<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
>