McuSession.State Property

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Gets the state of the MCU as communicated by the focus.

public:
 property Microsoft::Rtc::Collaboration::McuSessionState State { Microsoft::Rtc::Collaboration::McuSessionState get(); };

public Microsoft.Rtc.Collaboration.McuSessionState State { get; }

member this.State : Microsoft.Rtc.Collaboration.McuSessionState

Public ReadOnly Property State As McuSessionState

Property Value

McuSessionState

Remarks

When the first participant joins a conference, the MCU activation process is started on the server. When the MCU becomes active, the McuSession state is transitioned from Idle to Active. The McuSession does not manage any direct sessions with the MCU.

Note that it is not guranteed an McuSession becomes active before ConferenceSession completes the join operation. Any McuSession operation invoked on an idle but bound McuSession shall be queued and resumed after 30 seconds or before that if the MCU becomes active. However, if the ConferenceSession joins a conference that does not support the corresponding MCU type, the state will be transitioned to Terminated before the join operation completes.

If the MCU fails over and the conference focus communicates the fail-over state back to the application, the McuSession state will be transitioned from Active to Retrying. If a Call was already established to that failing MCU, the Call will be terminated and the application should establish a new Call if required. After the MCU fail-over process is completed and the focus communicates activation to the application, the McuSession state will be transitioned from Retrying to Active.

The McuSession state will also be transitioned to Retrying while the parent ConferenceSession is reconnecting to the focus as a result of the focus failing over to another front end. The McuSession will be transitioned back to Idle or Active based on the MCU state communicated back to the application.