Transfers an established two party Audio-Video
call to the MCU.
Namespace:
Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration(in Microsoft.Rtc.Collaboration.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Function BeginTransfer ( _ call As AudioVideoCall, _ mcuTransferOptions As McuTransferOptions, _ userCallback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
| C# |
|---|
public IAsyncResult BeginTransfer( AudioVideoCall call, McuTransferOptions mcuTransferOptions, AsyncCallback userCallback, Object state ) |
| Visual C++ |
|---|
public: IAsyncResult^ BeginTransfer( AudioVideoCall^ call, McuTransferOptions^ mcuTransferOptions, AsyncCallback^ userCallback, Object^ state ) |
| JavaScript |
|---|
function beginTransfer( call, mcuTransferOptions, userCallback, state); |
Parameters
- call
- Type:
Microsoft.Rtc.Collaboration.AudioVideo
.
.
::
.
AudioVideoCall
The Audio-Video call to transfer.
- mcuTransferOptions
- Type:
Microsoft.Rtc.Collaboration
.
.
::
.
McuTransferOptions
Optional parameters to customize the transfer request.
- userCallback
- Type:
AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
- Type:
Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
An IAsyncResult that references the asynchronous operation.
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 override those values with the asserted identity of the transferred endpoint.
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. |
| Microsoft.Rtc.Signaling . . :: . RealTimeInvalidOperationException | Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation). |
See Also
