Agora C++ API Reference for All Platforms
agora::rtc::RtcEngineContext Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions

 RtcEngineContext ()

Public Attributes

const char * appId
void * context
unsigned int areaCode
LogConfig logConfig

Detailed Description

Definition of RtcEngineContext.

Constructor & Destructor Documentation

◆ RtcEngineContext()

agora::rtc::RtcEngineContext::RtcEngineContext ( )

Member Data Documentation

◆ eventHandler

IRtcEngineEventHandler* agora::rtc::RtcEngineContext::eventHandler

◆ appId

const char* agora::rtc::RtcEngineContext::appId

The App ID issued to you by Agora. See How to get the App ID. Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to create only one IRtcEngine instance. To change your App ID, call release to destroy the current IRtcEngine instance and then call createAgoraRtcEngine and initialize to create an IRtcEngine instance with the new App ID.

◆ context

void* agora::rtc::RtcEngineContext::context

The video window handle. Once set, this parameter enables you to plug or unplug the video devices while they are powered.

◆ areaCode

unsigned int agora::rtc::RtcEngineContext::areaCode

The region for connection. This advanced feature applies to scenarios that have regional restrictions.

For the regions that Agora supports, see AREA_CODE. The area codes support bitwise operation.

After specifying the region, the SDK connects to the Agora servers within that region.

◆ logConfig

LogConfig agora::rtc::RtcEngineContext::logConfig

The configuration of the log files that the SDK outputs. See LogConfig.


By default, the SDK outputs five log files, agorasdk.log, agorasdk_1.log, agorasdk_2.log, agorasdk_3.log, agorasdk_4.log, each with a default size of 1024 KB. These log files are encoded in UTF-8. The SDK writes the latest logs in agorasdk.log. When agorasdk.log is full, the SDK deletes the log file with the earliest modification time among the other four, renames agorasdk.log to the name of the deleted log file, and creates a new agorasdk.log to record latest logs.