io.agora.rtc.AgoraServiceConfig类 参考

AgoraService 类的全局配置。

在调用 initialize 时设置。

构造及析构函数说明

AgoraServiceConfig() [1/2]

io.agora.rtc.AgoraServiceConfig.AgoraServiceConfig

(

)

AgoraServiceConfig() [2/2]

io.agora.rtc.AgoraServiceConfig.AgoraServiceConfig	(	int	enableAudioProcessor,
		int	enableAudioDevice,
		int	enableVideo,
		Object	context,
		java.lang.String	appId,
		int	areaCode,
		int	channelProfile,
		int	audioScenario,
		int	useStringUid,
		String	logFilePath,
		int	logFileSize,
		int	logFilters,
		int	domainLimit )

成员函数说明

getAppId()

String io.agora.rtc.AgoraServiceConfig.getAppId

(

)

getAreaCode()

int io.agora.rtc.AgoraServiceConfig.getAreaCode

(

)

getAudioScenario()

int io.agora.rtc.AgoraServiceConfig.getAudioScenario

(

)

getChannelProfile()

int io.agora.rtc.AgoraServiceConfig.getChannelProfile

(

)

getContext()

Object io.agora.rtc.AgoraServiceConfig.getContext

(

)

getDomainLimit()

int io.agora.rtc.AgoraServiceConfig.getDomainLimit

(

)

getEnableAudioDevice()

int io.agora.rtc.AgoraServiceConfig.getEnableAudioDevice

(

)

getEnableAudioProcessor()

int io.agora.rtc.AgoraServiceConfig.getEnableAudioProcessor

(

)

getEnableVideo()

int io.agora.rtc.AgoraServiceConfig.getEnableVideo

(

)

getLogFilePath()

String io.agora.rtc.AgoraServiceConfig.getLogFilePath

(

)

getLogFileSize()

int io.agora.rtc.AgoraServiceConfig.getLogFileSize

(

)

getLogFilters()

int io.agora.rtc.AgoraServiceConfig.getLogFilters

(

)

getUseStringUid()

int io.agora.rtc.AgoraServiceConfig.getUseStringUid

(

)

setAppId()

void io.agora.rtc.AgoraServiceConfig.setAppId

(

String

appId

)

setAreaCode()

void io.agora.rtc.AgoraServiceConfig.setAreaCode

(

int

areaCode

)

setAudioScenario()

void io.agora.rtc.AgoraServiceConfig.setAudioScenario

(

int

audioScenario

)

setChannelProfile()

void io.agora.rtc.AgoraServiceConfig.setChannelProfile

(

int

channelProfile

)

setContext()

void io.agora.rtc.AgoraServiceConfig.setContext

(

Object

context

)

setDomainLimit()

void io.agora.rtc.AgoraServiceConfig.setDomainLimit

(

int

domainLimit

)

setEnableAudioDevice()

void io.agora.rtc.AgoraServiceConfig.setEnableAudioDevice

(

int

enableAudioDevice

)

setEnableAudioProcessor()

void io.agora.rtc.AgoraServiceConfig.setEnableAudioProcessor

(

int

enableAudioProcessor

)

setEnableVideo()

void io.agora.rtc.AgoraServiceConfig.setEnableVideo

(

int

enableVideo

)

setLogFilePath()

void io.agora.rtc.AgoraServiceConfig.setLogFilePath

(

String

logFilePath

)

setLogFileSize()

void io.agora.rtc.AgoraServiceConfig.setLogFileSize

(

int

logFileSize

)

setLogFilters()

void io.agora.rtc.AgoraServiceConfig.setLogFilters

(

int

logFilters

)

setUseStringUid()

void io.agora.rtc.AgoraServiceConfig.setUseStringUid

(

int

useStringUid

)

toString()

String io.agora.rtc.AgoraServiceConfig.toString

(

)

类成员变量说明

private

appId

String io.agora.rtc.AgoraServiceConfig.appId

你的声网项目的 App ID。

private

areaCode

int io.agora.rtc.AgoraServiceConfig.areaCode = Constants.AREA_CODE_GLOB

