ISimpleAudioVolume::GetMute method

The GetMute method retrieves the current muting state for the audio session.

Syntax


HRESULT GetMute(
  [out] BOOL *pbMute
);

Parameters

pbMute [out]

Pointer to a BOOL variable into which the method writes the muting state. TRUE indicates that muting is enabled. FALSE indicates that it is disabled.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return codeDescription
E_POINTER

Parameter pbMute is NULL.

AUDCLNT_E_DEVICE_INVALIDATED

The audio endpoint device has been unplugged, or the audio hardware or associated hardware resources have been reconfigured, disabled, removed, or otherwise made unavailable for use.

AUDCLNT_E_SERVICE_NOT_RUNNING

The Windows audio service is not running.

 

Requirements

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8

Header

Audioclient.h

See also

IChannelAudioVolume Interface
ISimpleAudioVolume Interface
ISimpleAudioVolume::SetMute

 

 

Show: