Table of Contents

const wchar_t* __cdecl AK::GetWindowsDeviceName ( AkInt32  index,
AkUInt32 out_uDeviceID,
AkAudioDeviceState  uDeviceStateMask = AkDeviceState_All  
)

Get the user-friendly name for the specified device. Call repeatedly with index starting at 0 and increasing to get all available devices, including disabled and unplugged devices, until the returned string is null. You can also get the default device information by specifying index=-1. The default device is the one with a green checkmark in the Audio Playback Device panel in Windows. The returned out_uDeviceID parameter is the Device ID to use with Wwise. Use it to specify the main device in AkPlatformInitSettings.idAudioDevice or in AK::SoundEngine::AddSecondaryOutput.

Note:
CoInitialize must have been called for the calling thread. See Microsoft's documentation about CoInitialize for more details.
Returns:
The name of the device at the "index" specified. The pointer is valid until the next call to GetWindowsDeviceName.
Parameters:
index  Index of the device in the array. -1 to get information on the default device.
out_uDeviceID  Device ID for Wwise. This is the same as what is returned from AK::GetDeviceID and AK::GetDeviceIDFromName. Use it to specify the main device in AkPlatformInitSettings.idAudioDevice or in AK::SoundEngine::AddSecondaryOutput.
uDeviceStateMask  Optional bitmask used to filter the device based on their state.