AudioVideoMcuSession.BeginAddToDefaultRouting Method (ParticipantEndpoint, AddToDefaultRoutingOptions, AsyncCallback, Object)
Adds an endpoint to the default MCU routing.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginAddToDefaultRouting ( _
endpoint As ParticipantEndpoint, _
options As AddToDefaultRoutingOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoMcuSession
Dim endpoint As ParticipantEndpoint
Dim options As AddToDefaultRoutingOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginAddToDefaultRouting(endpoint, _
options, userCallback, state)
public IAsyncResult BeginAddToDefaultRouting(
ParticipantEndpoint endpoint,
AddToDefaultRoutingOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- endpoint
Type: Microsoft.Rtc.Collaboration.ParticipantEndpoint
The endpoint to add.
- options
Type: Microsoft.Rtc.Collaboration.AddToDefaultRoutingOptions
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 application. |
| 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 can only be performed by an application that joins the conference as a trusted user.
Adding an endpoint to the MCU default routing means that the endpoint will receive and send media to the rest of the endpoints included in the default routing.