XAudio2 API

XAudio2 API テクノロジの概要。

XAudio2 API を開発するには、次のヘッダーが必要です。

• hrtfapoapi.h
• x3daudio.h
• xapo.h
• xapobase.h
• xapofx.h
• xaudio2.h
• xaudio2fx.h

このテクノロジのプログラミング ガイダンスについては、次を参照してください。

• XAudio2 API

クラス

CXAPOBase IXAPO インターフェイスの既定の実装。
CXAPOParametersBase IXAPOParameters インターフェイスの既定の実装。

列挙

HrtfDirectivityType いくつかの株価の指向性パターンのいずれかを示します。
HrtfDistanceDecayType サウンドに適用される距離ベースの減衰の種類を示します。
HrtfEnvironment いくつかのストック環境の種類のいずれかを示します。
XAPO_BUFFER_FLAGS ストリーム バッファーの内容について説明します。
XAUDIO2_FILTER_TYPE フィルターの種類を示します。

関数

AddRef XAudio2 オブジェクトへの参照を追加します。
BeginProcess 現在のプロセス パラメーターを返します。
CalcInputFrames 指定された出力フレーム数を生成するために必要な入力フレームの数を返します。
CalcOutputFrames 指定した数の入力フレームから生成される出力フレームの数を返します。
CommitChanges 特定の識別子でタグ付けされた一連の操作をアトミックに適用します。
CreateFX 要求された XAPOFX 効果のインスタンスを作成します。
CreateHrtfApo ヘッド関連転送関数 (HRTF) 処理用の IXAPO インターフェイスのインスタンスを作成します。
CreateMasteringVoice マスタリング音声を作成して構成します。
CreateSourceVoice ソース音声を作成して構成します。
CreateSubmixVoice サブミックス音声を作成して構成します。
CXAPOBase CXAPOBase クラスのインスタンスを作成します。
CXAPOParametersBase CXAPOParametersBase クラスのインスタンスを作成します。
DestroyVoice 音声を破棄します。 必要に応じて、音声を停止し、XAudio2 グラフから削除します。
DisableEffect 音声のエフェクト チェーン内の特定の位置での効果を無効にします。
不連続 現在キューにある最後のバッファーの後にバッファーが追加されていないことを XAudio2 音声に通知します。
EnableEffect 音声のエフェクト チェーン内の特定の位置で効果を有効にします。
EndProcess XAPO が現在のプロセス パラメーターへのアクセスを完了したことを CXAPOParametersBase に通知します。
ExitLoop 現在のループ領域の末尾に達すると、音声のループを停止します。
FlushSourceBuffers 保留中のすべてのオーディオ バッファーを音声キューから削除します。
GetChannelMask この音声のチャネル マスクを返します。
GetChannelVolumes 音声の音量レベルをチャネルごとに返します。
GetEffectParameters 音声のエフェクト チェーン内の特定のエフェクトの現在のエフェクト固有のパラメーターを返します。
GetEffectState 音声のエフェクト チェーン内の指定した位置にある効果の実行状態を返します。
GetFilterParameters 音声のフィルター パラメーターを取得します。
GetFrequencyRatio 音声の周波数調整比を返します。
GetOutputFilterParameters この音声の送信のいずれかからフィルター パラメーターを返します。
GetOutputMatrix 音声の最終的な出力の各チャネルのボリューム レベルを取得します。 これらのチャネルは、指定された宛先音声の入力チャネルにマップされます。
GetParameters 効果固有のパラメーターの現在の値を取得します。
GetPerformanceData 使用可能なメモリや CPU 使用率など、現在のリソース使用量の詳細を返します。
GetRegistrationProperties XAPO の登録プロパティを返します。
GetRegistrationPropertiesInternal XAPO が作成された登録プロパティを含むXAPO_REGISTRATION_PROPERTIES構造体へのポインターを返します。
GetState 音声の現在のカーソル位置データを返します。
GetVoiceDetails 音声の作成フラグ、入力チャネル、サンプル レートに関する情報を返します。
GetVolume 音声の現在の全体的な音量レベルを取得します。
初期化する 効果固有の初期化を実行します。
IsInputFormatSupported 特定の出力形式に対して特定の入力形式がサポートされているかどうかを照会します。
IsLocked XAPO がロックされているかどうかを照会します。
IsOutputFormatSupported 特定の出力形式が特定の入力形式でサポートされているかどうかを照会します。
LockForProcess XAudio2 によって呼び出され、XAPO の入出力構成をロックし、Process がリアルタイム スレッドで呼び出される前に最終的な初期化を実行できるようにします。
OnBufferEnd 音声がバッファーの処理を終了したときに呼び出されます。
OnBufferStart 音声が新しいオーディオ バッファーの処理を開始しようとしているときに呼び出されます。
OnCriticalError XAudio2 を閉じて再起動する必要がある重大なシステム エラーが発生した場合に呼び出されます。
OnLoopEnd 音声がループの終了位置に達したときに呼び出されます。
OnProcessingPassEnd オーディオ処理パスが終了した直後に XAudio2 によって呼び出されます。
OnProcessingPassStart オーディオ処理パスが開始される直前に XAudio2 によって呼び出されます。
OnSetParameters ユーザー定義パラメーターの検証を可能にするために、IXAPOParameters::SetParameters によって呼び出されます。
OnStreamEnd 音声が連続したオーディオ ストリームの再生を完了した直後に呼び出されます。
OnVoiceError 音声処理中に重大なエラーが発生したときに呼び出されます。
OnVoiceProcessingPassEnd 音声の処理パスが終了した直後に呼び出されます。
OnVoiceProcessingPassStart XAudio2 が音声のバッファー キューからデータを読み取る直前に、各音声の各処理パス中に呼び出されます。
ParametersChanged 最後の処理パス以降に IXAPOParameters::SetParameters が呼び出されたかどうかを示します。
Process 指定された入出力バッファーで XAPO のデジタル信号処理 (DSP) コードを実行します。
ProcessThru XAPO がスルー処理で無効になっている場合、IXAPO::P rocess 実装によって呼び出されます。
QueryInterface XAudio2 オブジェクトの特定の COM インターフェイスに対するクエリ。
RegisterForCallbacks XAudio2 エンジン コールバック リストに IXAudio2EngineCallback ポインターを追加します。
リリース XAudio2 オブジェクトへの参照を解放します。
リセット フレーム履歴に依存する変数をリセットします。
ReverbConvertI3DL2ToNative I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) パラメーターをネイティブ XAudio2 パラメーターに変換するインライン関数。
SetChannelVolumes チャネルごとに音声の音量レベルを設定します。
SetDebugConfiguration XAudio2 のグローバル デバッグ ログ オプションを変更します。
SetEffectChain 音声のエフェクト チェーンを置き換えます。
SetEffectParameters 音声のエフェクト チェーン内の特定の効果のパラメーターを設定します。
SetEnvironment シミュレートする音響環境を選択します。
SetFilterParameters 音声のフィルター パラメーターを設定します。
SetFrequencyRatio 音声の周波数調整率を設定します。
SetOutputFilterParameters この音声の送信の 1 つにフィルター パラメーターを設定します。
SetOutputMatrix 音声の最終出力の各チャンネルの音量レベルを設定します。 これらのチャネルは、指定された宛先音声の入力チャネルにマップされます。
SetOutputVoices 音声の出力を受信するサブミックスまたはマスタリング音声の新しいセットを指定します。
SetParameters 効果固有のパラメーターを設定します。
SetSourceGain 現在のソース位置のカスタムダイレクトパスゲイン値を設定します。 HrtfDistanceDecayType カスタム減衰タイプで再生されたサウンドに対してのみ有効です。
SetSourceOrientation リスナーの座標系に対して、ソースの向きの回転行列を設定します。
SetSourcePosition リスナーを基準としたサウンドの位置を設定します。
SetSourceSampleRate 音声の作成時に指定したレートとは異なるサンプル レートでソース データを使用するように音声を再構成します。
SetVolume 音声の全体的な音量レベルを設定します。
Start 音声による音声の消費と処理を開始します。 接続されているサブミックスまたはマスタリング音声、または出力デバイスに結果を配信します。
StartEngine オーディオ処理スレッドを開始します。
Stop 現在の音声による音声の消費を停止します。
StopEngine オーディオ処理スレッドを停止します。
SubmitSourceBuffer 音声キューに新しいオーディオ バッファーを追加します。
UnlockForProcess LockForProcess メソッドで割り当てられた変数の割り当てを解除します。
UnregisterForCallbacks XAudio2 エンジン コールバック リストから IXAudio2EngineCallback ポインターを削除します。
ValidateFormatDefault オーディオ形式がサポートされている既定の範囲内にあることを確認します。
ValidateFormatPair 入力と出力の形式のペア構成が XAPO でサポートされていることを確認します。
X3DAudioCalculate 3D パラメータに関する DSP 設定を計算します。
X3DAudioInitialize すべてのグローバル 3D オーディオ定数を設定します。
XAPOAlloc 後でアプリケーションに返される任意のサイズの構造体を割り当てる必要がある IXAPO メソッドによって使用されるメモリ割り当てマクロ。
XAPOFree XAPOAlloc マクロで割り当てられたメモリを解放するために使用されるマクロ。
XAudio2AmplitudeRatioToDecibels 振幅比値をデシベル値に変換するインライン関数。
XAudio2Create 新しい XAudio2 オブジェクトを作成し、その IXAudio2 インターフェイスへのポインターを返します。
XAudio2CreateReverb 新しいリバーブ オーディオ処理オブジェクト (APO) を作成し、そのオブジェクトへのポインターを返します。
XAudio2CreateVolumeMeter 新しいボリューム メーター オーディオ処理オブジェクト (APO) を作成し、そのオブジェクトへのポインターを返します。
XAudio2CutoffFrequencyToOnePoleCoefficient ヘルツで表されるフィルタカットオフ周波数から、XAUDIO2_FILTER_PARAMETERS構造の Frequency メンバーと共に使用されるフィルタ係数に変換するインライン関数。
XAudio2CutoffFrequencyToRadians ヘルツで表されるフィルタカットオフ周波数から、XAUDIO2_FILTER_PARAMETERS構造体の Frequency メンバーで使用されるラジアン周波数値に変換するインライン関数。
XAudio2DecibelsToAmplitudeRatio デシベル値を振幅比の値に変換するインライン関数。
XAudio2FrequencyRatioToSemitones 周波数比値を半音値に変換するインライン関数。
XAudio2RadiansToCutoffFrequency XAUDIO2_FILTER_PARAMETERSで使用されるラジアン周波数からヘルツの絶対周波数に変換するインライン関数。
XAudio2SemitonesToFrequencyRatio 半音の値を周波数比の値に変換するインライン関数。

