McuSession.BeginEject Method (String, EjectOptions, AsyncCallback, Object)
Ejects a participant or an endpoint from the MCU based on the supplied URI.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginEject ( _
uri As String, _
options As EjectOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As McuSession
Dim uri As String
Dim options As EjectOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginEject(uri, _
options, userCallback, state)
public IAsyncResult BeginEject(
string uri,
EjectOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- uri
Type: System.String
The URI of the participant or endpoint to eject.
- options
Type: Microsoft.Rtc.Collaboration.EjectOptions
Options to customize the eject operation. Could be null.
- 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
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 supplied URI is null. |
| ArgumentException | Thrown when the supplied URI is invalid. |
| RealTimeInvalidOperationException | Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation). |
Remarks
The parent ConferenceSession has to be connected to a conference that supports the corresponding MCU type.