.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_LockAudioStream:
.\"   https://wiki.libsdl.org/SDL_LockAudioStream
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_LockAudioStream
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_LockAudioStream 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_LockAudioStream \- Lock an audio stream for serialized access\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_LockAudioStream(SDL_AudioStream *stream);
.fi
.SH DESCRIPTION
Each 
.BR SDL_AudioStream
 has an internal mutex it uses to
protect its data structures from threading conflicts\[char46] This function allows
an app to lock that mutex, which could be useful if registering callbacks
on this stream\[char46]

One does not need to lock a stream to use in it most cases, as the stream
manages this lock internally\[char46] 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\[char46]

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

.SH FUNCTION PARAMETERS
.TP
.I stream
The audio stream to lock\[char46]
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH THREAD SAFETY
It is safe to call this function from any thread\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_UnlockAudioStream (3)