state property

SessionState state
getter/setter pair

The state of the session. The session states transition as follows:

pending ( → authorizing ) → active → ended

The states mean:

  • pending - session has been created, but an agent or device has not yet joined
  • authorizing - confirmation prompt shown, waiting for the user to accept the session
  • active - the screen share session is in progress, frames are streaming
  • ended - the session is finished and can no longer be used or updated

The authorizing step is optional as user consent may not always be required (configurable via the dashboard).

Implementation

late SessionState state;