Classes > CoreAudioDevicesMan class > Methods > CoreAudioDevices.PartsMuteGet method

Remarks

Checks if the given subpart of the given audio endpoint device has a mute status and obtains its current value. The muting status can be modified through the CoreAudioDevices.PartsMuteSet 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 CoreAudioDevicesMan class.

Syntax

[Visual Basic]

Public Function PartsMuteGet (

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int32,

nPartIndex as Int32,

ByRef bHasMute as Boolean,

ByRef bMute as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes PartsMuteGet (

enumCoreAudioDataFlows nDataFlow,

Int32 nDeviceIndex,

Int32 nPartIndex,

ref bool bHasMute,

ref bool bMute

);

[C++]

public: enumErrorCodes PartsMuteGet (

enumCoreAudioDataFlows nDataFlow,

Int32 nDeviceIndex,

Int32 nPartIndex,

bool __gc *bHasMute,

bool __gc *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 render or capture audio endpoint devices can be obtained through the CoreAudioDevices.CountGet method passing DEVICE_DATA_FLOW_RENDER or DEVICE_DATA_FLOW_CAPTURE to the nDataFlow parameter.

nPartIndex

Zero-based index of the requested subpart. The total number of available subparts can be obtained through the CoreAudioDevices.PartsCountGet method.

bHasMute

Reference that, on return from the method call, will contain the availability of the muting status.

Supported values are the following:

Mnemonic constant	Value	Meaning
BOOL_FALSE	0	The subpart doesn't have a mute status
BOOL_TRUE	1	The subpart have a mute status

bMute

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

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