COM Objects > WASAPI object > Methods > WASAPI.DeviceStop method

Remarks

Stops a WASAPI device previously started through the WASAPI.DeviceStartExcusive or WASAPI.DeviceStartShared methods. You can know if a WASAPI device is already started through the WASAPI .DeviceIsStarted method.

This method will affect any other instance of the control inside the application. If the control should be used in conjunction with the Active Sound Recorder control, this one would be affected too.

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.DeviceStop (

nDeviceIndex as Integer,

nDeviceType as enumWasapiDeviceTypes,

bReset as enumBoolean

) as enumErrorCodes

[C++]

short control.WASAPI.DeviceStop (

short nDeviceIndex,

short nDeviceType,

short bReset

);

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.

bReset

Boolean value indicating if the device buffer must be flushed.

Supported values are the following:

Mnemonic constant	Value	Meaning
BOOL_FALSE	0	The device buffer must not be reset
BOOL_TRUE	1	The device buffer must be reset

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