public class AgoraServiceConfiguration
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
private java.lang.String |
appId
The App ID of your project.
|
private int |
areaCode
The supported area code, default is AREA_CODE_GLOB
|
private int |
audioScenario
The audio scenario.
|
private int |
channelProfile
The channel profile.
|
private java.lang.Object |
context
The user context.
|
private boolean |
domainLimit
Determines whether to enable domain limit.
|
private boolean |
enableAudioDevice
Whether to enable the audio device module.
|
private boolean |
enableAudioProcessor
Whether to enable the audio processing module.
|
private boolean |
enableVideo
Whether to enable video.
|
private java.lang.String |
license
The license used for verification when connecting channel.
|
private LogConfig |
logConfig
The config for customer set log path, log size and log level.
|
private boolean |
useExternalEglContext
Whether use egl context in current thread as sdk's root egl context
which shared by all egl related modules.
|
private boolean |
useStringUid
Whether to enable string uid.
|
| Constructor and Description |
|---|
AgoraServiceConfiguration()
Constructs an AgoraServiceConfiguration instance with default values.
|
AgoraServiceConfiguration(boolean enableAudioProcessor,
boolean enableAudioDevice,
boolean enableVideo,
java.lang.Object context,
java.lang.String appId,
Constants.AreaCode areaCode,
Constants.ChannelProfileType channelProfile,
java.lang.String license,
Constants.AudioScenarioType audioScenario,
LogConfig logConfig,
boolean useStringUid,
boolean useExternalEglContext,
boolean domainLimit)
Constructs an AgoraServiceConfiguration instance with specified parameters.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAppId()
Gets the App ID.
|
Constants.AreaCode |
getAreaCode()
Gets the area code.
|
Constants.AudioScenarioType |
getAudioScenario()
Gets the audio scenario.
|
Constants.ChannelProfileType |
getChannelProfile()
Gets the channel profile.
|
java.lang.Object |
getContext()
Gets the context object.
|
java.lang.String |
getLicense()
Gets the license string.
|
LogConfig |
getLogConfig()
Gets the log configuration.
|
boolean |
isDomainLimit()
Gets whether domain limiting is enabled.
|
boolean |
isEnableAudioDevice()
Gets whether the audio device is enabled.
|
boolean |
isEnableAudioProcessor()
Gets whether the audio processor is enabled.
|
boolean |
isEnableVideo()
Gets whether video is enabled.
|
boolean |
isUseExternalEglContext()
Gets whether external EGL context is used (Android only).
|
boolean |
isUseStringUid()
Gets whether string user IDs are enabled.
|
void |
setAppId(java.lang.String appId)
Sets the App ID.
|
void |
setAreaCode(Constants.AreaCode areaCode)
Sets the area code.
|
void |
setAudioScenario(Constants.AudioScenarioType audioScenario)
Sets the audio scenario.
|
void |
setChannelProfile(Constants.ChannelProfileType channelProfile)
Sets the channel profile.
|
void |
setContext(java.lang.Object context)
Sets the context object.
|
void |
setDomainLimit(boolean domainLimit)
Sets whether to enable domain limiting.
|
void |
setEnableAudioDevice(boolean enableAudioDevice)
Sets whether to enable the audio device.
|
void |
setEnableAudioProcessor(boolean enableAudioProcessor)
Sets whether to enable the audio processor.
|
void |
setEnableVideo(boolean enableVideo)
Sets whether to enable video.
|
void |
setLicense(java.lang.String license)
Sets the license string.
|
void |
setLogConfig(LogConfig logConfig)
Sets the log configuration.
|
void |
setUseExternalEglContext(boolean useExternalEglContext)
Sets whether to use external EGL context (Android only).
|
void |
setUseStringUid(boolean useStringUid)
Sets whether to use string user IDs.
|
java.lang.String |
toString()
Returns a string representation of this configuration object.
|
private boolean enableAudioProcessor
private boolean enableAudioDevice
In the recording scenario, ensure that you set `enableAudioDevice` as `false`. If you set it to `true`, the SDK reports an error, because the recorder does not have any audio device.
private boolean enableVideo
private java.lang.Object context
private java.lang.String appId
private int areaCode
private int channelProfile
private java.lang.String license
private int audioScenario
private LogConfig logConfig
private boolean useStringUid
private boolean useExternalEglContext
private boolean domainLimit
public AgoraServiceConfiguration()
public AgoraServiceConfiguration(boolean enableAudioProcessor,
boolean enableAudioDevice,
boolean enableVideo,
java.lang.Object context,
java.lang.String appId,
Constants.AreaCode areaCode,
Constants.ChannelProfileType channelProfile,
java.lang.String license,
Constants.AudioScenarioType audioScenario,
LogConfig logConfig,
boolean useStringUid,
boolean useExternalEglContext,
boolean domainLimit)
enableAudioProcessor - Whether to enable the audio processing moduleenableAudioDevice - Whether to enable the audio device moduleenableVideo - Whether to enable videocontext - The user context (Activity context for Android)appId - The App ID of your projectareaCode - The supported area codechannelProfile - The channel profilelicense - The license for verificationaudioScenario - The audio scenariologConfig - The logging configurationuseStringUid - Whether to enable string user IDsuseExternalEglContext - Whether to use external EGL context (Android
only)domainLimit - Whether to enable domain limitingpublic boolean isEnableAudioProcessor()
public void setEnableAudioProcessor(boolean enableAudioProcessor)
enableAudioProcessor - true to enable, false to disablepublic boolean isEnableAudioDevice()
public void setEnableAudioDevice(boolean enableAudioDevice)
enableAudioDevice - true to enable, false to disablepublic boolean isEnableVideo()
public void setEnableVideo(boolean enableVideo)
enableVideo - true to enable, false to disablepublic java.lang.Object getContext()
public void setContext(java.lang.Object context)
context - The context object (Activity context for Android)public java.lang.String getAppId()
public void setAppId(java.lang.String appId)
appId - The App ID stringpublic Constants.AreaCode getAreaCode()
public void setAreaCode(Constants.AreaCode areaCode)
areaCode - The area code valuepublic Constants.ChannelProfileType getChannelProfile()
public void setChannelProfile(Constants.ChannelProfileType channelProfile)
channelProfile - The channel profile valuepublic java.lang.String getLicense()
public void setLicense(java.lang.String license)
license - The license stringpublic Constants.AudioScenarioType getAudioScenario()
public void setAudioScenario(Constants.AudioScenarioType audioScenario)
audioScenario - The audio scenario valuepublic LogConfig getLogConfig()
public void setLogConfig(LogConfig logConfig)
logConfig - The LogConfig instancepublic boolean isUseStringUid()
public void setUseStringUid(boolean useStringUid)
useStringUid - true to enable, false to disablepublic boolean isUseExternalEglContext()
public void setUseExternalEglContext(boolean useExternalEglContext)
useExternalEglContext - true to enable, false to disablepublic boolean isDomainLimit()
public void setDomainLimit(boolean domainLimit)
domainLimit - true to enable, false to disablepublic java.lang.String toString()
toString in class java.lang.Object