McuSession.BeginSendCommand Method (, ConferenceCommandOptions, AsyncCallback, Object)
Send a request to the MCU via the focus.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Protected Function BeginSendCommand ( _
command As ConferenceCommand, _
options As ConferenceCommandOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim command As ConferenceCommand
Dim options As ConferenceCommandOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = Me.BeginSendCommand(command, _
options, userCallback, state)
protected IAsyncResult BeginSendCommand(
ConferenceCommand command,
ConferenceCommandOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- command
Type: ConferenceCommand
The conference command to send to the MCU via the focus.
- options
Type: Microsoft.Rtc.Collaboration.ConferenceCommandOptions
Options to customize the command.
- 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
Note McuSession does not manage any direct sessions with the MCU. The command is actually proxied to the ConferenceSession which manages the signaling and subscription sessions with the focus. The focus proxies the command to the MCU and proxies the responses back to the application.