Copyright © 2001-2011 MultiMedia Soft

MixerGetMasterVolume method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the master volume for the given mixer.

 

The returned volume can be modified using the MixerSetMasterVolume 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.MixerGetMasterVolume (

nIndex as Integer

) as Integer


 

[C++]

short control.MixerGetMasterVolume (

short nIndex

);


 

 

Parameter

Description

 

 

nIndex

Number representing the zero-based index of the mixer whose master volume must be retrieved

 

 

Return value

 

 

Value

Meaning

 

 

Negative value

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

>= 0

The current master volume in the range from 0 to 100