IMFSimpleAudioVolume::SetMasterVolume method (mfidl.h)

Article
02/22/2024

Sets the master volume level.

Syntax

HRESULT SetMasterVolume(
  [in] float fLevel
);

Parameters

[in] fLevel

Volume level. Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation).

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
MF_E_NOT_INITIALIZED	The audio renderer is not initialized.
MF_E_STREAMSINK_REMOVED	The audio renderer was removed from the pipeline.

Remarks

Events outside of the application can change the master volume level. For example, the user can change the volume from the system volume-control program (SndVol). If an external event changes the master volume, the audio renderer sends an MEAudioSessionVolumeChanged event, which the Media Session forwards to the application.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	mfidl.h
Library	Mfuuid.lib