Class StopShareScreen

Stops the screen sharing process and updates the relevant parameters and states.

This method updates the internal state to reflect that screen sharing has ended, cleans up local media tracks, and reorders the streams in the application.

Param: options

The options for stopping the screen share.

Param: options.parameters

The parameters required for stopping the screen share.

Param: options.parameters.getUpdatedAllParams

Function to get updated parameters.

Param: options.parameters.shared

Indicates if the screen is currently shared.

Param: options.parameters.shareScreenStarted

Indicates if the screen sharing has started.

Param: options.parameters.shareEnded

Indicates if the screen sharing has ended.

Param: options.parameters.updateMainWindow

Indicates if the main window needs to be updated.

Param: options.parameters.defer_receive

Indicates if receiving is deferred.

Param: options.parameters.hostLabel

The label of the host.

Param: options.parameters.lock_screen

Indicates if the screen is locked.

Param: options.parameters.forceFullDisplay

Indicates if full display is forced.

Param: options.parameters.firstAll

Indicates if it is the first all.

Param: options.parameters.first_round

Indicates if it is the first round.

Param: options.parameters.localStreamScreen

The local screen stream.

Param: options.parameters.eventType

The type of event (e.g., "conference").

Param: options.parameters.prevForceFullDisplay

Indicates if full display was previously forced.

Param: options.parameters.annotateScreenStream

Indicates if the screen stream is annotated.

Param: options.parameters.updateShared

Function to update the shared state.

Param: options.parameters.updateShareScreenStarted

Function to update the share screen started state.

Param: options.parameters.updateShareEnded

Function to update the share ended state.

Param: options.parameters.updateUpdateMainWindow

Function to update the main window state.

Param: options.parameters.updateDefer_receive

Function to update the defer receive state.

Param: options.parameters.updateLock_screen

Function to update the lock screen state.

Param: options.parameters.updateForceFullDisplay

Function to update the force full display state.

Param: options.parameters.updateFirstAll

Function to update the first all state.

Param: options.parameters.updateFirst_round

Function to update the first round state.

Param: options.parameters.updateLocalStreamScreen

Function to update the local screen stream.

Param: options.parameters.updateMainHeightWidth

Function to update the main height and width.

Param: options.parameters.updateAnnotateScreenStream

Function to update the annotate screen stream state.

Param: options.parameters.updateIsScreenboardModalVisible

Function to update the screenboard modal visibility.

Param: options.parameters.disconnectSendTransportScreen

Function to disconnect the send transport screen.

Param: options.parameters.prepopulateUserMedia

Function to prepopulate user media.

Param: options.parameters.reorderStreams

Function to reorder streams.

Param: options.parameters.getVideos

Function to get videos.

Returns

A promise that resolves when the screen sharing process is stopped.

Throws

Throws an error if there is an issue during the screen share stopping process.

Example

await stopShareScreen({
  parameters: {
    socket: mySocket,
    shared: true,
    shareScreenStarted: true,
    // other parameters...
  },
});

Constructors

constructor

Methods

stopShareScreen

Constructors

constructor

Methods

stopShareScreen

Settings

Member Visibility

On This Page

Constructors
Methods