Agora Java API Reference for Android
Classes | Public Member Functions | Public Attributes | List of all members
io.agora.rtc2.RtcEngineConfig Class Reference

Classes

class  LogConfig
 

Public Member Functions

void addExtension (String providerName)
 
Context getContext ()
 
String getAppId ()
 
int getChannelProfile ()
 
int getAudioScenario ()
 
boolean isAudioDeviceEnabled ()
 
int getAreaCode ()
 
IMediaExtensionObserver getExtensionObserver ()
 
LogConfig getLogConfig ()
 

Public Attributes

Context mContext
 
String mAppId
 
Constants.AreaCode mAreaCode
 
IAgoraEventHandler mEventHandler
 
int mChannelProfile
 
int mAudioScenario
 
boolean mEnableAudioDevice
 
List< String > mExtensionList
 
IMediaExtensionObserver mExtensionObserver
 
LogConfig mLogConfig
 
String mNativeLibPath
 

Detailed Description

Configurations for the RtcEngine instance.

Member Data Documentation

◆ 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

Constants.AreaCode 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.

◆ mEventHandler

IAgoraEventHandler io.agora.rtc2.RtcEngineConfig.mEventHandler

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

◆ 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.

◆ mAudioScenario

int io.agora.rtc2.RtcEngineConfig.mAudioScenario

The audio application scenario. See AudioScenario.

◆ mEnableAudioDevice

boolean io.agora.rtc2.RtcEngineConfig.mEnableAudioDevice

Determines whether to enable audio device -true: (Default) enable audio device -false, disable audio device. If you want to pull the decoded and mixed audio data for playback from RtcEngine#pullPlaybackAudioFrame(ByteBuffer, int). This value must be false

◆ 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.