You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/实时信令/RTS SDK/RTS SDK API 参考/Android 3.54/类型详情
类型详情
最近更新时间：2024.08.08 14:59:06首次发布时间：2022.09.14 20:26:33
我的收藏
ReturnStatus
public enum com.ss.bytertc.engine.data.ReturnStatus

方法调用结果。

枚举值

类型说明
RETURN_STATUS_SUCCESS(0)成功。
RETURN_STATUS_FAILURE(-1)失败。
RETURN_STATUS_PARAMETER_ERR(-2)参数错误。确认传入的参数类型，数值不超过边界等。
RETURN_STATUS_WRONG_STATE(-3)接口状态错误。确认当前的调用时机符合接口要求等。
RETURN_STATUS_HAS_IN_ROOM(-4)失败，用户已在房间内。
RETURN_STATUS_HAS_IN_LOGIN(-5)失败，用户已登录。
RETURN_STATUS_HAS_IN_ECHO_TEST(-6)失败，用户已经在进行通话回路测试中。
RETURN_STATUS_NEITHER_VIDEO_NOR_AUDIO(-7)失败，音视频均未采集。
RETURN_STATUS_ROOMID_IN_USE(-8)失败，该 roomId 已被使用。
RETURN_STATUS_SCREEN_NOT_SUPPORT(-9)失败，屏幕流不支持。
RETURN_STATUS_NOT_SUPPORT(-10)失败，不支持该操作。
RETURN_STATUS_RESOURCE_OVERFLOW(-11)失败，资源已占用。
RETURN_STATUS_AUDIO_NO_FRAME(-101)失败，没有音频帧。
RETURN_STATUS_AUDIO_NOT_IMPLEMENTED(-102)失败，未实现。
RETURN_STATUS_AUDIO_NO_PERMISSION(-103)失败，采集设备无麦克风权限，尝试初始化设备失败。
RETURN_STATUS_AUDIO_DEVICE_NOT_EXISTS(-104)失败，设备不存在。当前没有设备或设备被移除时返回该值。
RETURN_STATUS_AUDIO_DEVICE_FORMAT_NOT_SUPPORT(-105)失败，设备音频格式不支持。
RETURN_STATUS_AUDIO_DEVICE_NO_DEVICE(-106)失败，系统无可用设备。
RETURN_STATUS_AUDIO_DEVICE_CAN_NOT_USE(-107)失败，当前设备不可用，需更换设备。
RETURN_STATUS_AUDIO_DEVICE_INIT_FAILED(-108)系统错误，设备初始化失败。
RETURN_STATUS_AUDIO_DEVICE_START_FAILED(-109)系统错误，设备开启失败。
RETURN_STATUS_NATIVE_IN_VALID(-201)失败。底层未初始化，engine 无效。
ConnectionState
public enum com.ss.bytertc.engine.type.ConnectionState

SDK 与 RTC 服务器连接状态。

枚举值

类型说明
CONNECTION_STATE_DISCONNECTED(1)连接断开超过 12s，此时 SDK 会尝试自动重连。
CONNECTION_STATE_CONNECTING(2)首次请求建立连接，正在连接中。
CONNECTION_STATE_CONNECTED(3)首次连接成功。
CONNECTION_STATE_RECONNECTING(4)涵盖了以下情况：

+ 首次连接时，10 秒内未连接成功;

+ 连接成功后，断连 10 秒。自动重连中。
CONNECTION_STATE_RECONNECTED(5)连接断开后，重连成功。
CONNECTION_STATE_LOST(6)处于 CONNECTION_STATE_DISCONNECTED 状态超过 10 秒，且期间重连未成功。SDK 仍将继续尝试重连。
CONNECTION_STATE_FAILED(7)连接失败，服务端状态异常。SDK 不会自动重连，请重新进房，或联系技术支持。
UserOnlineStatus
public class com.ss.bytertc.engine.type.UserOnlineStatus

用户在线状态

成员变量

类型名称
intUSER_ONLINE_STATUS_OFFLINE
intUSER_ONLINE_STATUS_ONLINE
intUSER_ONLINE_STATUS_UNREACHABLE

变量说明

USER_ONLINE_STATUS_OFFLINE

public static final int com.ss.bytertc.engine.type.UserOnlineStatus.USER_ONLINE_STATUS_OFFLINE = 0;

对端用户离线

对端用户已经调用 logout，或者没有调用 login 进行登录

USER_ONLINE_STATUS_ONLINE

public static final int com.ss.bytertc.engine.type.UserOnlineStatus.USER_ONLINE_STATUS_ONLINE = 1;

对端用户在线

对端用户调用 login 登录，并且连接状态正常。

USER_ONLINE_STATUS_UNREACHABLE

public static final int com.ss.bytertc.engine.type.UserOnlineStatus.USER_ONLINE_STATUS_UNREACHABLE = 2;

无法获取对端用户在线状态

发生级联错误、对端用户在线状态异常时返回

SysStats
public class com.ss.bytertc.rts.engine.SysStats

CPU 和内存统计信息

成员变量

类型名称
intcpu_cores
doublecpu_app_usage
doublecpu_total_usage
doublememory_usage
longfull_memory
longfree_memory
doublememory_ratio
doubletotal_memory_ratio

