CloudHub Docs
Download Documents

Cloud Recording

Cloud recording SDK

Interface related


Start playback



onSuccessEnter the callback for successful playback, the function ((data) =>{}), where data is the setting of the room (room.json)

Note: The method in the playback must be called after the successful callback


Get a new engine。


The return parameters are:

engineA new engine is the same as the instance in cloudhub-electron-sdk

Note: The new RtcEngine needs to replace the old RtcEngine. The new RtcEngine needs to be used in the playback program. It has all the properties and methods of the old RtcEngine, and the parameters passed when used need to be the same as the original ones.


Get the room number of the current playback program。


The return parameters are:

channelIdCurrent room number


Set the playback progress.


The return parameters are:

positionProgress (unit: ms)

Note: Only fast forward, not backward! If you want to rewind after fast forwarding, it is recommended to refresh the page and start again. After calling the fast forward method, all the behaviors in this period will be returned by callback within a few seconds. At this point, your project is already in the timeline after fast forward. If you go backwards, duplicate data will occur. forExample:Fast forward to ten minutes first, and the project is now ten minutes later. All the behaviors in the first ten minutes have been returned. If you go back to five minutes at this time, the sdk will return data from five minutes. Then these actions between five and ten minutes will be repeated again, which will become duplicate data. Possibly, it will cause unnecessary problems in your project。


Send error message.


If there is an error, you can call Cloud Hub Playback.send Error(message) to write to the server log

Detailed content

Web Address

The address of your playback program.

It is recommended to use http or https link, the local path may cause the playback not to enter.

Record Address

The data file of a certain channel you need to record

Note: CloudHub will call cloudhub-electron-sdk on you. During this period of the recording method, record your actions in this file. For the method of obtaining this file, please consult the docking personnel.

Switch mode

You can set the tuning mode in the system settings

Note: Debug mode is turned off by default. Turn on the debug mode before opening the player, and the started playback program will automatically open the console and output the logs related to the playback SDK.