devela::_dep::sdl3::sys::audio

Function SDL_PauseAudioStreamDevice

pub unsafe extern "C" fn SDL_PauseAudioStreamDevice(
    stream: *mut SDL_AudioStream,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Use this function to pause audio playback on the audio device associated with an audio stream.

This function pauses audio processing for a given device. Any bound audio streams will not progress, and no audio will be generated. Pausing one device does not prevent other unpaused devices from running.

Pausing a device can be useful to halt all audio without unbinding all the audio streams. This might be useful while a game is paused, or a level is loading, etc.

§Parameters

  • stream: the audio stream associated with the audio device to pause.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also