AudioVideoMcuSession.BeginDialOut Method

Definition

Namespace:

Microsoft.Rtc.Collaboration.AudioVideo

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginDialOut(String, AsyncCallback, Object)	Requests the Audio-Video MCU to initiate an Audio-Video call to the supplied destination URI.
BeginDialOut(String, AudioVideoMcuDialOutOptions, AsyncCallback, Object)	Requests the Audio-Video MCU to initiate an Audio-Video call to the supplied destination URI.
BeginDialOut(String, McuDialOutOptions, AsyncCallback, Object)	Requests the Audio-Video MCU to initiate an Audio-Video call to the supplied destination URI.

BeginDialOut(String, AsyncCallback, Object)

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

public:
 IAsyncResult ^ BeginDialOut(System::String ^ destinationUri, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginDialOut (string destinationUri, AsyncCallback userCallback, object state);

override this.BeginDialOut : string * AsyncCallback * obj -> IAsyncResult

Public Function BeginDialOut (destinationUri As String, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

destinationUri

String

The URI of the entity to call.

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

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 Audio-Video MCU is requested to initiate a call to the destination URI using audio and video as default media types if the Conversation does not have either audio and video among its active media types. On the other hand, if the Conversation has only audio or video among active its media types, the dial-out request is sent with either audio or video only.

BeginDialOut(String, AudioVideoMcuDialOutOptions, AsyncCallback, Object)

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

public:
 IAsyncResult ^ BeginDialOut(System::String ^ destinationUri, Microsoft::Rtc::Collaboration::AudioVideo::AudioVideoMcuDialOutOptions ^ audioVideoMcuDialOutOptions, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginDialOut (string destinationUri, Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoMcuDialOutOptions audioVideoMcuDialOutOptions, AsyncCallback userCallback, object state);

override this.BeginDialOut : string * Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoMcuDialOutOptions * AsyncCallback * obj -> IAsyncResult

Parameters

destinationUri

String

The URI of the entity to call.

audioVideoMcuDialOutOptions

AudioVideoMcuDialOutOptions

Optional parameters to customize the audio-video MCU dial-out request.

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

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.

BeginDialOut(String, McuDialOutOptions, AsyncCallback, Object)

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

public:
 IAsyncResult ^ BeginDialOut(System::String ^ destinationUri, Microsoft::Rtc::Collaboration::McuDialOutOptions ^ mcuDialOutOptions, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginDialOut (string destinationUri, Microsoft.Rtc.Collaboration.McuDialOutOptions mcuDialOutOptions, AsyncCallback userCallback, object state);

override this.BeginDialOut : string * Microsoft.Rtc.Collaboration.McuDialOutOptions * AsyncCallback * obj -> IAsyncResult

Parameters

destinationUri

String

The URI of the entity to call.

mcuDialOutOptions

McuDialOutOptions

Optional parameters to customize the dial-out request.

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

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.