Stops audio coming from the supplied participant endpoint from being sent to the conference.

Namespace:  Microsoft.Rtc.Collaboration.AudioVideo
Assembly:  Microsoft.Rtc.Collaboration(in Microsoft.Rtc.Collaboration.dll)

Syntax

Visual Basic (Declaration) 
Public 
Function 
BeginMute ( _
	
endpoint 
As 

ParticipantEndpoint, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
public 
IAsyncResult 
BeginMute(
	

ParticipantEndpoint 
endpoint,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
public:
IAsyncResult^ 
BeginMute(
	

ParticipantEndpoint^ 
endpoint, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginMute(
endpoint, 
userCallback, 
state);

Parameters

endpoint
Type: Microsoft.Rtc.Collaboration . . :: . ParticipantEndpoint
The endpoint for which audio should be muted.
userCallback
Type: AsyncCallback
The method to be called when the asynchronous operation is completed.
state
Type: Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

An IAsyncResult that references the asynchronous operation.

Remarks

This operation is allowed by the server for conference leaders only.

Exceptions

Exception Condition
InvalidOperationException Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type. Also thrown if the supplied endpoint is not in the MCU or has no audio to mute.
ArgumentNullException Thrown when the supplied endpoint is null.
Microsoft.Rtc.Signaling . . :: . RealTimeInvalidOperationException Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation).

See Also