Copyright © 2006-2018 MultiMedia Soft

WASAPI.DeviceMuteSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the muting state of the audio stream that enters or leaves the given WASAPI device for the current process. The current muting state can be obtained through the WASAPI.DeviceMuteGet method.

 

If you need to modify the master mute for the given WASAPI device, shared by all running processes, use the CoreAudioDevices.MuteSet method.

 

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

Further information about management of audio devices in Windows Vista and later versions can be found inside the How to access settings of audio devices in Windows Vista and later versions tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function DeviceMuteSet (

nDeviceIndex as Int32,

nDeviceType as enumWasapiDeviceTypes,

ByRef bMute as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes DeviceMuteSet (

Int32 nDeviceIndex,

enumWasapiDeviceTypes DeviceMuteSet,

ref bool bMute

);


 

[C++]

public: enumErrorCodes DeviceMuteGet (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType,

bool __gc  *bMute

);


 

 

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.

bMute

The new muting state.

Supported values are the following:

Mnemonic constant

Meaning

false

The audio stream is not muted

true

The audio stream is muted

 

 

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.