インターフェイス

IXAPO XAudio2 エフェクト チェーンで使用されるオーディオ処理オブジェクトのインターフェイス。
IXAPOHrtfParameters ヘッド関連伝達関数 (HRTF) をサウンドに適用する方法を制御するパラメーターを設定するために使用されるインターフェイス。
IXAPOParameters XAPO で効果固有のパラメーターを使用できるようにする省略可能なインターフェイス。
IXAudio2 IXAudio2 は、すべてのオーディオ エンジンの状態、オーディオ処理スレッド、音声グラフなどを管理する XAudio2 オブジェクトのインターフェイスです。
IXAudio2EngineCallback IXAudio2EngineCallback インターフェイスには、IXAudio2 エンジンで特定のイベントが発生したときにクライアントに通知するメソッドが含まれています。
IXAudio2MasteringVoice マスタリング音声は、オーディオ出力デバイスを表すために使用されます。
IXAudio2SourceVoice ソース音声を使用して、オーディオ データを XAudio2 処理パイプラインに送信します。
IXAudio2SubmixVoice サブミックス音声は、主にパフォーマンスの向上と効果処理に使用されます。
IXAudio2Voice IXAudio2Voice は、IXAudio2SourceVoice、IXAudio2SubmixVoice、および IXAudio2MasteringVoice の派生元となる基本インターフェイスを表します。 以下に示すメソッドは、すべての音声サブクラスに共通です。
IXAudio2VoiceCallback IXAudio2VoiceCallback インターフェイスには、特定のイベントが特定の IXAudio2SourceVoice で発生したときにクライアントに通知するメソッドが含まれています。

