AudioVideoMcuSession.BeginDialOut Method (String, AudioVideoMcuDialOutOptions, AsyncCallback, Object)

Requests the Audio-Video MCU to initiate an Audio-Video call to the supplied destination URI.

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

Syntax

'Declaration
Public Function BeginDialOut ( _
    destinationUri As String, _
    audioVideoMcuDialOutOptions As AudioVideoMcuDialOutOptions, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoMcuSession
Dim destinationUri As String
Dim audioVideoMcuDialOutOptions As AudioVideoMcuDialOutOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginDialOut(destinationUri, _
    audioVideoMcuDialOutOptions, userCallback, _
    state)
public IAsyncResult BeginDialOut(
    string destinationUri,
    AudioVideoMcuDialOutOptions audioVideoMcuDialOutOptions,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • destinationUri
    Type: System.String
    The URI of the entity to call.
  • 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
InvalidOperationException

Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type.

ArgumentNullException

Thrown when the supplied destinationUri is null.

ArgumentException

Thrown when the supplied destinationUri is invalid.

RealTimeInvalidOperationException

Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation).

Remarks

The appearance of the dialed-out to endpoint in the conference roster can be customized by supplying a participant URI and display name in the mcuDialOutOptions object. The MCU may not honor the settings if the asserted identity of the dialed-out to endpoint was communicated to the MCU during the dial-out operation.

See Also

Reference

AudioVideoMcuSession Class

AudioVideoMcuSession Members

BeginDialOut Overload

Microsoft.Rtc.Collaboration.AudioVideo Namespace