Tutorial: Setting Local Video Properties

This document describes how to set video properties for a video call or live streaming session. You can set the properties according to your requirements on video quality and smoothness to deliver better user experience. Video properties include resolution, frame rate, and bitrate.

From 1 April 2023, streaming at 2k 4k resolution requires TRTC Monthly Package Premium and higher.

Method

You can call setVideoProfile() to set video properties.

• Using a predefined profile, which corresponds to a set of recommended resolution, frame rate, and bitrate

const localStream = TRTC.createStream({ userId, audio: true, video: true });
// Set the profile to 480p
localStream.setVideoProfile('480p');
localStream.initialize().then(() => {
  console.log('local stream init success');
  localStream.play('local_stream');
});

• Specifying a custom resolution, frame rate, and bitrate

const localStream = TRTC.createStream({ userId, audio: true, video: true });
// Specify a value for the resolution, frame rate, and bitrate
localStream.setVideoProfile({ width: 640, height: 480, frameRate: 15, bitrate: 900 /* kpbs */});
localStream.initialize().then(() => {
  console.log('local stream init success');
  localStream.play('local_stream');
});

Note

You must call setVideoProfile() before calling initialize() to initialize the local stream. You cannot change video properties during a call.

Video Profiles

• The target resolution of a profile may be unattainable due to device and browser restrictions, in which case the browser will adjust the resolution to make it as close as possible to the target.