Package io.agora.rtc2
Class RtcEngineConfig
java.lang.Object
io.agora.rtc2.RtcEngineConfig
Configurations for the
RtcEngine instance.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classRegions for connectionstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionThe App ID issued to you by Agora.intThe region for connection.intThe audio application scenario.booleanWhether to automatically register Agora extensions when initializing RtcEngine.intThe channel profile of the AgoraRtcEngine.ContextThe context of Android Activity.booleanDetermines whether to enable domain limit -true: only connect to servers which already parsed by DNS -false: (Default) connect to servers with no limitIRtcEngineEventHandleris an abstract class providing default implementation.The extension list need to preloadThe license used for verification when connectting channel.native c++ dynamic library path.Thread priority type. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddExtension(String providerName) getAppId()intintbooleanintContextboolean
-
Field Details
-
mEventHandler
IRtcEngineEventHandleris an abstract class providing default implementation. The SDK uses this class for reporting on SDK runtime events. -
mContext
public Context mContextThe context of Android Activity. -
mAppId
The App ID issued to you by Agora. See [How to get the App ID](https://docs.agora.io/en/Agora%20Platform/token#get-an-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 oneRtcEngineinstance. To change your App ID, call destroy todestroythe currentRtcEngineinstance and then call `create` to create anRtcEngineinstance with the new App ID. -
mAreaCode
public int mAreaCodeThe region for connection. This advanced feature applies to scenarios that have regional restrictions. For the regions that Agora supports, seeAreaCode. After specifying the region, the app that integrates the Agora SDK connects to the Agora servers within that region. -
mChannelProfile
public int mChannelProfileThe channel profile of the AgoraRtcEngine. 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
The license used for verification when connectting channel. Charge according to the license -
mAudioScenario
public int mAudioScenarioThe audio application scenario. SeeAudioScenario. -
mAutoRegisterAgoraExtensions
public boolean mAutoRegisterAgoraExtensionsWhether 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
The extension list need to preload -
mExtensionObserver
-
mLogConfig
-
mThreadPriority
Thread priority type. seeThreadPriorityType -
mNativeLibPath
native c++ dynamic library path. If valued, SDK will useSystem.load(String)to load the library at the specify path; otherwise,System.loadLibrary(String)} will be used. -
mDomainLimit
public boolean mDomainLimitDetermines whether to enable domain limit -true: only connect to servers which already parsed by DNS -false: (Default) connect to servers with no limit
-
-
Constructor Details
-
RtcEngineConfig
public RtcEngineConfig()
-
-
Method Details
-
addExtension
-
getContext
public Context getContext() -
getAppId
-
getChannelProfile
public int getChannelProfile() -
getLicense
-
getAudioScenario
public int getAudioScenario() -
getAreaCode
public int getAreaCode() -
getExtensionObserver
-
getLogConfig
-
getThreadPriority
-
getDomainLimit
public boolean getDomainLimit() -
getAutoRegisterAgoraExtensions
public boolean getAutoRegisterAgoraExtensions() -
getNativeLibPath
-