IXAudio2Voice::SetVolume メソッド
ボイスの全体のボリューム レベルを設定します。
構文
HRESULT SetVolume( float Volume, UINT32 OperationSet = XAUDIO2_COMMIT_NOW)
パラメーター
- Volume
[in] 使用する全体のボリューム レベルです。ボリューム レベルの詳細については、「備考」を参照してください。 - OperationSet
[in] この呼び出しを遅延バッチの一部として指定します。詳細については、「XAudio2 操作セット」の概要を参照してください。
戻り値
正常に実行された場合は S_OK を返し、失敗した場合はエラー コードを返します。エラー コードの説明については、「XAudio2 エラー コード」を参照してください。
解説
SetVolume は、ボイスのマスター入力ボリューム レベルを制御します。マスター ボリューム レベルは、ボイスのタイプに応じて異なる時点で適用されます。サブミックス ボイスとマスター ボイスの場合、ボリューム レベルは、ボイスの組み込みのフィルターとエフェクト チェーンが適用される直前に適用されます。ソース ボイスの場合、マスター ボリューム レベルは、ボイスのフィルターとエフェクト チェーンが適用された後に適用されます。
ボリューム レベルは、-XAUDIO2_MAX_VOLUME_LEVEL ～ XAUDIO2_MAX_VOLUME_LEVEL (-224 ～ 224) の浮動小数点振幅逓倍として表現され、最大ゲインは 144.5 dB です。ボリューム レベル 1.0 は減衰またはゲインがないことを意味し、0 は無音を意味します。負のレベルは、オーディオのフェーズを反転させるために使用できます。ボリューム コントロールの詳細については、「XAudio2 のボリュームおよびピッチ コントロール」を参照してください。
注意
IXAudio2Voice::GetVolume は、常に、IXAudio2Voice::SetVolume によって最後に設定されたボリュームを返します。ただし、この値は実際にはまだ適用されていない可能性があります。この値は、IXAudio2Voice::SetVolume 呼び出しの後 (または、IXAudio2Voice::SetVolume が遅延操作 ID を使用して呼び出された場合は、対応する IXAudio2::CommitChanges 呼び出しの後)、次にオーディオ エンジンが実行されたときに初めて適用されます。
要件
ヘッダー: xaudio2.h で宣言されています。