Tutorial: Upgrade Guide

Upgrade Guide

Please note that there are interface changes or Breaking Changes in the following SDK versions.

Version 5.6.0 @2024.5.17

Breaking Changed

In versions before v5.6.0, SDK will enable autoReceiveVideo by default, which means that SDK will receive remote video automatically when remote user video stream is published. But sometimes your business scenario is to receive the remote video stream on demand, in this case, autoReceiveVideo will cause additional bandwidth consumption.

In v5.6.0 and later, SDK set autoReceiveVideo to false by default, which means that SDK will not receive remote video automatically when remote user video stream is published. You should call trtc.startRemoteVideo to receive and play remote video when you needed. This breaking changed can reduce unnecessary bandwidth usage.

We recommend you set autoReceiveVideo to true in following cases:

  1. You want to see the remote video as quickly as possible. autoReceiveVideo = true will receive video stream ahead of time, so you can play remote video faster when you call trtc.startRemoteVideo.
  2. The remote side does not publish the video stream, but publish the black frame video all the way for sending the SEI message. At this point, for the receiving end, the black frame video stream does not need to be played by trtc.startRemoteVideo. Therefore, you can also set autoReceiveVideo = true to ensure that SEI messages are received normally.

Version 5.1.0 @2023.08.11

Background

  • The string type roomId "123" is not the same room as the numeric type roomId 123.
  • Before version v5.1.0, the roomId parameter of the trtc.enterRoom interface supported both number and string types. It was easy to encounter situations where different roomId types caused communication issues between different platforms.

Breaking Changed

To prevent the above situation, starting from version v5.1.0, the roomId parameter of the trtc.enterRoom interface is limited to the number type and no longer supports string type. If you want to use a string roomId, please use the strRoomId parameter.