COM Objects > CoreAudioDevices object > Methods > CoreAudioDevices.MuteGet method

Remarks

Obtains the muting state of the audio stream that enters or leaves the given audio endpoint device. The muting state can be modified through the CoreAudioDevices.MuteSet method.

This method is only intended for usage with Windows Vista and later versions: further information about management of audio devices in Windows Vista and later versions can be found inside the How to access settings of audio devices in Windows Vista and later versions tutorial.

For further details about methods related to the management of core audio devices refer to the CoreAudioDevices COM object.

Syntax

[Visual Basic]

control.CoreAudioDevices.MuteGet (

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Integer,

bMute as enumBoolean

) as enumErrorCodes

[C++]

short control.CoreAudioDevices.MuteGet (

short nDataFlow,

short nDeviceIndex,

short *bMute

);

Parameter

Description

nDataFlow

Direction in which audio data flows between an audio endpoint device and an application.

Supported values are the following:

Mnemonic Value	Value	Meaning
DEVICE_DATA_FLOW_RENDER	0	Audio rendering stream. Audio data flows from the application to the audio endpoint device, which renders the stream
DEVICE_DATA_FLOW_CAPTURE	1	Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, to the application.

nDeviceIndex

Zero-based index of the audio endpoint device. The total number of audio endpoint devices can be obtained through the CoreAudioDevices.CountGet method.

bMute

Reference that, on return from the method call, will contain the muting state.

Supported values are the following:

Mnemonic constant	Value	Meaning
BOOL_FALSE	0	The audio stream is not muted
BOOL_TRUE	1	The audio stream is muted

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful