Package io.agora.rtc2

Class RtcEngineConfig

java.lang.Object
io.agora.rtc2.RtcEngineConfig

public class RtcEngineConfig extends Object
Configurations for the RtcEngine instance.
  • Field Details

    • mEventHandler

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

      public Context mContext
      The context of Android Activity.
    • mAppId

      public String 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 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

      public int 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

      public int 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

      public String mLicense
      The license used for verification when connectting channel. Charge according to the license
    • mAudioScenario

      public int mAudioScenario
      The audio application scenario. See AudioScenario.
    • mAutoRegisterAgoraExtensions

      public boolean 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

      public List<String> mExtensionList
      The extension list need to preload
    • mExtensionObserver

      public IMediaExtensionObserver mExtensionObserver
    • mLogConfig

      public RtcEngineConfig.LogConfig mLogConfig
    • mThreadPriority

      public Integer mThreadPriority
      Thread priority type. see ThreadPriorityType
    • mNativeLibPath

      public String mNativeLibPath
      native c++ dynamic library path. If valued, SDK will use System.load(String) to load the library at the specify path; otherwise, System.loadLibrary(String)} will be used.
    • mDomainLimit

      public boolean 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
  • Constructor Details

    • RtcEngineConfig

      public RtcEngineConfig()
  • Method Details

    • addExtension

      public void addExtension(String providerName)
    • getContext

      public Context getContext()
    • getAppId

      public String getAppId()
    • getChannelProfile

      public int getChannelProfile()
    • getLicense

      public String getLicense()
    • getAudioScenario

      public int getAudioScenario()
    • getAreaCode

      public int getAreaCode()
    • getExtensionObserver

      public IMediaExtensionObserver getExtensionObserver()
    • getLogConfig

      public RtcEngineConfig.LogConfig getLogConfig()
    • getThreadPriority

      public Integer getThreadPriority()
    • getDomainLimit

      public boolean getDomainLimit()
    • getAutoRegisterAgoraExtensions

      public boolean getAutoRegisterAgoraExtensions()
    • getNativeLibPath

      public String getNativeLibPath()