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.
AK_NotCompatible
if no device of this type are supported on the current platform
AK_Fail
in case of system device manager failure (OS related)
- 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 length of the out_deviceDescriptions array. Out: If out_deviceDescriptions is not-null, this will be set to the number of entries in out_deviceDescriptions that was populated. If out_deviceDescriptions is null, this will be set to the number of devices that may be available. |
out_deviceDescriptions | The output array of device descriptions. |