|
WASAPI.DeviceLatencyGet method |
  
|
|
WASAPI.DeviceLatencyGet method |
|
Remarks
Obtains the latency, expressed in milliseconds, of the given WASAPI device. In order to correctly check the latency, the WASAPI device must have been previously started through one between the WASAPI.DeviceStartExcusive and WASAPI.DeviceStartShared methods.
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 flow through WASAPI tutorial.
Syntax
[Visual Basic] control.WASAPI.DeviceLatencyGet ( nDeviceIndex as Integer, nDeviceType as enumWasapiDeviceTypes, nLatencyMs as Long ) as enumErrorCodes |
[C++] short control.WASAPI.DeviceLatencyGet ( short nDeviceIndex, short nDeviceType, long *nLatencyMs ); |
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.DeviceGetCount method. |
||||||||||||
nDeviceType |
The type of device. Supported values are the following:
|
||||||||||||
nLatencyMs |
Reference that, on return from the method call, will contain the latency, expressed in milliseconds, of the given WASAPI device. |
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 |
