Copyright © 2006-2018 MultiMedia Soft

CoreAudioDevices.MuteSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies the muting state of the audio stream that enters or leaves the given audio endpoint device. given audio endpoint device.

 

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 MuteSet (

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

bMute as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes MuteSet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

bool bMute

);


 

[C++]

public: enumErrorCodes MuteSet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

bool 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

The new muting state to apply.

Supported values are the following:

Mnemonic constant

Meaning

false

The audio stream is not muted

true

The audio stream is muted

 

 

Return value

 

Value

Meaning

 

 

Negative value

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

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.