Copyright © 2006-2018 MultiMedia Soft

CoreAudioDevices.RenderPartMuteGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

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

nDeviceIndex as Integer,

nPartId as enumCoreAudioRenderParts,

ByRef bMute as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes RenderPartMuteGet (

Int16 nDeviceIndex,

enumCoreAudioRenderParts nPartId,

ref bool bMute

);


 

[C++]

public: enumErrorCodes RenderPartMuteGet (

Int16 nDeviceIndex,

enumCoreAudioRenderParts nPartId,

bool __gc *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

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

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.