AudioVideoMcuSession.BeginRemoveFromDefaultRouting Method (ParticipantEndpoint, RemoveFromDefaultRoutingOptions, AsyncCallback, Object)
Removes an endpoint from the default MCU routing.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginRemoveFromDefaultRouting ( _
endpoint As ParticipantEndpoint, _
options As RemoveFromDefaultRoutingOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoMcuSession
Dim endpoint As ParticipantEndpoint
Dim options As RemoveFromDefaultRoutingOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginRemoveFromDefaultRouting(endpoint, _
options, userCallback, state)
public IAsyncResult BeginRemoveFromDefaultRouting(
ParticipantEndpoint endpoint,
RemoveFromDefaultRoutingOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- endpoint
Type: Microsoft.Rtc.Collaboration.ParticipantEndpoint
The endpoint to remove.
- options
Type: Microsoft.Rtc.Collaboration.RemoveFromDefaultRoutingOptions
Options to customize sending the command.
- userCallback
Type: System.AsyncCallback
The callback supplied by the application.
- state
Type: System.Object
The state object supplied by the application.
Return Value
Type: System.IAsyncResult
As async result that references the 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 or if the application did not join the conference as a trusted applicaiton. |
| ArgumentNullException | Thrown when the supplied endpoint is null. |
| ArgumentOutOfRangeException | Thrown when the options parameter contains a duration value which is less than 1 or greater than MaxValue seconds. |
| RealTimeInvalidOperationException | Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation). |
Remarks
This operation can only be performed by an application that joins the conference as a trusted user.
Removing an endpoint from the MCU default routing means that the endpoint will no longer receive or send any media to the other endpoints. Trusted applications connected to the conference however can further communicate with that endpoint.
Removing an endpoint from default routing could be useful to render specific services to the endpoint while in the conference. As an example, a trusted application can remove the endpoint from the default mix in order to play a help message to that endpoint without disturbing the rest of the conference.
An application can specify how long the endpoint is removed from default routing Duration or can rely on the default duration implemented by the MCU. The default duration guarantees that an endpoint is not left out of the default mix forever.