bool SDL_LockAudioStream(SDL_AudioStream *stream);
| SDL_AudioStream * | stream | ロックするオーディオストリーム |
(bool) 成功のとき真, 失敗のとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.
各SDL_AudioStreamには内部にミューテックスがあり, それを使用してデータ構造を他のスレッドとの衝突から保護している. この関数は, ストリームにコールバックを登録したとき有用なため, アプリケーションがそのミューテックスでロックすることを可能にする.
ストリームが内部でこのロックを管理しているため, ほとんどの場合, この関数を使用してロックする必要はない. しかし, このロックはどのスレッドからもいつでも実行される可能性のあるコールバック中に行われるため, アプリケーションがコールバックと共有するデータを保護する必要がある場合は, ストリームをロックするとロック中はコールバックが実行されていないことを保証できる.
この関数は内部ロックのための単なるSDL_LockMutexのラッパーであり, 全ての特性は同じ(再帰的なロックが認められているなど)である.
この関数はどのスレッドからも安全に呼べる.