Docs Overview/
TUICommonDefine/

TUICommonDefine

TUICommonDefine

结构体类型

函数列表
描述
网络质量信息

枚举类型

枚举类型
描述
错误码枚举定义
网络质量
插件类型

TUIError

TUIError

错误码枚举定义

枚举
取值
描述
SUCCESS
0
操作成功。
FAILED
-1
暂未归类的通用错误。
FREQ_LIMIT
-2
请求被限频，请稍后重试。
REPEAT_OPERATION
-3
重复操作。
SDKAPPID_NOT_FOUND
-1000
未找到SDKAppID，请在腾讯云视立方SDK控制台确认应用信息。
INVALID_PARAMETER
-1001
调用 API 时，传入的参数不合法，检查入参是否合法。
SDK_NOT_INITIALIZED
-1002
未登录,请调用Login接口。
PERMISSION_DENIED
-1003
获取权限失败，当前未授权音/视频权限，请查看是否开启设备权限。Room场景下请使用以下错误码来处理:
摄像头没有系统授权: ERR_CAMERA_NOT_AUTHORIZED。
麦克风没有系统授权: ERR_MICROPHONE_NOT_AUTHORIZED。
REQUIRE_PAYMENT
-1004
该功能需要开通额外的套餐，请在腾讯云视立方SDK 控制台 按需开通对应套餐。
CAMERA_START_FAIL
-1100
系统问题，打开摄像头失败。检查摄像头设备是否正常。
CAMERA_NOT_AUTHORIZED
-1101
摄像头没有系统授权, 检查系统授权。
CAMERA_OCCUPIED
-1102
摄像头被占用，检查是否有其他进程使用摄像头。
CAMERA_DEVICE_EMPTY
-1103
当前无摄像头设备，请插入摄像头设备解决该问题。
MICROPHONE_START_FAIL
-1104
系统问题，打开麦克风失败。检查麦克风设备是否正常。
MICROPHONE_NOT_AUTHORIZED
-1105
麦克风没有系统授权，检查系统授权。
MICROPHONE_OCCUPIED
-1106
麦克风被占用。
MICROPHONE_DEVICE_EMPTY
-1107
当前无麦克风设备。
GET_SCREEN_SHARING_TARGET_FAILED
-1108
获取屏幕分享源（屏幕和窗口）失败，检查屏幕录制权限。
START_SCREEN_SHARING_FAILED
-1109
开启屏幕分享失败，检查房间内是否有人正在屏幕分享。
ROOM_ID_NOT_EXIST
-2100
进房时房间不存在，或许已被解散。
OPERATION_INVALID_BEFORE_ENTER_ROOM
-2101
需要进房后才可使用此功能。
EXIT_NOT_SUPPORTED_FOR_ROOM_OWNER
-2102
房主不支持退房操作，Conference(会议)房间类型: 可以先转让房主，再退房。LivingRoom(直播)房间类型: 房主只能解散房间。
OPERATION_NOT_SUPPORTED_IN_CURRENT_ROOM_TYPE
-2103
当前房间类型下不支持该操作。
ROOM_ID_INVALID
-2105
创建房间ID 非法，自定义 ID 必须为可打印 ASCII 字符（0x20-0x7e），最长48个字节。
ROOM_ID_OCCUPIED
-2106
房间ID 已被使用，请选择别的房间ID。
ROOM_NAME_INVALID
-2107
房间名称非法，名称最长30字节，如果包含中文，字符编码必须是 UTF-8。
ALREADY_IN_OTHER_ROOM
-2108
当前用户已在别的房间内，需要先退房才能加入新的房间:
单个roomEngine实例只支持用户进入一个房间，如果要进入不同的房间请先退房或者使用新的roomEngine实例。
NEED_PASSWORD
-2109
当前房间需要密码才能进入。
WRONG_PASSWORD
-2110
进房密码错误。
ROOM_USER_FULL
-2111
房间成员已满。
ROOM_METADATA_EXCEED_KEY_COUNT_LIMIT
-2112
房间自定义信息 key 数量超过上限
ROOM_METADATA_EXCEED_VALUE_SIZE_LIMIT
-2113
房间自定义信息 value 字节大小超过上限
USER_NOT_EXIST
-2200
用户不存在。
USER_NOT_ENTERED
-2201
用户不在当前房间内。
NEED_OWNER_PERMISSION
-2300
需要房主权限才能操作。
NEED_ADMIN_PERMISSION
-2301
需要房主或者管理员权限才能操作。
REQUEST_NO_PERMISSION
-2310
信令请求无权限，例如取消非自己发起的邀请。
REQUEST_ID_INVALID
-2311
信令请求ID 无效或已经被处理过。
REQUEST_ID_REPEAT
-2312
信令请求重复。
REQUEST_ID_CONFLICT
-2313
信令请求冲突。
MAX_SEAT_COUNT_LIMIT
-2340
最大麦位超出套餐包数量限制。
ALREADY_IN_SEAT
-2341
当前用户已经在麦位上。
SEAT_OCCUPIED
-2342
当前麦位已经有人了。
SEAT_LOCKED
-2343
当前麦位被锁。
SEAT_INDEX_NOT_EXIST
-2344
麦位编号不存在。
USER_NOT_IN_SEAT
-2345
当前用户没有在麦上。
ALL_SEAT_OCCUPIED
-2346
上麦人数已满。
SEAT_NOT_SUPPORT_LINK_MIC
-2347
不支持连麦。
OPEN_MICROPHONE_NEED_SEAT_UNLOCK
-2360
当前麦位音频被锁。
OPEN_MICROPHONE_NEED_PERMISSION_FROM_ADMIN
-2361
需要向房主或管理员申请后打开麦克风。
OPEN_CAMERA_NEED_SEAT_UNLOCK
-2370
当前麦位视频被锁, 需要由房主解锁麦位后，才能打开摄像头。
OPEN_CAMERA_NEED_PERMISSION_FROM_ADMIN
-2371
需要向房主或管理员申请后打开摄像头。
OPEN_SCREEN_SHARE_NEED_SEAT_UNLOCK
-2372
当前麦位视频被锁, 需要由房主解锁麦位后，才能打开屏幕分享。
OPEN_SCREEN_SHARE_NEED_PERMISSION_FROM_ADMIN
-2373
需要向房主或管理员申请后打开屏幕分享。
SEND_MESSAGE_DISABLED_FOR_ALL
-2380
当前房间已开启全员禁言。
SEND_MESSAGE_DISABLED_FOR_CURRENT
-2381
当前房间内，您已被已禁言。
ROOM_ALREADY_CONNECTED
-3001
当前房间已连线。
ROOM_CONNECTED_IN_OTHER
-3002
当前房间与其他房间连线中。
MAX_CONNECTED_COUNT_LIMIT
-3003
当前房间连线超出最大数量限制。

