AudioVideoMcuRouting.BeginUpdateAudioRoutes Method

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

Namespace:  Microsoft.Rtc.Collaboration.AudioVideo
Assembly:  Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)

Syntax

'Declaration
Public Function BeginUpdateAudioRoutes ( _
    outgoingRoutes As IEnumerable(Of OutgoingAudioRoute), _
    incomingRoutes As IEnumerable(Of IncomingAudioRoute), _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoMcuRouting
Dim outgoingRoutes As IEnumerable(Of OutgoingAudioRoute)
Dim incomingRoutes As IEnumerable(Of IncomingAudioRoute)
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginUpdateAudioRoutes(outgoingRoutes, _
    incomingRoutes, userCallback, state)

public IAsyncResult BeginUpdateAudioRoutes(
    IEnumerable<OutgoingAudioRoute> outgoingRoutes,
    IEnumerable<IncomingAudioRoute> incomingRoutes,
    AsyncCallback userCallback,
    Object state
)

Parameters

• outgoingRoutes
  Type: System.Collections.Generic.IEnumerable<OutgoingAudioRoute>
  A list of outgoing routes to other endpoints connected to the MCU.

• incomingRoutes
  Type: System.Collections.Generic.IEnumerable<IncomingAudioRoute>
  A list of incoming audio routes from other endpoints connected to the MCU.

• userCallback
  Type: System.AsyncCallback
  The method to be called when the asynchronous operation is completed.

• state
  Type: System.Object
  A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.

Exceptions

Exception	Condition
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.

See Also

Reference

AudioVideoMcuRouting Class

AudioVideoMcuRouting Members

Microsoft.Rtc.Collaboration.AudioVideo Namespace

BeginJoin(ConferenceJoinOptions, AsyncCallback, Object)

ConferenceJoinOptions