◆ GetDeviceIDFromName()

AKSOUNDENGINE_API AkUInt32 AK::GetDeviceIDFromName ( wchar_t * in_szToken )

Finds an audio endpoint that matches the token in the device name or device ID and returns an ID.
This is a helper function that searches in the device ID (as returned by IMMDevice->GetId) and in the property PKEY_Device_FriendlyName. The token parameter is case-sensitive. If you need to do matching on different conditions, use IMMDeviceEnumerator directly and AK::GetDeviceID.

Note: CoInitialize must have been called for the calling thread. See Microsoft's documentation about CoInitialize for more details.

Returns: The device ID as returned by IMMDevice->GetId, hashed by AK::SoundEngine::GetIDFromName()

Finds an audio endpoint that matches the token in the device name or device ID and returns an ID.
This is a helper function that searches in the device ID (as returned by IMMDevice->GetId) and IMMXboxDevice->GetPnpId() If you need to do matching on different conditions, use IMMXboxDeviceEnumerator directly.

Returns: The device ID as returned by IMMDevice->GetId, hashed by AK::SoundEngine::GetIDFromName()

Finds an audio endpoint that matches the token in the device name or device ID and returns and ID compatible with AddSecondaryOutput.
This is a helper function that searches in the device ID (as returned by IMMDevice->GetId) and IMMXboxDevice->GetPnpId() If you need to do matching on different conditions, use IMMXboxDeviceEnumerator directly.

Returns: An ID to use with AddSecondaryOutput. The ID returned is the device ID as returned by IMMDevice->GetId, hashed by AK::SoundEngine::GetIDFromName()

Wwise SDK

GetDeviceIDFromName

◆ GetDeviceIDFromName()

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.