#pragma section-numbers off
#pragma disable-camelcase

= SDL_PauseAudio =
This function is a legacy means of pausing the audio device. New programs might want to use [[SDL_PauseAudioDevice]]() instead.

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
void SDL_PauseAudio(int pause_on)
}}}

== Function Parameters ==

||'''pause_on'''||non-zero to pause, 0 to unpause||

== Code Examples ==
{{{#!highlight cpp
SDL_PauseAudio(1);  // audio callback is stopped when this returns.
SDL_Delay(5000);  // audio device plays silence for 5 seconds
SDL_PauseAudio(0);  // audio callback starts running again.
}}}

== Remarks ==
This function is equivalent to calling

{{{#!highlight cpp
SDL_PauseAudioDevice(1, pause_on);
}}}

and is only useful if you used the legacy [[SDL_OpenAudio]]() function.

== Related Functions ==
 .[[SDL_GetAudioStatus]]
 .[[SDL_PauseAudioDevice]]

----
[[CategoryAPI]], [[CategoryAudio]]