Copyright © 2011-2018 MultiMedia Soft

WASAPI.RenderDeviceGetDesc method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the friendly description of the requested WASAPI device. This method is useful when you have to fill a combo box with the friendly names of available WASAPI devices.

The total number of available WASAPI devices can be obtained using the WASAPI.RenderDeviceGetCount method.

 

This method is only intended for usage with Windows Vista and later versions.

For further details about WASAPI see the WASAPIMan class and the How to manage audio playback through WASAPI tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function RenderDeviceGetDesc (

nDeviceIndex as Int32

) as String


 

[C#]

public string RenderDeviceGetDesc (

Int32 nDeviceIndex

);


 

[C++]

public: string RenderDeviceGetDesc (

Int32 nDeviceIndex

);


 

 

Parameter

Description

 

 

nDeviceIndex

Number representing the zero-based index of the WASAPI device whose friendly name must be retrieved. The total number of available WASAPI devices can be obtained using the WASAPI.RenderDeviceGetCount method.

 

 

Return value

 

Value

Meaning

 

 

Empty string

The value of the nDeviceIndex parameter was out of range. Use the value returned by the WASAPI.RenderDeviceGetCount method in order to know how many WASAPI devices are currently installed inside the system.

Valid string

The string containing the friendly description of the requested device.