構造

FXECHO_INITDATA FXECHO XAPOFX で使用するための初期化パラメーター。
FXECHO_PARAMETERS FXECHO XAPOFX で使用するパラメーター。
FXEQ_PARAMETERS FXEQ XAPO で使用するパラメーター。
FXMASTERINGLIMITER_PARAMETERS FXMasteringLimiter XAPO で使用するためのパラメーター。
FXREVERB_PARAMETERS FXReverb XAPO で使用するパラメーター。
HrtfApoInit HRTF 空間オーディオの初期化に使用されるパラメーターを指定します。
HrtfDirectivity 基本の指向性パターン記述子。 サウンドに適用される指向性の種類について説明します。
HrtfDirectivityCardioid カーディオイド指向パターンについて説明します。
HrtfDirectivityCone 円錐の指向性について説明します。
HrtfDistanceDecay 距離ベースの減衰動作について説明します。
HrtfOrientation HRTF 指向オブジェクトの向きを示します。
HrtfPosition 右辺座標系を使用して、3D 空間内の位置を表します。
X3DAUDIO_CONE エミッタの向きに対して DSP 動作をスケーリングすることによって、単一チャネルの非 LFE エミッタの方向を指定します。
X3DAUDIO_DISTANCE_CURVE 線形セグメントで構成される明示的な区分曲線を定義し、正規化された距離に対する DSP 動作を直接定義します。
X3DAUDIO_DISTANCE_CURVE_POINT 指定された正規化された距離で DSP 設定を定義します。
X3DAUDIO_DSP_SETTINGS X3DAudioCalculate の呼び出しから結果を受け取ります。
X3DAUDIO_EMITTER 任意の数のサウンド チャネルで使用される単一ポイントまたは複数ポイントの 3D オーディオ ソースを定義します。
X3DAUDIO_LISTENER 3D オーディオ受信のポイントを定義します。
XAPO_LOCKFORPROCESS_PARAMETERS XAPO がロックされている間に一定の状態を維持するストリーム バッファー パラメーターを定義します。 IXAPO::LockForProcess メソッドと共に使用されます。
XAPO_PROCESS_BUFFER_PARAMETERS ある呼び出しから次の呼び出しに変更される可能性があるストリーム バッファー パラメーターを定義します。 Process メソッドと共に使用されます。
XAPO_REGISTRATION_PROPERTIES XAPO の一般的な特性について説明します。 IXAPO::GetRegistrationProperties、CXAPOParametersBase::CXAPOParametersBase、および CXAPOBase::CXAPOBase と共に使用されます。
XAUDIO2_BUFFER IXAudio2SourceVoice::SubmitSourceBuffer で使用されるオーディオ データ バッファーを表します。
XAUDIO2_BUFFER_WMA xWMA データを送信するときに IXAudio2SourceVoice::SubmitSourceBuffer と共に使用されます。
XAUDIO2_DEBUG_CONFIGURATION XAudio2 の新しいグローバル デバッグ構成が含まれています。 SetDebugConfiguration 関数と共に使用されます。
XAUDIO2_EFFECT_CHAIN 効果チェーンを定義します。
XAUDIO2_EFFECT_DESCRIPTOR 効果チェーンで使用する XAPO に関する情報が含まれます。
XAUDIO2_FILTER_PARAMETERS ソース音声のフィルター パラメーターを定義します。
XAUDIO2_PERFORMANCE_DATA パフォーマンス情報が含まれます。 (XAUDIO2_PERFORMANCE_DATA)
XAUDIO2_SEND_DESCRIPTOR 別の音声からの送信のターゲットである宛先音声を定義し、フィルターを使用するかどうかを指定します。
XAUDIO2_VOICE_DETAILS 音声の作成フラグ、入力チャネル、サンプル レートに関する情報が含まれます。
XAUDIO2_VOICE_SENDS 1 つの出力音声からデータを受信する一連の音声を定義します。
XAUDIO2_VOICE_STATE 音声の現在の状態とカーソル位置データを返します。
XAUDIO2FX_REVERB_I3DL2_PARAMETERS ReverbConvertI3DL2ToNative 関数で使用する I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) パラメーターについて説明します。
XAUDIO2FX_REVERB_PARAMETERS リバーブ APO で使用するパラメーターについて説明します。
XAUDIO2FX_VOLUMEMETER_LEVELS ボリューム メーター APO で使用するパラメーターについて説明します。