Function streamSuccessScreen

Handles the successful initiation of screen sharing.

Throws

Will throw an error if there is an issue with screen sharing.

Example

await streamSuccessScreen({
  stream: mediaStream,
  parameters: {
    socket,
    transportCreated,
    localStreamScreen: null,
    screenAlreadyOn: false,
    screenAction: true,
    transportCreatedScreen: false,
    hostLabel: "Host",
    eventType: "conference",
    showAlert,
    annotateScreenStream: false,
    updateTransportCreatedScreen,
    updateScreenAlreadyOn,
    updateScreenAction,
    updateTransportCreated,
    updateLocalStreamScreen,
    updateShared,
    updateIsScreenboardModalVisible,
    sleep,
    createSendTransport,
    connectSendTransportScreen,
    disconnectSendTransportScreen,
    stopShareScreen,
    reorderStreams,
    prepopulateUserMedia,
    rePort,
  },
});

streamSuccessScreen(options): Promise<void>
Parameters
- options: StreamSuccessScreenOptions
  The options for the screen sharing success handler.
Returns Promise<void>
A promise that resolves when the screen sharing setup is complete.
- Defined in src/consumers/streamSuccessScreen.ts:123

Function streamSuccessScreen

Throws

Example

Parameters

Returns Promise<void>

Settings