AgoraService 类

AgoraService

Java

public AgoraService()

创建一个 AgoraService 实例并初始化原生组件。

一次只能初始化一个 AgoraService 实例。

getNativeHandle

Java

public long getNativeHandle()

获取与该 AgoraService 实例关联的原生句柄。

返回值

方法调用成功时，返回用于原生方法调用的原生句柄值。

release

Java

public int release()

释放 AgoraService 对象及其相关资源。

调用该方法后，该实例将失效，无法再使用。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。

initialize

Java

public int initialize(AgoraServiceConfiguration config)

使用指定配置初始化 AgoraService 对象。

参数

参数	数据类型	描述
config	AgoraServiceConfiguration	初始化参数配置对象。详见 AgoraServiceConfiguration。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。
  • ERR_INVALID_ARGUMENT：在 Android 平台未提供 AgoraServiceConfiguration 中的 context 时返回该错误。
  • ERR_INIT_NET_ENGINE：无法初始化网络引擎时返回该错误。在 Windows 平台，该错误通常发生在本地端口连接被防火墙阻止的情况下。尝试关闭防火墙再重新打开以解决该问题。

createAgoraMediaComponentFactory

Java

public AgoraMediaComponentFactory createAgoraMediaComponentFactory()

创建并返回一个用于创建媒体的 AgoraMediaComponentFactory 对象。

返回值

方法调用成功，返回 AgoraMediaComponentFactory 对象。

getAgoraParameter

Java

public AgoraParameter getAgoraParameter()

创建并返回用于参数管理的 AgoraParameter 对象。

返回值

方法调用成功，返回 AgoraParameter 对象。 方法调用失败，返回 null。

getSdkVersion

Java

public static String getSdkVersion()

获取 SDK 的版本号。

返回值

方法调用成功时，返回 SDK 的版本号字符串。 方法调用失败，返回空字符串。

setLogFile

Java

public int setLogFile(String filePath, int fileSize)

设置 SDK 日志文件的路径和大小。

SDK 在运行期间会将所有日志数据记录到两个日志文件中，每个文件的默认大小为 512 KB。如果将 fileSize 设置为 1024 KB，SDK 会输出最大为 2 MB 的日志文件。当日志文件总大小超过设置的上限时，新日志会覆盖旧日志。

注意

为确保日志输出完整，请在调用 initialize 后立即调用此方法。

参数

参数	数据类型	描述
filePath	String	日志文件的路径。请确保该路径对应的目录已存在且可写。
fileSize	int	每个日志文件的大小（字节）。例如，设置为 1024 KB 时，两个日志文件的总大小为 2 MB。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。

setLogLevel

Java

public int setLogLevel(Constants.LogLevel level)

设置 SDK 日志输出级别。

你可以选择一个日志级别，SDK 会输出该级别及以上级别的日志。日志级别的顺序为 OFF、CRITICAL、ERROR、WARNING、INFO 和 DEBUG。例如，如果将日志级别设置为 WARNING，则可以看到 CRITICAL、ERROR 和 WARNING 级别的日志。

参数

参数	数据类型	描述
level	Constants.LogLevel	日志输出级别。 LOG_LEVEL_NONE (0x0000)：不输出任何日志文件。 LOG_LEVEL_INFO (0x0001)：（推荐）输出 INFO 级别的日志文件。 LOG_LEVEL_WARN (0x0002)：输出 WARN 级别的日志文件。 LOG_LEVEL_ERROR (0x0004)：输出 ERROR 级别的日志文件。 LOG_LEVEL_FATAL (0x0008)：输出 FATAL 级别的日志文件。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。

setGlobalLocalAccessPoint

Java

public int setGlobalLocalAccessPoint(LocalAccessPointConfiguration config)

设置本地 AP 模式下的全局本地接入点地址（同时调用本地代理）。

注意

该方法必须在调用 initialize 之前调用。

参数

参数	数据类型	描述
config	LocalAccessPointConfiguration	本地接入点的配置信息，详见 LocalAccessPointConfiguration。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。