TUINetworkQuality

TUINetworkQuality

网络质量

枚举
取值
描述
UNKNOWN
0
未定义。
EXCELLENT
1
当前网络非常好。
GOOD
2
当前网络比较好。
POOR
3
当前网络一般。
BAD
4
当前网络较差。
VERY_BAD
5
当前网络很差。
DOWN
6
当前网络不满足 TRTC 的最低要求。

TUIExtensionType

TUIExtensionType

插件类型

枚举
取值
描述
DEVICE_MANAGER
1
设备管理插件。
LIVE_LIST_MANAGER
2
直播管理插件。
CONFERENCE_LIST_MANAGER
3
会议列表插件。
CONFERENCE_INVITATION_MANAGER
4
会中呼叫插件。

TUINetworkInfo

TUINetworkInfo

网络质量信息

枚举类型
描述
delay
网络延迟，单位 ms。
downLoss
下行丢包率，单位 (%) 该数值越小越好。
如果 downLoss 为 0%，则意味着下行链路的网络质量很好，从云端接收的数据包基本不发生丢失。
如果 downLoss 为 30%，则意味着云端向 SDK 传输的音视频数据包中，会有 30%丢失在传输链路中。
quality
网络质量。
upLoss
上行丢包率，单位 (%) 该数值越小越好。
如果 upLoss 为 0%，则意味着上行链路的网络质量很好，上传到云端的数据包基本不发生丢失。
如果 upLoss 为 30%，则意味着 SDK 向云端发送的音视频数据包中，会有 30%丢失在传输链路中。
userId
用户ID。