AudioVideoMcuSession.BeginRemoveFromDefaultRouting Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.AudioVideo

Assembly:: Microsoft.Rtc.Collaboration.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

BeginRemoveFromDefaultRouting(ParticipantEndpoint, AsyncCallback, Object)	Removes an endpoint from the default MCU routing.
BeginRemoveFromDefaultRouting(ParticipantEndpoint, RemoveFromDefaultRoutingOptions, AsyncCallback, Object)	Removes an endpoint from the default MCU routing.

BeginRemoveFromDefaultRouting(ParticipantEndpoint, AsyncCallback, Object)

Removes an endpoint from the default MCU routing.

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

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

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

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

Parameters

endpoint: ParticipantEndpoint

The endpoint to remove.

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 applicaiton.

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.

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.

Applies to

BeginRemoveFromDefaultRouting(ParticipantEndpoint, RemoveFromDefaultRoutingOptions, AsyncCallback, Object)

Removes an endpoint from the default MCU routing.

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

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

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

Public Function BeginRemoveFromDefaultRouting (endpoint As ParticipantEndpoint, options As RemoveFromDefaultRoutingOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult