McuSession.BeginTransfer Method
Transfers an established two party call to the MCU.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Protected Function BeginTransfer ( _
call As Call, _
mcuTransferOptions As McuTransferOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim call As Call
Dim mcuTransferOptions As McuTransferOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = Me.BeginTransfer(call, _
mcuTransferOptions, userCallback, _
state)
protected IAsyncResult BeginTransfer(
Call call,
McuTransferOptions mcuTransferOptions,
AsyncCallback userCallback,
Object state
)
Parameters
- call
Type: Microsoft.Rtc.Collaboration.Call
The call to transfer.
- mcuTransferOptions
Type: Microsoft.Rtc.Collaboration.McuTransferOptions
Optional parameters to customize the transfer request.
- 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 command is null. |
| RealTimeInvalidOperationException | 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.