McuSession.BeginSendCommand Method

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginSendCommand(ConferenceCommand, AsyncCallback, Object)	Send a request to the MCU via the focus.
BeginSendCommand(ConferenceCommand, ConferenceCommandOptions, AsyncCallback, Object)	Send a request to the MCU via the focus.

BeginSendCommand(ConferenceCommand, AsyncCallback, Object)

Send a request to the MCU via the focus.

protected:
 IAsyncResult ^ BeginSendCommand(Microsoft::Rtc::Internal::Collaboration::Conferencing::Commands::ConferenceCommand ^ command, AsyncCallback ^ userCallback, System::Object ^ state);

protected IAsyncResult BeginSendCommand (Microsoft.Rtc.Internal.Collaboration.Conferencing.Commands.ConferenceCommand command, AsyncCallback userCallback, object state);

member this.BeginSendCommand : Microsoft.Rtc.Internal.Collaboration.Conferencing.Commands.ConferenceCommand * AsyncCallback * obj -> IAsyncResult

Protected Function BeginSendCommand (command As ConferenceCommand, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

command

ConferenceCommand

The conference command to send to the MCU via the focus.

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

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

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.

BeginSendCommand(ConferenceCommand, ConferenceCommandOptions, AsyncCallback, Object)

Send a request to the MCU via the focus.

protected:
 IAsyncResult ^ BeginSendCommand(Microsoft::Rtc::Internal::Collaboration::Conferencing::Commands::ConferenceCommand ^ command, Microsoft::Rtc::Collaboration::ConferenceCommandOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

protected IAsyncResult BeginSendCommand (Microsoft.Rtc.Internal.Collaboration.Conferencing.Commands.ConferenceCommand command, Microsoft.Rtc.Collaboration.ConferenceCommandOptions options, AsyncCallback userCallback, object state);

member this.BeginSendCommand : Microsoft.Rtc.Internal.Collaboration.Conferencing.Commands.ConferenceCommand * Microsoft.Rtc.Collaboration.ConferenceCommandOptions * AsyncCallback * obj -> IAsyncResult

Protected Function BeginSendCommand (command As ConferenceCommand, options As ConferenceCommandOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

command

ConferenceCommand

The conference command to send to the MCU via the focus.

options

ConferenceCommandOptions

Options to customize the command.

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

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

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.