Agora Java API Reference for Android

Classes | Public Member Functions | Public Attributes | List of all members
io.agora.rtc2.RtcEngineConfig Class Reference

## Classes
class | AreaCode
class | LogConfig

## Public Member Functions
void | addExtension (String providerName)
Context | getContext ()
String | getAppId ()
int | getChannelProfile ()
String | getLicense ()
int | getAudioScenario ()
int | getAreaCode ()
IMediaExtensionObserver | getExtensionObserver ()
LogConfig | getLogConfig ()
Integer | getThreadPriority ()
boolean | getDomainLimit ()
boolean | getAutoRegisterAgoraExtensions ()

## Public Attributes
IRtcEngineEventHandler | mEventHandler
Context | mContext
String | mAppId
int | mAreaCode
int | mChannelProfile
String | mLicense
int | mAudioScenario
boolean | mAutoRegisterAgoraExtensions
List< String > | mExtensionList
IMediaExtensionObserver | mExtensionObserver
LogConfig | mLogConfig
Integer | mThreadPriority
String | mNativeLibPath
boolean | mDomainLimit

## Detailed Description

Configurations for the RtcEngine instance.

## Member Data Documentation

## ◆ mEventHandler

IRtcEngineEventHandler io.agora.rtc2.RtcEngineConfig.mEventHandler

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

## ◆ mContext

Context io.agora.rtc2.RtcEngineConfig.mContext

The context of Android Activity.

## ◆ mAppId

String io.agora.rtc2.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.rtc2.RtcEngineConfig.mAreaCode

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

For the regions that Agora supports, see AreaCode. After specifying the region, the app that integrates the Agora SDK connects to the Agora servers within that region.

## ◆ mChannelProfile

int io.agora.rtc2.RtcEngineConfig.mChannelProfile

The channel profile of the Agora RtcEngine.

The Agora RtcEngine differentiates channel profiles and applies different optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for a video broadcast.

## ◆ mLicense

String io.agora.rtc2.RtcEngineConfig.mLicense

The license used for verification when connectting channel. Charge according to the license

## ◆ mAudioScenario

int io.agora.rtc2.RtcEngineConfig.mAudioScenario

The audio application scenario. See AudioScenario.

## ◆ mAutoRegisterAgoraExtensions

boolean io.agora.rtc2.RtcEngineConfig.mAutoRegisterAgoraExtensions

Whether to automatically register Agora extensions when initializing RtcEngine. -true: (Default) Automatically register Agora extensions. -false: Do not automatically register Agora extensions. The user calls EnableExtension to manually register an Agora extension.

## ◆ mExtensionList

List<String> io.agora.rtc2.RtcEngineConfig.mExtensionList

The extension list need to preload

## ◆ mThreadPriority

Integer io.agora.rtc2.RtcEngineConfig.mThreadPriority

Thread priority type. see ThreadPriorityType

## ◆ mNativeLibPath

String io.agora.rtc2.RtcEngineConfig.mNativeLibPath

native c++ dynamic library path.

If valued, SDK will use java.lang.System#load(String) to load the library at the specify path; otherwise, java.lang.System#loadLibrary(String)} will be used.

## ◆ mDomainLimit

boolean io.agora.rtc2.RtcEngineConfig.mDomainLimit

Determines whether to enable domain limit -true: only connect to servers which already parsed by DNS -false: (Default) connect to servers with no limit