服务器的访问区域。该功能为高级设置，适用于有访问安全限制的场景。指定访问区域后，SDK 会连接指定区域内的声网服务器。

• 0x00000001: 中国大陆。
  
• 0x00000002: 北美区域。
  
• 0x00000004: 欧洲区域。
  
• 0x00000008: 除中国大陆以外的亚洲区域。
  
• 0x00000010: 日本。
  
• 0x00000020: 印度。
  
• 0xFFFFFFFF:（默认）全球。
  

private

audioScenario

int io.agora.rtc.AgoraServiceConfig.audioScenario = Constants.AUDIO_SCENARIO_CHORUS

音频编码属性：

• 0: (推荐) 默认的音频应用场景。
  
• 3: (推荐) 游戏开黑场景，适用于高清音乐播放的场景。
  
• 5: 语聊场景。该场景通常在 setClientRole 设置用户角色为观众后仍需要录制。
  
• 6:（推荐）高清场景。适用于高清音质的场景。
  
• 7:（默认）合唱场景。
  

private

channelProfile

int io.agora.rtc.AgoraServiceConfig.channelProfile = Constants.CHANNEL_PROFILE_LIVE_BROADCASTING

频道使用场景：

• 0: 通信场景。当频道中只有两个用户时，建议使用该场景。
  
• 1: （默认）直播场景。当频道中有两个以上的用户时，使用该场景。
  

private

context

Object io.agora.rtc.AgoraServiceConfig.context

用户 Context 信息。

• 在 Windows 上，用来指加载视频的窗口句柄。如果你需要在主播直播时热插拔视频设备，需要设置该值。
  
• 在 Android 上，指 Activity 的 Context 信息。
  

private

domainLimit

int io.agora.rtc.AgoraServiceConfig.domainLimit

是否开启域名限制：

• 1: 仅连接被 DNS 解析过服务器。
  
• 0:（默认）连接服务器无限制。
  

private

enableAudioDevice

int io.agora.rtc.AgoraServiceConfig.enableAudioDevice = 0

是否开启音频设备模块（Audio Device Module, ADM）。 ADM 用来管理音频设备，例如录制和播放音频。如果你将 enableAudioDevice 设为 false 且将 enableAudioProcessor 设为 true，你将无法使用音频设备，但你可以推送 PCM 音频数据。

• true: 开启音频设备模块。你可以录制和播放音频。
  
• false: (默认) 关闭音频设备模块。你无法录制和播放音频。
  

private

enableAudioProcessor

int io.agora.rtc.AgoraServiceConfig.enableAudioProcessor = 1

是否开启音频处理模块：

• true: (默认) 开启音频处理模块。
  
• false: 关闭音频处理模块。你将无法创建音频轨道。
  

private

enableVideo

int io.agora.rtc.AgoraServiceConfig.enableVideo = 0

是否开启视频：

• true：开启视频。
  
• false：(默认)关闭视频。
  

private

logFilePath

String io.agora.rtc.AgoraServiceConfig.logFilePath

日志文件路径，默认值为 NULL，表示使用默认的路径。

private

logFileSize

int io.agora.rtc.AgoraServiceConfig.logFileSize = 2048

日志文件大小，单位为 KB。默认大小为 2048。

private

logFilters

int io.agora.rtc.AgoraServiceConfig.logFilters = Constants.LOG_FILTER_INFO

日志过滤等级。默认为 LOG_FILTER_INFO。

• 0：不输出任何日志
  
• 0x80f：输出所有日志
  
• 0x0f：（默认）输出 CRITICAL、ERROR、WARNING 和 INFO 级别的日志
  
• 0x0e：输出 CRITICAL、ERROR 和 WARNING 级别的日志
  
• 0x0c：输出 CRITICAL 和 ERROR 级别的日志
  
• 0x08：输出 CRITICAL 级别的日志
  

private

useStringUid

int io.agora.rtc.AgoraServiceConfig.useStringUid

是否允许 String UID：

• true: 允许。
  
• false:（默认）不允许。