AudioVideoMcuSession.BeginMute Method (ParticipantEndpoint, MuteOptions, AsyncCallback, Object)

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

'Declaration
Public Function BeginMute ( _
    endpoint As ParticipantEndpoint, _
    options As MuteOptions, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoMcuSession
Dim endpoint As ParticipantEndpoint
Dim options As MuteOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginMute(endpoint, _
    options, userCallback, state)
public IAsyncResult BeginMute(
    ParticipantEndpoint endpoint,
    MuteOptions options,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • userCallback
    Type: System.AsyncCallback
    The method to be called when the asynchronous operation is completed.
  • state
    Type: System.Object
    A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.

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.

RealTimeInvalidOperationException

Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation).

Remarks

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

See Also

Reference

AudioVideoMcuSession Class

AudioVideoMcuSession Members

BeginMute Overload

Microsoft.Rtc.Collaboration.AudioVideo Namespace