Edit

Share via


McuSession.BeginTransfer Method

Definition

Transfers an established two party call to the MCU.

protected:
 IAsyncResult ^ BeginTransfer(Microsoft::Rtc::Collaboration::Call ^ call, Microsoft::Rtc::Collaboration::McuTransferOptions ^ mcuTransferOptions, AsyncCallback ^ userCallback, System::Object ^ state);
protected IAsyncResult BeginTransfer (Microsoft.Rtc.Collaboration.Call call, Microsoft.Rtc.Collaboration.McuTransferOptions mcuTransferOptions, AsyncCallback userCallback, object state);
member this.BeginTransfer : Microsoft.Rtc.Collaboration.Call * Microsoft.Rtc.Collaboration.McuTransferOptions * AsyncCallback * obj -> IAsyncResult

Parameters

call
Call

The call to transfer.

mcuTransferOptions
McuTransferOptions

Optional parameters to customize the transfer 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 command is null.

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

Remarks

The transferred call has to be an established Call that supports transfer.

Unless customized using the supplied mcuTransferOptions, the call remote participant URI and display name are used to supply the transfer request with roster information. Note that even if the participant URI and display name are supplied in the mcuTransferOptions, the MCU may still override those values with the asserted identity for the transferred participant.

Applies to