Copyright © 2008-2014 MultiMedia Soft

WASAPI.RenderDeviceMuteSet 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.RenderDeviceMuteGet method.

 

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 playback through WASAPI tutorial.

 

 

Syntax

 

[Visual Basic]

control.WASAPI.RenderDeviceMuteSet (

nDeviceIndex as Integer,

bMute as enumBoolean

) as enumErrorCodes


 

[C++]

short control.WASAPI.RenderDeviceMuteSet (

short nDeviceIndex,

short 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.RenderDeviceGetCount method.

bMute

The new muting state.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

The audio stream is not muted

BOOL_TRUE

1

The audio stream is muted

 

 

 

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