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

SDL_SetAudioStreamGain

オーディオストリームのゲインを設定する

ヘッダ

SDL3/SDL_audio.h

構文

bool SDL_SetAudioStreamGain(SDL_AudioStream *stream, float gain);

引数

SDL_AudioStream *streamゲインを設定するオーディオストリーム
floatgainゲイン. 1.0fのとき変更なし. 0.0fのとき無音

戻り値

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

詳細

ストリームのゲインはボリュームのことで, 値が大きいほど出力が大きく, 0は無音である.

オーディオストリームのゲインのデフォルトは1.0f(出力を変更しない)である.

これはSDL_GetAudioStreamDataの間に適用され, 継続して様々な効果が生じる.

スレッドセーフ

この関数はストリーム固有のミューテックスが行われている限りどのスレッドからも安全に呼べる.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_SetAudioStreamGain - SDL Wiki