Documentation
On-Premises Recording
API Documents

Client API

Last updated：2022-03-23 14:56

ZEGO provides services for Recording audio and Video Calling, live audio and Video, and Stream Mixing Video .

Functional interface

Method	Description
SetCallback	Set the callback monitoring related to the Recording SDK.
Initialize
SetUser	Set user information.
InitSDK	Initialize SDK.
InitSDK	Initialization SDK, supported by ga01596a1c8 and above (released on 2022-03-23).
UnInitSDK	Uninitialize SDK.
Environment Configuration
SetCustomToken	Set custom token information.
GetSDKVersion	Get the SDK version.
SDK Logs
SetLogDirAndSize	Set the SDK log path and single log file size.
UploadLog	Upload log files to ZEGO backend.
Log in and log out
LoginRoom	Login to the room.
LogoutRoom	Log out of the room.
Recording
SetConfig	Set configuration information.
GetMaxRecordCount	Get the maximum number of simultaneous Recording streams supported by the SDK.
SetMuxerOutType	Set the Recording data output method.
SetMuxerCacheSize	Set the cache size (64 KB ~ 1 MB) before the file is landed, in bytes.
EnableSingleAndMixRecordMode	Sets whether to enable single-stream Stream Mixing-stream simultaneous Recording mode. Enabling this mode consumes system resources.
EnableExternalRender	Sets whether to enable external rendering.
StartRecordSingleStream	Starts single-stream Recording.
StopRecordSingleStream	Stop single stream Recording.
Stream Mixing	Starts Recording mix.
UpdateInputStreamConfig	Updates the input stream configuration for Stream Mixing Recording.
UpdateImageWaterMarkConfig	Update image Watermark configuration.
Stream Mixing	Stops the mix stream Recording.
GetRecordLastMediaSideTime	Get the time interval between the last received Media Side Info packet and the first Recording packet.
GetRecordStatus	Get the current Recording status.

event callback

Method	Description
OnInitSDK	InitSDK callback.
OnLoginRoom	Login room success callback.
OnLogoutRoom	Exit room callback.
OnDisconnect	Disconnect notification from server.
OnStreamUpdate	Stream information update.
OnVideoDataCallback	Video frame data callback, do not do time-consuming operations in the callback function.
onRecvMediaSideInfo	Media secondary info callback.
Recording event callback
OnStreamRecordBegin	Recording start callback.
OnStreamRecordEnd	Recording end callback.
OnStreamRecordEvent	Recording event callback.
OnStreamRecordData	Recording data callback.
OnMixStreamRecordUpdate	Stream Mixing stream Recording information update callback.