Class ScreenParams

The ScreenParams service provides encoding parameters specifically for screen sharing in a media session using the Mediasoup library. It includes a default configuration for RTP encoding parameters optimized for high-quality screen sharing.

Service

Example

import { ScreenParams } from './path/to/screen-params.service';

constructor(private screenParamsService: ScreenParams) {
  console.log(this.screenParamsService.screenParams);
}

Example

const screenParams: ScreenParamsType = {
  encodings: [
    {
      rid: 'r7',
      maxBitrate: 3000000, // Max bitrate for this encoding (in bps)
    },
  ],
  codecOptions: {
    videoGoogleStartBitrate: 1000, // Initial bitrate for the Google codec
  },
};

Remarks

The default screenParams includes one encoding configuration with a high maximum bitrate suitable for sharing detailed screen content. The parameters are optimized to ensure a smooth experience during screen sharing sessions.

Returns

The screen sharing parameters for use in screen sharing producer configuration.

Constructors

constructor

Properties

screenParams

Constructors

constructor

Properties

screenParams

screenParams: ScreenParamsType = ...

Settings

Member Visibility

On This Page

Constructors
Properties