Agora Java API Reference for Android
io.agora.rtc.RtcEngineConfig Class Reference


class  AreaCode
class  LogConfig

Public Attributes

Context mContext
String mAppId
int mAreaCode
IRtcEngineEventHandler mEventHandler
LogConfig mLogConfig

Detailed Description

Configurations for the RtcEngine instance.

Member Data Documentation

◆ mContext

Context io.agora.rtc.RtcEngineConfig.mContext

The context of Android Activity.

◆ mAppId

String io.agora.rtc.RtcEngineConfig.mAppId

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 RtcEngine instance. To change your App ID, call destroy to destroy the current RtcEngine instance and then call create to create an RtcEngine instance with the new App ID.

◆ mAreaCode

int io.agora.rtc.RtcEngineConfig.mAreaCode

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

For the regions that Agora supports, see AreaCode. The area codes support bitwise operation. After specifying the region, the SDK connects to the Agora servers within that region.

◆ mEventHandler

IRtcEngineEventHandler io.agora.rtc.RtcEngineConfig.mEventHandler

IRtcEngineEventHandler is an abstract class providing default implementation. The SDK uses this class for reporting on SDK runtime events.

◆ mLogConfig

LogConfig io.agora.rtc.RtcEngineConfig.mLogConfig

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.

The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable.