XInputGetAudioDeviceIds 関数 (xinput.h)

指定したコントローラーに接続されているヘッドセットに関連付けられているサウンド レンダリングとサウンド キャプチャオーディオ デバイス ID を取得します。

構文

DWORD XInputGetAudioDeviceIds(
  [in]                DWORD  dwUserIndex,
  [out, optional]     LPWSTR pRenderDeviceId,
  [in, out, optional] UINT   *pRenderCount,
  [out, optional]     LPWSTR pCaptureDeviceId,
  [in, out, optional] UINT   *pCaptureCount
);

パラメーター

[in] dwUserIndex

デバイスに関連付けられているゲーマーのインデックス。

[out, optional] pRenderDeviceId

レンダリング (スピーカー) 用の Windows Core オーディオ デバイス ID 文字列。

[in, out, optional] pRenderCount

レンダー デバイス ID 文字列バッファーのサイズ (ワイド文字)。

[out, optional] pCaptureDeviceId

キャプチャ用の Windows Core オーディオ デバイス ID 文字列 (マイク)。

[in, out, optional] pCaptureCount

キャプチャ デバイス ID 文字列バッファーのサイズ (ワイド文字)。

戻り値

関数がレンダリングおよびキャプチャ用のデバイス ID を正常に取得した場合、リターン コードは ERROR_SUCCESS。

コントローラーに接続されているヘッドセットがない場合、関数は pRenderDeviceId と pCaptureDeviceId の値として NULL のERROR_SUCCESSも取得します。

コントローラー ポート デバイスが物理的に接続されていない場合、関数は ERROR_DEVICE_NOT_CONNECTEDを返します。

関数が失敗すると、有効な Win32 エラー コードが返されます。

解説

呼び出し元は、 XInputGetAudioDeviceIds に渡されるバッファーのメモリを割り当てる必要があります。 結果の文字列は任意の長さにできます。

プラットフォームの要件

Windows 8 (XInput 1.4)

要件

対象プラットフォーム	Windows
ヘッダー	xinput.h
Library	Xinput.lib
[DLL]	Xinput1_4.dll

関連項目

コア オーディオ API

XInput 関数

XInputGetDSoundAudioDeviceGuids