IRTCEngine

Create IRTCEngine

RTCENGINE_API StatusCode RTCENGINE_CALL RTCEngine_Init(IRTCEngine** rtc, RTCEngineOptions* opt);

Parameters

rtc	The IRTCEngine object; nullptr on failure
opt	Engine initialization options, RTCEngineOptions. Passing nullptr writes no SDK log at all

Note: the log switch and log path used to be on IRTCSetting (enable_stream_log / sdk_log_path) and have moved here— they’re consumed while the engine itself initializes, before any channel object exists.

Release IRTCEngine

RTCENGINE_API void RTCENGINE_CALL RTCEngine_Free(IRTCEngine** rtc);

Parameters

rtc	The IRTCEngine object

Get the version number

RTCENGINE_API StatusCode RTCENGINE_CALL RTCEngine_Version(const char*v1);

Parameters

v1	SDK version number

Note: the caller must allocate the memory before passing it in, at least 100 bytes.

Get the error code description

RTCENGINE_API void RTCENGINE_CALL RTCEngine_GetStatusMsg(StatusCode code, char* msg);

Parameters

code	Error code
msg	Error code description

Note: the caller must allocate the memory for msg before passing it in, at least 100 bytes. The text is GBK-encoded Chinese.

Basic functions

Set the event handler

virtual StatusCode setEventHandler(IRTCEngineEvent* e) = 0;

Parameters

e	An implementation of the pure virtual event callback class; for the callbacks, see IRTCEngineEvent

Channel functions

You can join multiple channels at the same time. Each channel corresponds to an IRTCChannel object, and channel-level methods and callbacks are all on that object, instead of being distinguished by a leading channelId parameter on IRTCEngine as in older versions. About channelId

channelId is the value of the channel field in the token. The SDK parses it internally, and you get it through IRTCChannel::getChannelId()
channelId is used only by leaveChannel and getChannelIds; all other methods are called directly on the channel object

Create a channel object

virtual StatusCode createChannel(const char* token, IRTCChannel** ch) = 0;

Parameters

token	The token required to join the channel
ch	Output parameter, the channel object. nullptr on failure

Note: this only creates the object and doesn’t join the channel. After you get the object, set up its configuration and event handler, then call IRTCChannel::join(). Creating the same channel again returns Conflict; if no channel can be parsed from the token, it returns SdkTokenInvalid.

Leave a channel

virtual void leaveChannel(const char* channelId) = 0;

Parameters

channelId	ID of the channel to leave

Leave all channels

virtual void leaveAllChannel() = 0;

Get the list of joined channels

virtual StatusCode getChannelIds(char** s, int* c) = 0;

Parameters

s	JSON array of joined channelIds, for example [“ch_a”,“ch_b”]
c	Length of the JSON array

Media streaming functions

Network speed test

	virtual StatusCode probeNetwork(int time, int upindex, int downindex) = 0;

Parameters

time	Duration of the speed test; a multiple of 10 is recommended
upindex	Uplink test amount (in KB); 0 skips the uplink test
downindex	Downlink test amount (in KB); 0 skips the downlink test

Note: the test results are returned in the callback.

Get camera info

virtual StatusCode getEnumVideo(char** devices, int* iSize) = 0;

Parameters

Devices	Camera info JSON, see Camera enumeration info
iSize	Length of the camera info JSON

Get screen info

virtual StatusCode getEnumScreen(char** devices, int* iSize) = 0;

Parameters

Devices	Screen info JSON, see Shared screen enumeration info
iSize	Length of the screen info JSON

Get microphone info

virtual StatusCode getEnumAudio(char** devices, int* iSize) = 0;

Parameters

Devices	Microphone info JSON, see Microphone info
iSize	Length of the microphone info JSON

Get speaker info

virtual StatusCode getEnumSpeaker(char** devices, int* iSize) = 0;

Parameters

Devices	Speaker info JSON, see Speaker info
iSize	Length of the speaker info JSON

Other

Add a log to upload

virtual StatusCode addUploadLog(const char* type ,const char* msg) = 0;

Parameters

type	Log type identifier
msg	Log content

Logs you add are uploaded to the log server.

Overview

Web SDK

Android SDK

Windows SDK

Swift SDK (iOS/macOS)

iOS SDK (Objective-C)

C SDK (server/embedded)

Python SDK (server-side AI)

Server API

IRTCEngine

IRTCEngine

Create IRTCEngine

Release IRTCEngine

Get the version number

Get the error code description

Basic functions

Set the event handler

Channel functions

Create a channel object

Leave a channel

Leave all channels

Get the list of joined channels

Media streaming functions

Network speed test

Get camera info

Get screen info

Get microphone info

Get speaker info

Other

Add a log to upload

​IRTCEngine

​Create IRTCEngine

​Release IRTCEngine

​Get the version number

​Get the error code description

​Basic functions

​Set the event handler

​Channel functions

​Create a channel object

​Leave a channel

​Leave all channels

​Get the list of joined channels

​Media streaming functions

​Network speed test

​Get camera info

​Get screen info

​Get microphone info

​Get speaker info

​Other

​Add a log to upload

IRTCEngine

Create IRTCEngine

Release IRTCEngine

Get the version number

Get the error code description

Basic functions

Set the event handler

Channel functions

Create a channel object

Leave a channel

Leave all channels

Get the list of joined channels

Media streaming functions

Network speed test

Get camera info

Get screen info

Get microphone info

Get speaker info

Other

Add a log to upload