Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RtcEngineConfig

Configurations for the RtcEngine.

deprecated

As of v3.4.5, this class is deprecated. Use RtcEngineContext instead.

since

v3.3.1

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

appId

appId: string

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.

Optional areaCode

areaCode: AreaCode[]

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.

Optional logConfig

logConfig: 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.

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

Generated using TypeDoc