WASAPI.RenderDeviceSharedFormatGet method |
|
Remarks
Obtains the audio format for shared mode currently selected inside the Windows control panel for the given WASAPI device.
This method is only intended for usage with Windows Vista and later versions.
For further details about the use of WASAPI see the WASAPI object and the How to manage audio playback through WASAPI tutorial.
Syntax
[Visual Basic] control.WASAPI.RenderDeviceSharedFormatGet ( nDeviceIndex as Integer, nFrequency as Long, nChannels as Integer ) as enumErrorCodes |
[C++] short control.WASAPI.RenderDeviceSharedFormatGet ( short nDeviceIndex, long *nFrequency, short *nChannels ); |
Parameter |
Description |
|
|
nDeviceIndex |
Number representing the zero-based index of the WASAPI device of interest. The total number of available WASAPI devices can be obtained using the WASAPI.RenderDeviceGetCount method. |
nFrequency |
Reference that, on return from the method call, will contain the sample rate |
nChannels |
Reference that, on return from the method call, will contain the number of channels |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |