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

Function SDL_GetAudioStreamAvailable

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

Get the number of converted/resampled bytes available.

The stream may be buffering data behind the scenes until it has enough to resample correctly, so this number might be lower than what you expect, or even be zero. Add more data or flush the stream if you need the data now.

If the stream has so much data that it would overflow an int, the return value is clamped to a maximum value, but no queued data is lost; if there are gigabytes of data queued, the app might need to read some of it with SDL_GetAudioStreamData before this function’s return value is no longer clamped.

§Parameters

  • stream: the audio stream to query.

§Return value

Returns the number of converted/resampled bytes available or -1 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