Class RequestScreenShare

Requests to start screen sharing.

This method initiates a screen sharing request and handles the response from the server to determine if screen sharing is allowed. It also configures the target resolution for the screen share based on the user's input and parameters.

Param: options

The options for requesting screen share.

Param: options.parameters

The parameters for the screen share request.

Param: options.parameters.socket

The socket instance to communicate with the server.

Param: options.parameters.showAlert

Optional function to show alerts to the user.

Param: options.parameters.localUIMode

Indicates if the user is in local UI mode.

Param: options.parameters.targetResolution

The target resolution for screen sharing.

Param: options.parameters.targetResolutionHost

The target resolution for the host screen.

Param: options.parameters.startShareScreen

Function to start screen sharing.

Returns

A promise that resolves when the screen share request is processed.

Throws

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

Example

await requestScreenShare({
  parameters: {
    socket: mySocket,
    localUIMode: false,
    targetResolution: 'fhd',
    startShareScreen: myStartShareScreenFunction,
    showAlert: myShowAlertFunction,
  },
});

Constructors

constructor

Methods

requestScreenShare

Constructors

constructor

Methods

requestScreenShare

  • requestScreenShare(options): Promise<void>

  • Requests to start screen sharing.

    Parameters

    Returns Promise<void>

    A promise that resolves when the screen share request is processed.

    Throws

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

Settings

Member Visibility

On This Page

Constructors
Methods