logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_LockAudioStream - Lock an audio stream for serialized access.

Availability

       This function is available since SDL 3.2.0.

Description

       Each SDL_AudioStream
        has  an  internal  mutex  it uses to protect its data structures from threading conflicts. This function
       allows an app to lock that mutex, which could be useful if registering callbacks on this stream.

       One does not need to lock a stream to use in it most cases, as the stream manages this  lock  internally.
       However,  this  lock is held during callbacks, which may run from arbitrary threads at any time, so if an
       app needs to protect shared data during those callbacks, locking the stream guarantees that the  callback
       is not running while the lock is held.

       As this is just a wrapper over SDL_LockMutex
        for an internal lock; it has all the same attributes (recursive locks are allowed, etc).

Function Parameters

stream the audio stream to lock.

Header File

       Defined in SDL3/SDL_audio.h

Name

       SDL_LockAudioStream - Lock an audio stream for serialized access.

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

See Also

(3), SDL_UnlockAudioStream(3)

Simple Directmedia Layer                           SDL 3.2.10                             SDL_LockAudioStream(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_LockAudioStream(SDL_AudioStream*stream);

Thread Safety

       It is safe to call this function from any thread.

See Also