Table of Contents

Wwise SDK 2019.2.3

◆ GetDeviceList() [1/2]

AKSOUNDENGINE_API AKRESULT __cdecl AK::SoundEngine::GetDeviceList ( AkUInt32  in_ulCompanyID,
AkUInt32  in_ulPluginID,
AkUInt32 &  io_maxNumDevices,
AkDeviceDescription out_deviceDescriptions 
)

Returns a listing of the current devices for a given sink plug-in, including Device ID, friendly name, and state. This call is only valid for sink plug-ins that support device enumeration. Prerequisites: the plug-in must have been initialized by loading the init bank or by calling AK::SoundEngine::RegisterPlugin.

Returns
AK_NotImplemented if the sink plug-in does not implement device enumeration AK_PluginNotRegistered if the plug-in has not been registered yet either by loading the init bank or by calling RegisterPluginDLL.
Parameters
in_ulCompanyID Company identifier (as declared in the plug-in description XML file)
in_ulPluginID Plug-in identifier (as declared in the plug-in description XML file)
io_maxNumDevices In: The maximum number of devices to write to out_deviceDescriptions. Out: Returns the number of devices that were written to out_deviceDescriptions, or if out_deviceDescriptions is NULL, how many devices would have been written.
out_deviceDescriptions The output array of device descriptions. If NULL, no devices will be written out.