IAudioClient2

COM

IID726778cd-f60a-4eda-82de-e47610cd78aa継承元IAudioClient自前メソッド開始 vtbl15

公式ドキュメント

IAudioClient2 インターフェイスは IAudioClient インターフェイスから派生したもので、Windows Audio Session API (WASAPI) のオーディオクライアントが次の操作を行えるようにする一連の追加メソッドを備えています。すなわち、オフロードの利用を選択する、ストリームのプロパティを照会する、オフロードを処理するハードウェアから情報を取得する、といった操作です。基盤となるエンドポイントがハードウェアオーディオエンジンをサポートし、そのエンドポイントがオーディオシステムによって列挙および検出済みであり、かつエンドポイント上に利用可能なオフロードピンインスタンスがまだ残っている場合、オーディオクライアントはオフロードストリームの作成に成功できます。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 15 HRESULT IsOffloadCapable(AUDIO_STREAM_CATEGORY Category, BOOL* pbOffloadCapable)

IsOffloadCapable メソッドは、ストリームが作成されるエンドポイントがオフロードされたオーディオストリームをサポートできるかどうかについての情報を取得します。

Category	AUDIO_STREAM_CATEGORY	in	オーディオストリームのカテゴリを指定する列挙型です。
pbOffloadCapable	BOOL*	out	Boolean 値へのポインターです。TRUE はエンドポイントがオフロードに対応していることを示します。FALSE はエンドポイントがオフロードに対応していないことを示します。

戻り値

IsOffloadCapable メソッドは、正常に完了したことを示すために S_OK を返します。それ以外の場合は、適切なエラーコードを返します。

vtbl 16 HRESULT SetClientProperties(AudioClientProperties* pProperties)

AudioClientProperties 構造体に値を設定することで、オーディオストリームのプロパティを設定します。

pProperties

AudioClientProperties*

AudioClientProperties 構造体へのポインターです。

戻り値

SetClientProperties メソッドは、正常に完了したことを示すために S_OK を返します。それ以外の場合は、適切なエラーコードを返します。

解説(Remarks)

Windows 10 以降では、ハードウェアオフロードされたオーディオストリームはイベント駆動でなければなりません。つまり、IAudioClient2::SetClientProperties を呼び出し、AudioClientProperties の bIsOffload パラメーターを TRUE に設定する場合は、IAudioClient::Initialize の StreamFlags パラメーターに AUDCLNT_STREAMFLAGS_EVENTCALLBACK フラグを指定する必要があります。

vtbl 17 HRESULT GetBufferSizeLimits(WAVEFORMATEX* pFormat, BOOL bEventDriven, LONGLONG* phnsMinBufferDuration, LONGLONG* phnsMaxBufferDuration)

GetBufferSizeLimits メソッドは、ハードウェアオーディオエンジンのバッファーサイズの上限と下限を 100 ナノ秒単位で返します。

pFormat	WAVEFORMATEX*	in	バッファーサイズの上限と下限を照会する対象フォーマットへのポインターです。
bEventDriven	BOOL	in	ストリームをイベント駆動にできるかどうかを示す Boolean 値です。
phnsMinBufferDuration	LONGLONG*	out	基盤となるハードウェアオーディオエンジンが、pFormat パラメーターで指定されたフォーマットで頻繁な音声の乱れ (グリッチ) を生じることなく動作するために必要な、最小バッファーサイズ (100 ナノ秒単位) へのポインターを返します。
phnsMaxBufferDuration	LONGLONG*	out	基盤となるハードウェアオーディオエンジンが、pFormat パラメーターで指定されたフォーマットに対してサポートできる、最大バッファーサイズ (100 ナノ秒単位) へのポインターを返します。

戻り値

GetBufferSizeLimits メソッドは、正常に完了したことを示すために S_OK を返します。それ以外の場合は、適切なエラーコードを返します。たとえば、デバイスが取り外された状態でこのメソッドが呼び出された場合は、AUDCLNT_E_DEVICE_INVALIDATED を返すことがあります。

解説(Remarks)

GetBufferSizeLimits メソッドはデバイス側のメソッドであり、事前のオーディオストリームの初期化を必要としません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IAudioClient2 "{726778CD-F60A-4EDA-82DE-E47610CD78AA}"
#usecom global IAudioClient2 IID_IAudioClient2 "{}"
#comfunc global IAudioClient2_IsOffloadCapable     15 int,var
#comfunc global IAudioClient2_SetClientProperties  16 var
#comfunc global IAudioClient2_GetBufferSizeLimits  17 var,int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IAudioClient2 "{726778CD-F60A-4EDA-82DE-E47610CD78AA}"
#usecom global IAudioClient2 IID_IAudioClient2 "{}"
#comfunc global IAudioClient2_IsOffloadCapable     15 int,sptr
#comfunc global IAudioClient2_SetClientProperties  16 sptr
#comfunc global IAudioClient2_GetBufferSizeLimits  17 sptr,int,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。