Copyright © 2006-2018 MultiMedia Soft

WASAPI.DeviceLatencyGet method

Previous pageReturn to chapter overviewNext page

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 WASAPIMan class and the How to manage audio flow through WASAPI tutorial

 

 

Syntax

 

[Visual Basic]

Public Function DeviceLatencyGet (

nDeviceIndex as Int32,

nDeviceType as enumWasapiDeviceTypes,

ByRef nLatencyMs as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes DeviceLatencyGet (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType,

ref Int32 nLatencyMs

);


 

[C++]

public: enumErrorCodes DeviceLatencyGet (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType,

Int32 __gc  *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:

Mnemonic Value

Value

Meaning

WASAPI_DEVICE_TYPE_RENDER

0

Audio rendering device.

WASAPI_DEVICE_TYPE_CAPTURE

1

Audio capture device.

WASAPI_DEVICE_TYPE_LOOPBACK

2

Audio loopback device.

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 (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.