Win32 API 日本語リファレンス
ホームMedia.Audio › ISpatialAudioClient2

ISpatialAudioClient2

COM
IIDcaabe452-a66a-4bee-a93e-e320463f6a53継承元ISpatialAudioClient自前メソッド開始 vtbl11

公式ドキュメント

ISpatialAudioClient2 インターフェイスは ISpatialAudioClient を継承し、大容量オーディオバッファーのオフロードのサポートを照会するメソッドを追加します。

解説(Remarks)

オーディオオフロードを使用すると、アプリはオーディオデバイスドライバーに大容量のオーディオバッファー(通常は 1~2 秒分)を送信できます。オフロードを使用しない場合、一般的なオーディオバッファーには 10ms 分のデータしか含まれないため、追加のオーディオデータを供給するためにアプリは 1 秒あたり約 100 回起床する必要があります。オフロードされた大容量バッファーを使用すると、特に画面をオフにした状態でユーザーがオーディオを聴取するシナリオにおいて、バッテリーを節約できます。

この機能を使用するには、オーディオデバイスのドライバーがオフロードをサポートしている必要があります。サポートの有無は IsOffloadCapable を呼び出して照会します。オフロードでサポートされるオーディオフレームの最大数は GetMaxFrameCountForCategory を呼び出して確認します。

ISpatialAudioClient2 は Windows 11(Windows ビルド 22000)で導入されたため、このインターフェイスを含まない古いバージョンの Windows 上で実行される場合に対応できるようにコードを記述する必要があります。次の例は、ISpatialAudioClient に対して QueryInterface を呼び出して ISpatialAudioClient2 のインスタンスの取得を試み、取得したインターフェイスが null でないことを確認してからそのメソッドを呼び出す方法を示しています。

HRESULT hr;
Microsoft::WRL::ComPtr<IMMDeviceEnumerator> deviceEnum;
Microsoft::WRL::ComPtr<IMMDevice> defaultDevice;

hr = CoCreateInstance(__uuidof(MMDeviceEnumerator), nullptr, CLSCTX_ALL, __uuidof(IMMDeviceEnumerator), (void**)&deviceEnum);
hr = deviceEnum->GetDefaultAudioEndpoint(EDataFlow::eRender, eMultimedia, &defaultDevice);

Microsoft::WRL::ComPtr<ISpatialAudioClient> spatialAudioClient;
hr = defaultDevice->Activate(__uuidof(ISpatialAudioClient), CLSCTX_INPROC_SERVER, nullptr, (void**)&spatialAudioClient);

Microsoft::WRL::ComPtr<ISpatialAudioClient2> spatialAudioClient2;
hr = spatialAudioClient->QueryInterface(__uuidof(ISpatialAudioClient2), (void**)&spatialAudioClient2);

if (spatialAudioClient2 != nullptr)
{
    BOOL offloadCapable = false;

    // AudioCategory_Media is just for example purposes.
    // Specify the same audio category that you intend specify in the call toISpatialAudioClient::ActivateSpatialAudioStream
    hr = spatialAudioClient2->IsOffloadCapable(AudioCategory_Media, &offloadCapable);
}

IMMDevice にアクセスできない UWP アプリの場合は、ActivateAudioInterfaceAsync を呼び出して ISpatialAudioClient のインスタンスを取得する必要があります。例については、WindowsAudioSession サンプルを参照してください。

メソッド 2

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

vtbl 11 HRESULT IsOffloadCapable(AUDIO_STREAM_CATEGORY category, BOOL* isOffloadCapable)

ISpatialAudioClient2 が作成されたオーディオレンダリングエンドポイントが、ハードウェアオフロードによるオーディオ処理をサポートしているかどうかを照会します。

categoryAUDIO_STREAM_CATEGORYinオフロードサポートを照会するオーディオのカテゴリを指定する AUDIO_STREAM_CATEGORY 列挙体の値。
isOffloadCapableBOOL*outオフロードによるオーディオ処理がオーディオレンダリングエンドポイントでサポートされているかどうかを示すブール値を受け取ります。

戻り値

次の値を含む HRESULT。

Value Description
S_OK 成功
AUDCLNT_E_DEVICE_INVALIDATED オーディオクライアントに関連付けられているオーディオデバイスが無効化されました。
E_INVALIDARG category パラメーターに指定された値が無効です。
vtbl 12 HRESULT GetMaxFrameCountForCategory(AUDIO_STREAM_CATEGORY category, BOOL offloadEnabled, WAVEFORMATEX* objectFormat, DWORD* frameCountPerBuffer)

処理パスあたりでサポートされる最大フレーム数を取得します。

categoryAUDIO_STREAM_CATEGORYinサポートを照会するオーディオストリームの xref:NE:audiosessiontypes._AUDIO_STREAM_CATEGORY
offloadEnabledBOOLin返されるフレーム数を、オーディオオフロードサポートを考慮して計算するかどうかを指定するブール値。このフラグを true に設定すると、ストリームがオフロードモードでアクティブ化された場合に得られるフレーム数が返されます。ただし、このフラグを true に設定しても、オーディオエンドポイントがオフロードモードをサポートしていない場合、このフラグは効果を持ちません。オフロードモードがサポートされているかどうかを確認するには ISpatialAudioClient2::IsOffloadCapable を使用してください。
objectFormatWAVEFORMATEX*inサポートを照会するオーディオストリームのフォーマットを指定する xref:NS:mmeapi.tWAVEFORMATEX 構造体へのポインター。
frameCountPerBufferDWORD*outオーディオデバイスと指定された入力パラメーターに対してサポートされる最大フレーム数を示す INT32 へのポインターを受け取ります。

戻り値

次の値を含む HRESULT。

Value Description
S_OK 成功
AUDCLNT_E_DEVICE_INVALIDATED オーディオクライアントに関連付けられているオーディオデバイスが無効化されました。

解説(Remarks)

このメソッドが返す値は、ソースバッファーの割り当てに使用できます。この値はエンドポイントのケイデンスが変化すると変わります。呼び出し側は、ストリームの作成時に使用するのと同じ AUDIO_STREAM_CATEGORY 値および WAVEFORMATEX 値を指定する必要があります。ストリームを SPATIAL_AUDIO_STREAM_OPTIONS_OFFLOAD フラグを指定して作成する場合は、offloadEnabled パラメーターを TRUE に設定する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISpatialAudioClient2 "{CAABE452-A66A-4BEE-A93E-E320463F6A53}"
#usecom global ISpatialAudioClient2 IID_ISpatialAudioClient2 "{}"
#comfunc global ISpatialAudioClient2_IsOffloadCapable             11 int,var
#comfunc global ISpatialAudioClient2_GetMaxFrameCountForCategory  12 int,int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。