stopShareScreen

Stops the screen sharing process and updates various states and UI elements accordingly.

This function is designed to stop the screen sharing session and reset related states. It performs several key actions:

  1. Resets screen sharing states (shared, shareScreenStarted, shareEnded) and updates main UI flags

  2. Stops the local screen stream and disconnects the transport for screen sharing

  3. Manages screen annotation states by toggling the annotation overlay as needed

  4. Prepopulates user media and triggers a reordering of video streams if layout changes are necessary

Parameters

options

The options containing parameters for stopping screen share

Example:

val parameters = object : StopShareScreenParameters {
override val shared = true
override val shareScreenStarted = true
override val shareEnded = false
override val updateMainWindow = true
override val deferReceive = false
override val hostLabel = "Host"
override val lockScreen = false
override val forceFullDisplay = false
override val firstAll = false
override val firstRound = false
override val localStreamScreen = localStream
override val eventType = "conference"
override val prevForceFullDisplay = false
override val annotateScreenStream = false
// ... other update functions
override fun getUpdatedAllParams() = this
}

val options = StopShareScreenOptions(parameters = parameters)
stopShareScreen(options)