Copyright © 2006-2011 MultiMedia Soft

SetMixerMasterMute method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the mute status of the mixer's Master element.

 

The current mute status can be retrieved using the GetMixerMasterMute method.

 

The number of mixers currently installed on the system can be retrieved using the GetMixersCount method. A friendly description of the mixer can be retrieved using the GetMixerDesc method.

 

IMPORTANT NOTE ABOUT THE WINDOWS VERSION: This method is only intended for usage when the operating system is Windows XP or older versions; for Windows Vista and higher versions it's recommended using methods exposed by the CoreAudioDevicesMan class.

 

 

Syntax

 

[Visual Basic]

Public Function SetMixerMasterMute (

nIndex as Int16,

bMute as bool

) as enumErrorCodes


 

[C#]

public enumErrorCodes SetMixerMasterMute (

Int16 nIndex,

bool bMute

);


 

[C++]

public: enumErrorCodes SetMixerMasterMute (

Int16 nIndex,

bool bMute

);


 

 

Parameter

Description

 

 

nIndex

Number representing the zero-based index of the mixer whose master's mute status must be modified

bMute

Boolean value that specifies if Boolean value that specifies if mouse-based selections are enabled or disabled

Supported values are the following:

Value

Meaning

false

The master element is not in mute status

true

The master element is in mute status

 

 

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