AudioVideoMcuRouting.BeginUpdateAudioRoutes 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.

Updates routing of outgoing audio to and the incoming audio from other endpoints that are connected to the audio-video MCU.

public:
 IAsyncResult ^ BeginUpdateAudioRoutes(System::Collections::Generic::IEnumerable<Microsoft::Rtc::Collaboration::AudioVideo::OutgoingAudioRoute ^> ^ outgoingRoutes, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Collaboration::AudioVideo::IncomingAudioRoute ^> ^ incomingRoutes, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginUpdateAudioRoutes (System.Collections.Generic.IEnumerable<Microsoft.Rtc.Collaboration.AudioVideo.OutgoingAudioRoute> outgoingRoutes, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Collaboration.AudioVideo.IncomingAudioRoute> incomingRoutes, AsyncCallback userCallback, object state);

member this.BeginUpdateAudioRoutes : seq<Microsoft.Rtc.Collaboration.AudioVideo.OutgoingAudioRoute> * seq<Microsoft.Rtc.Collaboration.AudioVideo.IncomingAudioRoute> * AsyncCallback * obj -> IAsyncResult

Public Function BeginUpdateAudioRoutes (outgoingRoutes As IEnumerable(Of OutgoingAudioRoute), incomingRoutes As IEnumerable(Of IncomingAudioRoute), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

outgoingRoutes: IEnumerable<OutgoingAudioRoute>

A list of outgoing routes to other endpoints connected to the MCU.

incomingRoutes: IEnumerable<IncomingAudioRoute>

A list of incoming audio routes from other endpoints connected to the MCU.

userCallback: AsyncCallback

The method to be called when the asynchronous operation is completed.

state: Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

ArgumentException

Thrown when both the outgoingRoutes and incomingRoutes instances do not include any details.

InvalidOperationException

Thrown when the state of the call or conference session are not valid. Also thrown when the platform is unable to build a request for the supplied routes. This could happen if all the supplied remote sinks\source have left the conference before the request was sent.

Remarks

This method updates the existing routing (outgoing or incoming) that has been setup for a call. If the parent AudioVideoCall was established within the audio-video MCU default routing, the first call to this method actually removes the parent AudioVideoCall from the audio-video MCU default routing and setups up the requested routes. Subsequent calls to this method add or remove routes to the ones that have been already established. As an example, if the application already called this method to add an outgoing route to endpoint A and then calls the method again to add another route to endpoint B by supplying an outgoing route in outgoingRoutes, the audio-video MCU will route any media from the parent AudioVideoCall to both A and B.

The parent Conversation has to be connected to a conference as a trusted application.

Applies to

Share via