Copyright © 2005-2018 MultiMedia Soft

WASAPI.DeviceStop method

Previous pageReturn to chapter overviewNext page

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 component inside the application. If the component should be used in conjunction with the Audio Sound Recorder API for .NET and/or Audio Sound Editor API for .NET components, these ones 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 WASAPIMan class and the How to manage audio flow through WASAPI tutorial

 

 

Syntax

 

[Visual Basic]

Public Function DeviceStop (

nDeviceIndex as Int32,

nDeviceType as enumWasapiDeviceTypes,

bReset as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes DeviceStop (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType,

bool bReset

);


 

[C++]

public: enumErrorCodes DeviceStop (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType,

bool 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

Meaning

false

The device buffer must not be reset

true

The device buffer must be reset

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.