Class VParams

The VParams service provides encoding parameters for video in a media session using the Mediasoup library. It includes a default configuration for RTP encoding parameters optimized for video streaming.

Service

Example

import { VParams } from './path/to/v-params.service';

constructor(private vParamsService: VParams) {
  console.log(this.vParamsService.vParams);
}

Example

const vParams: VParamsType = {
  encodings: [
    {
      rid: 'r3',
      maxBitrate: 200000, // Max bitrate for this encoding (in bps)
      scalabilityMode: 'L1T3', // Scalability mode for encoding
      scaleResolutionDownBy: 4.0, // Scale down resolution by this factor
    },
    {
      rid: 'r4',
      maxBitrate: 400000,
      scalabilityMode: 'L1T3',
      scaleResolutionDownBy: 2.0,
    },
    {
      rid: 'r5',
      maxBitrate: 800000,
      scalabilityMode: 'L1T3',
    },
  ],
  codecOptions: {
    videoGoogleStartBitrate: 320, // Initial bitrate for the Google codec
  },
};

Remarks

The default vParams includes multiple encoding configurations with different maximum bitrates, allowing for adaptive streaming based on network conditions and participant capabilities.

Returns

The video parameters for use in video producer configuration.

Constructors

constructor

Properties

vParams

Constructors

constructor

Properties

vParams

vParams: VParamsType = ...

Settings

Member Visibility

On This Page

Constructors
Properties
MMNEPVFCICPMFPCPTTAAATR