Copyright © 2001-2011 MultiMedia Soft

MixerGetMicrophoneMute method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the microphone's mute status for the given mixer: this method is related to the Microphone as a playback channel and not as a recording channel.

 

The mute status can be modified using the MixerSetMicrophoneMute method.

 

The number of mixers currently installed on the system can be retrieved using the MixerGetCount method. A friendly description of the mixer can be retrieved using the MixerGetDesc 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 CoreAudioDevices COM object.

 

 

Syntax

 

[Visual Basic]

control.MixerGetMicrophoneMute (

nIndex as Integer

) as enumBoolean


 

[C++]

short control.MixerGetMicrophoneMute (

short nIndex

);


 

 

Parameter

Description

 

 

nIndex

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

 

 

Return value

 

Value

Meaning

 

 

Negative value

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

>= 0

The current mute status.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Microphone is not muted

BOOL_TRUE

1

Microphone is muted