XInputGetAudioDeviceIds
Note
This function is not yet implemented.
Retrieves the IDs of the audio render and capture devices of the headset connected to the specified controller.
Syntax
DWORD XInputGetAudioDeviceIds(
DWORD dwUserIndex,
LPWSTR pRenderDeviceId,
UINT * pRenderCount,
LPWSTR pCaptureDeviceId,
UINT * pCaptureCount
)
Parameters
dwUserIndex _In_
Type: DWORD
Index of the gamer associated with the headset; a value in the range of 0 to XUSER_MAX_COUNT - 1.
pRenderDeviceId _Out_writes_opt_z_(*pRenderCount)
Type: LPWSTR
ID of the audio render device; that is, the device that plays audio output, such as headphones.
pRenderCount _Inout_opt_
Type: UINT*
Size, in wide characters, of the string buffer for the ID of the render device.
pCaptureDeviceId _Out_writes_opt_z_(*pCaptureCount)
Type: LPWSTR
ID of the audio capture device; that is, the device that captures audio input, such as a microphone.
pCaptureCount _Inout_opt_
Type: UINT*
Size, in wide characters, of the string buffer for the ID of the capture device.
Return value
Type: DWORD
If the function successfully retrieves the device IDs for render and capture, the return code is ERROR_SUCCESS.
If no headset is connected to the controller, the function also returns ERROR_SUCCESS, with NULL as the value for pRenderDeviceId and pCaptureDeviceId.
If the controller port device is not physically connected, the function returns ERROR_DEVICE_NOT_CONNECTED.
If the function fails, it returns a Win32 error code.
Remarks
Callers must allocate the memory for the buffers passed to this function. The resulting strings can be of arbitrary length.
For more information, see The XInputOnGameInput wrapper.
Requirements
Header: XInputOnGameInput.h
Library: xgameruntime.lib
Supported platforms: Xbox One family consoles and Xbox Series consoles