meet:: SessionStatus

#include <session_control_resource.h>

This is a singleton resource containing the status of the media session.

Summary

Public types

 ConferenceConnectionState 
{
 kWaiting 
,
 kJoined 
,
 kDisconnected 

}

enum

 MeetingDisconnectReason 
{
 kClientLeft 
,
 kUserStopped 
,
 kConferenceEnded 
,
 kSessionUnhealthy 

}

enum

Public attributes

 connection_state 
=
      ConferenceConnectionState::kUnknown

 ConferenceConnectionState

 disconnect_reason 
= std::nullopt

std::optional< MeetingDisconnectReason 
>

Public types

ConferenceConnectionState

  
 meet 
 :: 
 SessionStatus 
 :: 
 ConferenceConnectionState

Properties

 kDisconnected

Session is not connected to the conference.

This will be sent from the server when the client is no longer connected to the conference. This can occur for a variety of reasons, including the client being kicked from the conference, the client not being admitted into the conference, or the conference ending.

 kJoined

Session has fully joined the conference.

 kWaiting

Session is waiting to be admitted into the conference.

The client may never observe this state if it was admitted or rejected quickly.

MeetingDisconnectReason

  
 meet 
 :: 
 SessionStatus 
 :: 
 MeetingDisconnectReason

Properties

 kClientLeft

The Media API client sent a leave request.

 kConferenceEnded

The conference ended.

 kSessionUnhealthy

Something else went wrong with the session.

 kUserStopped

A conference participant explicitly stopped the Media API session.

Public attributes

connection_state

  ConferenceConnectionState 
 
  
 meet 
 :: 
 SessionStatus 
 :: 
 connection_state 
  
 = 
  
 ConferenceConnectionState 
 :: 
 kUnknown

disconnect_reason

 std 
 :: 
 optional 
 < 
  
  MeetingDisconnectReason 
 
  
 > 
  
 meet 
 :: 
 SessionStatus 
 :: 
 disconnect_reason 
  
 = 
  
 std 
 :: 
 nullopt