Copyright © 2005-2011 MultiMedia Soft

MixerGetMicrophoneVolume method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the microphone's volume for the given mixer: this volume is related to the microphone's playback channel and not to the microphone's recording channel.

 

The returned volume can be modified using the MixerSetMicrophoneVolume 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 CoreAudioDevicesMan class.

 

 

Syntax

 

[Visual Basic]

Public Function MixerGetMicrophoneVolume (

nIndex as Int16

) as Int16


 

[C#]

public Int16 MixerGetMicrophoneVolume (

Int16 nIndex

);


 

[C++]

public: Int16 MixerGetMicrophoneVolume (

Int16 nIndex

);


 

 

 

Parameter

Description

 

 

nIndex

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

 

 

Return value

 

 

Value

Meaning

 

 

Negative value

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

>= 0

The current microphone's volume in the range from 0 to 100