变量说明

cpu_cores

public int com.ss.bytertc.rts.engine.SysStats.cpu_cores;

设备的 CPU 核数

cpu_app_usage

public double com.ss.bytertc.rts.engine.SysStats.cpu_app_usage;

应用的 CPU 使用率，取值范围为 [0, 1]。

cpu_total_usage

public double com.ss.bytertc.rts.engine.SysStats.cpu_total_usage;

系统的 CPU 使用率，取值范围为 [0, 1]。

memory_usage

public double com.ss.bytertc.rts.engine.SysStats.memory_usage;

应用的内存占用大小（单位 MB）

full_memory

public long com.ss.bytertc.rts.engine.SysStats.full_memory;

设备的内存大小 单位：MB

free_memory

public long com.ss.bytertc.rts.engine.SysStats.free_memory;

系统当前空闲内存（MB）

memory_ratio

public double com.ss.bytertc.rts.engine.SysStats.memory_ratio;

当前应用的内存使用率（单位 %）

total_memory_ratio

public double com.ss.bytertc.rts.engine.SysStats.total_memory_ratio;

系统内存使用率（单位 %）

LocalProxyConfiguration
public class com.ss.bytertc.rts.engine.type.LocalProxyConfiguration

本地代理配置详细信息。

成员变量

类型名称
LocalProxyTypelocalProxyType
StringlocalProxyIp
intlocalProxyPort
StringlocalProxyUsername
StringlocalProxyPassword

变量说明

localProxyType

public LocalProxyType com.ss.bytertc.rts.engine.type.LocalProxyConfiguration.localProxyType;

本地代理类型，参看 LocalProxyType。

localProxyIp

public String com.ss.bytertc.rts.engine.type.LocalProxyConfiguration.localProxyIp;

本地代理服务器 IP。

localProxyPort

public int com.ss.bytertc.rts.engine.type.LocalProxyConfiguration.localProxyPort;

本地代理服务器端口。

localProxyUsername

public String com.ss.bytertc.rts.engine.type.LocalProxyConfiguration.localProxyUsername;

本地代理用户名。

localProxyPassword

public String com.ss.bytertc.rts.engine.type.LocalProxyConfiguration.localProxyPassword;

本地代理密码。

LocalProxyError
public enum com.ss.bytertc.rts.engine.type.LocalProxyError

本地代理错误信息。

枚举值

类型说明
OK(0)本地代理服务器无错误。
SOCKS5_VERSION_ERROR(1)代理服务器回复的版本号不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
SOCKS5_FORMAT_ERROR(2)代理服务器回复的格式错误不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
SOCKS5_INVALID_VALUE(3)代理服务器回复的字段值不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
SOCKS5_USER_PASS_NOT_GIVEN(4)未提供代理服务器的用户名及密码，导致 Socks5 代理连接失败。请重新调用 setLocalProxy，在设置本地代理时填入用户名和密码。
SOCKS5_TCP_CLOSED(5)TCP 关闭，导致 Socks5 代理连接失败。请检查网络或者代理服务器是否存在异常。
HTTP_TUNNEL_FAILED(6)Http 隧道代理错误。请检查 Http 隧道代理服务器或者网络是否存在异常。
LocalProxyState
public enum com.ss.bytertc.rts.engine.type.LocalProxyState

本地代理连接状态。

枚举值

类型说明
INITED(0)TCP 代理服务器连接成功。
CONNECTED(1)本地代理连接成功。
ERROR(2)本地代理连接出现错误。
LocalProxyType
public enum com.ss.bytertc.rts.engine.type.LocalProxyType

本地代理的类型。

枚举值

类型说明
SOCKS5(1)Socks5 代理。选用此代理服务器，需满足 Socks5 协议标准文档的要求。
HTTP_TUNNEL(2)Http 隧道代理。
MessageConfig
public enum com.ss.bytertc.rts.engine.type.MessageConfig

发送消息的可靠有序性

枚举值

类型说明
MessageConfigReliableOrdered (0)低延时可靠有序消息
MessageConfigUnreliableOrdered (1)超低延时有序消息
MessageConfigUnreliableUnordered (2)超低延时无序消息
LocalLogLevel
public enum com.ss.bytertc.rts.engine.utils.LocalLogLevel

本地日志输出等级。

枚举值

类型说明
INFO(0)信息级别。
WARNING(1)（默认值）警告级别。
ERROR(2)错误级别。
NONE(3)关闭日志。
RTCLogConfig
public class com.ss.bytertc.rts.engine.utils.RTCLogConfig

本地日志参数。

成员变量

类型名称
Stringlog_path
intlog_file_size
LocalLogLevellog_level

变量说明

log_path

public String com.ss.bytertc.rts.engine.utils.RTCLogConfig.log_path;

日志存储路径。

log_file_size

public int com.ss.bytertc.rts.engine.utils.RTCLogConfig.log_file_size = 10;

日志可使用的最大缓存空间，单位为 MB。取值范围为 1～100 MB，默认值为 10 MB。

log_level

public LocalLogLevel com.ss.bytertc.rts.engine.utils.RTCLogConfig.log_level = LocalLogLevel.WARNING;

日志等级，参看 LocalLogLevel，默认为警告级别。