Wiki Page Content

SDL_PauseAudio

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

Contents

  1. SDL_PauseAudio
    1. Syntax
    2. Function Parameters
    3. Code Examples
    4. Remarks
    5. Related Functions

Syntax

void SDL_PauseAudio(int pause_on)

Function Parameters

pause_on

non-zero to pause, 0 to unpause

Code Examples

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 

SDL_PauseAudioDevice(1, pause_on);

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

CategoryAPI, CategoryAudio

None: SDL_PauseAudio (last edited 2013-08-12 05:39:33 by RyanGordon)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit