AudioVideoMcuSession.BeginAddToDefaultRouting Method

Definition

Namespace:

Microsoft.Rtc.Collaboration.AudioVideo

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginAddToDefaultRouting(ParticipantEndpoint, AsyncCallback, Object)	Adds an endpoint to the default MCU routing.
BeginAddToDefaultRouting(ParticipantEndpoint, AddToDefaultRoutingOptions, AsyncCallback, Object)	Adds an endpoint to the default MCU routing.

BeginAddToDefaultRouting(ParticipantEndpoint, AsyncCallback, Object)

Adds an endpoint to the default MCU routing.

public:
 IAsyncResult ^ BeginAddToDefaultRouting(Microsoft::Rtc::Collaboration::ParticipantEndpoint ^ endpoint, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginAddToDefaultRouting (Microsoft.Rtc.Collaboration.ParticipantEndpoint endpoint, AsyncCallback userCallback, object state);

member this.BeginAddToDefaultRouting : Microsoft.Rtc.Collaboration.ParticipantEndpoint * AsyncCallback * obj -> IAsyncResult

Public Function BeginAddToDefaultRouting (endpoint As ParticipantEndpoint, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

endpoint

ParticipantEndpoint

The endpoint to add.

userCallback

AsyncCallback

The callback supplied by the application.

state

Object

The state object supplied by the application.

Returns

IAsyncResult

As async result that references the operation.

Exceptions

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.

BeginAddToDefaultRouting(ParticipantEndpoint, AddToDefaultRoutingOptions, AsyncCallback, Object)

Adds an endpoint to the default MCU routing.

public:
 IAsyncResult ^ BeginAddToDefaultRouting(Microsoft::Rtc::Collaboration::ParticipantEndpoint ^ endpoint, Microsoft::Rtc::Collaboration::AddToDefaultRoutingOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginAddToDefaultRouting (Microsoft.Rtc.Collaboration.ParticipantEndpoint endpoint, Microsoft.Rtc.Collaboration.AddToDefaultRoutingOptions options, AsyncCallback userCallback, object state);

member this.BeginAddToDefaultRouting : Microsoft.Rtc.Collaboration.ParticipantEndpoint * Microsoft.Rtc.Collaboration.AddToDefaultRoutingOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginAddToDefaultRouting (endpoint As ParticipantEndpoint, options As AddToDefaultRoutingOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

endpoint

ParticipantEndpoint

The endpoint to add.

options

AddToDefaultRoutingOptions

Options to customize sending the command.

userCallback

AsyncCallback

The callback supplied by the application.

state

Object

The state object supplied by the application.

Returns

IAsyncResult

As async result that references the operation.

Exceptions

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.