|
Size: 644
Comment: added RFs
|
Size: 1483
Comment: Rewritten
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| Use this function to get the current audio state. | This function is a legacy means of querying the audio device. New programs might want to use [[SDL_GetAudioDeviceStatus]]() instead. |
| Line 11: | Line 11: |
| SDL_audiostatus SDL_GetAudioStatus(void) | SDL_AudioStatus SDL_GetAudioStatus(void) |
| Line 15: | Line 15: |
| Returns the current audio state, which can be one of: .SDL_AUDIO_STOPPED .SDL_AUDIO_PLAYING .SDL_AUDIO_PAUSED |
Returns the [[SDL_AudioStatus]] of the specified audio device which may be one of the following: <<Include(SDL_AudioStatus, , , from="== Values ==", to="== Code Examples ==")>> |
| Line 22: | Line 20: |
| You can add your code example here | void printStatus(void) { switch (SDL_GetAudioStatus()) { case SDL_AUDIO_STOPPED: printf("stopped\n"); break; case SDL_AUDIO_PLAYING: printf("playing\n"); break; case SDL_AUDIO_PAUSED: printf("paused\n"); break; default: printf("???"); break; } } // device starts paused if (SDL_OpenAudio(&desired, &obtained) == 0) { printStatus(); // prints "paused" SDL_PauseAudio(0); printStatus(); // prints "playing" SDL_PauseAudio(1); printStatus(); // prints "paused" SDL_CloseAudio(); printStatus(); // prints "stopped" } |
| Line 26: | Line 44: |
| ''You can add useful comments here'' | This function is equivalent to calling {{{#!highlight cpp SDL_GetAudioDeviceStatus(1); }}} and is only useful if you used the legacy [[SDL_OpenAudio]]() function. |
| Line 30: | Line 54: |
| .[[SDL_PauseAudio]] |
SDL_GetAudioStatus
This function is a legacy means of querying the audio device. New programs might want to use SDL_GetAudioDeviceStatus() instead.
Syntax
SDL_AudioStatus SDL_GetAudioStatus(void)
Return Value
Returns the SDL_AudioStatus of the specified audio device which may be one of the following:
SDL_AUDIO_STOPPED |
audio device is stopped |
SDL_AUDIO_PLAYING |
audio device is playing |
SDL_AUDIO_PAUSED |
audio device is paused |
Code Examples
void printStatus(void)
{
switch (SDL_GetAudioStatus())
{
case SDL_AUDIO_STOPPED: printf("stopped\n"); break;
case SDL_AUDIO_PLAYING: printf("playing\n"); break;
case SDL_AUDIO_PAUSED: printf("paused\n"); break;
default: printf("???"); break;
}
}
// device starts paused
if (SDL_OpenAudio(&desired, &obtained) == 0) {
printStatus(); // prints "paused"
SDL_PauseAudio(0);
printStatus(); // prints "playing"
SDL_PauseAudio(1);
printStatus(); // prints "paused"
SDL_CloseAudio();
printStatus(); // prints "stopped"
}
Remarks
This function is equivalent to calling
SDL_GetAudioDeviceStatus(1);
and is only useful if you used the legacy SDL_OpenAudio() function.
