目次 - SDL 3.0 API(機能別) - 再生と録音 - SDL_PauseAudioDevice

SDL_PauseAudioDevice

オーディオデバイスの再生を一時停止する

ヘッダ

SDL3/SDL_audio.h

構文

bool SDL_PauseAudioDevice(SDL_AudioDeviceID devid);

引数

SDL_AudioDeviceIDdevidSDL_OpenAudioDevice()でオープンしたデバイス

戻り値

(bool) 成功のとき真, 失敗のとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.

この関数は指定したデバイスの処理を一時停止させる. バインドされた全てのストリームの処理は停止し, 音声は生成されなくなる. あるデバイスを一時停止しても, 他の一時停止中でないデバイスは動作し続ける.

SDL2とは異なり, アプリケーションは再生・録音の前にオーディオデバイスとオーディオストリームをバインドさせる必要があるため, オーディオデバイスは一時停止中ではない状態から始まる. 一時停止中のデバイスを一時停止させようとすると, 正しく何も行われない.

デバイスを一時停止されることは, 全てのオーディオストリームのバインドを解除せずに停止させたいとき便利である. これはゲームを一時停止したときや, ロード中などによいかもしれない.

物理デバイスは一時停止も一時停止解除もできない. SDL_OpenAudioDevice()で生成された論理デバイスのみ可能である.

スレッドセーフ

この関数はどのスレッドからも安全に呼べる.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_PauseAudioDevice - SDL Wiki