Copyright © 2006-2018 MultiMedia Soft

CoreAudioDevices.RenderPartMuteSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies the muting state of the stream leaving the render part of the given audio endpoint device. The current muting state can be obtained through the CoreAudioDevices.RenderPartMuteGet 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.RenderPartMuteSet (

nDeviceIndex as Integer,

nPartId as enumCoreAudioRenderParts,

bMute as enumBoolean

) as enumErrorCodes


 

[C++]

short control.CoreAudioDevices.RenderPartMuteSet (

short nDeviceIndex,

short nPartId,

short bMute

);


 

Parameter

Description

 

 

nDeviceIndex

Zero-based index of the render audio endpoint device. The total number of render audio endpoint devices can be obtained through the CoreAudioDevices.CountGet method passing DEVICE_DATA_FLOW_RENDER to the nDataFlow parameter.

nPartId

Identifier of the render part.

Supported values are the following:

Mnemonic Value

Value

Meaning

RENDER_PART_CD_AUDIO

0

CD Audio

RENDER_PART_MIC

1

Microphone

RENDER_PART_LINEIN

2

Line In

bMute

The new muting state to apply.

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