Function connectSendTransportScreen

Sets up and connects a screen sharing transport for sending video streams.

This function supports both a primary and a local screen producer, delegating local handling to a separate function.

Throws

Will throw an error if there is an issue with the connection or setup process.

Example

await connectSendTransportScreen({
  stream: screenStream,
  targetOption: 'all',
  parameters: {
    screenProducer: null,
    localScreenProducer: null,
    device: mediaDevice,
    screenParams: { encodings: [{ maxBitrate: 1500000 }] },
    producerTransport: sendTransport,
    localProducerTransport: localSendTransport,
    params: { track: screenStream.getVideoTracks()[0] },
    updateScreenProducer: setScreenProducer,
    updateLocalScreenProducer: setLocalScreenProducer,
    updateProducerTransport: setProducerTransport,
    updateLocalProducerTransport: setLocalProducerTransport,
    getUpdatedAllParams: getParams,
  },
});

connectSendTransportScreen(options): Promise<void>
Parameters
- options: ConnectSendTransportScreenOptions
  The configuration options for setting up the screen transport.
Returns Promise<void>
- A promise that resolves once the screen transport is successfully connected and set up.
- Defined in src/consumers/connectSendTransportScreen.ts:114

Function connectSendTransportScreen

Throws

Example

Parameters

Returns Promise<void>

Settings