Copyright © 2011-2016 MultiMedia Soft

WASAPI.RenderDeviceMuteGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains 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 modified through the WASAPI.RenderDeviceMuteSet method.

 

This method is only intended for usage with Windows Vista and later versions.

For further details about WASAPI see the WASAPIMan class and the How to manage audio playback through WASAPI tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function RenderDeviceMuteGet (

nDeviceIndex as Int32,

ByRef bMute as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes RenderDeviceMuteGet (

Int32 nDeviceIndex,

ref bool bMute

);


 

[C++]

public: enumErrorCodes RenderDeviceMuteGet (

Int32 nDeviceIndex,

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

bMute

Reference that, on return from the method call, will contain the 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.NOERROR (0)

The method call was successful.