目次 - API(機能別) - 再生と録音 - SDL_ClearQueuedAudio

SDL_ClearQueuedAudio

ハードウェアへの送信を待つキューの全ての音声データを消去する

構文

void SDL_ClearQueuedAudio(SDL_AudioDeviceID dev)

引数

dev音声キューを消去するデバイスのID

詳細

この関数を呼び出すとすぐにSDL_GetQueuedAudioSize()の戻り値は0になり, あらたに音声をキューに入れない限り無音になる.

この関数は既にハードウェアに送られた音声データの再生は停止しない. よって呼びだしの後も短い音声の断片が再生されることが予想される. この関数は, 例えばゲーム中にボリュームを変える場合に再生を待つ音楽を消去したいとき有用である.

アプリケーション提供のコールバック関数が使うデバイスに音声をキューしてはならない. そのようなデバイスに対しては, この関数は常に無効である. コールバック関数を使うか, SDL_QueueAudio()で音声をキューに入れるかのどちらかで, 両方を行ってはならない.

キューを消去する前にSDL_LockAudio()を呼んではならない. この関数の内部でSDLはロックを扱っている.

この関数は常に成功するため, 戻り値はvoidである.

バージョン

SDL 2.0.4以降

関連項目(関数)

SDL_GetQueuedAudioSize
SDL_QueueAudio
SDL_DequeueAudio

SDL Wikiへのリンク

SDL_ClearQueuedAudio - SDL Wiki