Edit

Share via


McuSession.BeginDialOut Method

Definition

Sends a request to MCU to initiate a call to the supplied destination URI.

protected:
 IAsyncResult ^ BeginDialOut(System::String ^ destinationUri, Microsoft::Rtc::Collaboration::McuDialOutOptions ^ mcuDialOutOptions, AsyncCallback ^ userCallback, System::Object ^ state);
protected IAsyncResult BeginDialOut (string destinationUri, Microsoft.Rtc.Collaboration.McuDialOutOptions mcuDialOutOptions, AsyncCallback userCallback, object state);
member 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

An IAsyncResult that references the asynchronous operation.

Exceptions

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

Thrown when the supplied destinationUri is null.

Thrown when the supplied destinationUri is invalid.

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.

Applies to