On-Premises Recording
  • Overview
  • SDK Downloads
  • Sample Codes
  • Quick Starts
  • Performance Data
  • API Documents
On-Premises Recording SDK
2022-03-23Version: ga01596a1c8

New Features

  1. Optimized the authentication method

For versions ga01596a1c8 and above, AppSign is not passed when initializing the SDK, and the Token must be passed to the SDK through the SetCustomToken interface before logging in to the room. For details, please refer to Using Token Authentication.

For versions before ga01596a1c8, AppSign needs to be passed in when initializing the SDK.

For related APIs, please refer to InitSDK, SetCustomToken

2021-12-02Version: gd2ef35d43f

New Features

  1. Adapt to H.265 solution

The complete H.265 encoding and decoding solution is launched, which is suitable for single-host live broadcast and multi-person interactive live broadcast scenarios. This plug-in is mainly adapted to the H.265 automatic downgrade (H.254 downgrade to H.264) capability of RTC products, and two files (one for H.254 and one for H.264) will be generated during Recording.

  1. Supports taking Snapshot of specified streams.
  2. When external capture, support capture Audio input source.
  3. During the Stream Mixing stream Recording process, the following functions are added:
  • Support setting image Watermark.
  • During Stream Mixing stream Recording, support pause/resume Recording .
  • When Recording Stream Mixing streams, you can set a background image for the specified stream.


In order to reduce developers' understanding of the environment, the test environment was abandoned and the environment was used uniformly. In gd2ef35d43f and above versions, the original [SetUseTestEnv] setting is abandoned to set whether to use the test environment interface. Developers can use it directly without setting the environment information.

2021-03-05Version: g22ad96a1f9

New Features

  1. Support mixed-flow screen output image watermark and text watermark.

For related API, please refer to UpdateImageWaterMarkConfig

2020-12-09Version: g5dbbce505a

New Features

  1. Recording supports m3u8 file format.

  2. Support setting layout mode (cropped or black border).

  3. Stream update callback adds stream creation time information.

  4. Support external input video data setting bit rate.

  5. Support external input video data as recording input source.


  1. Time stamp correction of mixed stream recording video, more uniform, aligned with the frame rate.

  2. Mixed stream recording supports more stream recording and fixes the previous bottleneck problem.

  3. Optimized recording in MP3 format to fill mute data.

  4. Optimized domain name resolution may take too long.

Bug Fixes

  1. Fix the problem that the audio format of single-stream recording input stream is switched and the sound of the recording file is not available.

  2. Increase the data cache, fix the problem that caused the system to get stuck when the IO time is long.

  3. Fix the problem that OnRecordEnd may be called back multiple times.

  4. Fix the problem that there is no callback recording failure when the single-stream recording exceeds the upper limit.

  5. Fix the crash caused by inputting duplicate stream ID during mixed stream recording.

  6. Fix the problem of unable to exit the room.

2020-08-10Version: g3896eefc2

New Features

  1. Supports simultaneous generation of MP3 files corresponding to the mixed stream when single stream and mixed stream are recorded at the same time.
  2. Support separate recording of video and audio.
2020-06-05Version: g64ae32b1f

Bug Fixes

  1. Fix the bug that if you stop recording after the first recording and then start the second recording without logging out of the room, there will be no sound in the second recording file.
2020-04-30Version: g709410abf

New Features

  1. Login authentication function Added SetCustomToken interface, used to set custom authentication information to verify the legitimacy of the user when logging in.

  2. Set user information Added SetUser interface for setting user name related information.

  3. Get the absolute timestamp of the start of the recording In online education scenarios, there may be cases where the teacher’s live stream is pushed and the whiteboard is edited at the same time. The customer can record the teacher’s live audio and video stream through the instant recording SDK, and obtain the absolute timestamp of the teacher when the recording starts, which is used for the teacher’s audio and video Alignment processing of recorded files and whiteboard data. (1) Added onRecvMediaSideInfo callback, which can be sent to the media to receive secondary push information. (2) Add the GetRecordLastMediaSideTime interface to get the time interval between the first received media secondary information packet and the first recording.

    The push end periodically sends the secondary media information (fill in the current absolute timestamp) after starting the push, and after receiving it, the recording end subtracts the parsed timestamp from the time returned by GetRecordLastMediaSideTime to get the start recording Absolute timestamp.

  4. Get information about the recording file Added GetRecordStatus interface to obtain the storage path, recorded duration, and file size of the recording file.

  5. Added the function of setting watermark setting position, font color, and background color properties.

Bug Fixes

  1. Fix the bug that the error will not be called back when the flexible configuration fails to be pulled.
  2. Fix InitSDK when it fails, call LoginRoom.
  3. When a stream is deleted in the mixed stream input, call back OnMixStreamRecordUpdate.
2019-12-18Version: g133f0c096

Bug Fixes

  1. Fixed the problem of inaccurate callback error code when recording stopped after streaming failed.
  2. Fix the problem of inaccurate recording file duration when the stream is interrupted during single-stream recording.
2019-10-29Version: gf7c3cd37b


  1. Increase OnSeek callback, because OnStreamRecordData callback data is not the order in which to store recorded When data is being recorded, the offset position of the written data can be adjusted according to the OnSeek callback to ensure that the recorded data is a continuous audio and video.
  2. Mixed stream recording supports auto-fill video.
  3. Fix other known issues.
2019-06-11Version: g99f5b93e


  1. Francis recorded StartRecordMixStream interface ZegoMixStreamRecordConfig bGenerateMp3 new configuration parameters, generate support Separate audio files are generated at the same time as the video files, that is, Mp3 and Mp4 files are generated at the same time.


The API changes in the g99f5b93e version are as follows.


  • StartRecordMixStream
Page Directory