TUICommonDefine
TUICommonDefine
结构体类型
函数列表 | 描述 |
网络质量信息。 | |
枚举类型
枚举类型 | 描述 |
错误码枚举定义。 | |
网络质量。 | |
插件类型。 | |
音频设备。 | |
前置/后置摄像头。 |
TUIError
TUIError
错误码枚举定义。
枚举 | 取值 | 描述 |
SUCCESS | 0 | 操作成功。 |
FAILED | -1 | 暂未归类的通用错误。 |
FREQ_LIMIT | -2 | 请求被限频，请稍后重试。 |
REPEAT_OPERATION | -3 | 重复操作。 |
ROOM_MISMATCH | -4 | 房间 ID 不匹配，请检查是否退房或者切换了房间。 |
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 控制台 按需开通对应套餐。 |
INVALID_LICENSE | -1005 | 错误描述: SDK检测到当前使用的License无效或已过期，导致播放功能受限无法正常播放 错误原因: 1. License非法或已过期 2. License未包含所需功能权限 3. License签名验证失败 处理建议: 1. 在腾讯云视立方控制台确认License有效期 2. 联系腾讯云技术支持更新或重新获取License |
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 | 开启屏幕分享失败，检查房间内是否有人正在屏幕分享。 |
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_NAME_INVALID | -2107 | 房间名称非法，名称最长30字节，如果包含中文，字符编码必须是 UTF-8。 |
ALREADY_IN_OTHER_ROOM | -2108 | 当前用户已在别的房间内，需要先退房才能加入新的房间: 单个roomEngine实例只支持用户进入一个房间，如果要进入不同的房间请先退房或者使用新的roomEngine实例。 |
USER_NOT_EXIST | -2200 | 用户不存在。 |
NEED_OWNER_PERMISSION | -2300 | 需要房主权限才能操作。 |
NEED_ADMIN_PERMISSION | -2301 | 需要房主或者管理员权限才能操作。 |
REQUEST_NO_PERMISSION | -2310 | 信令请求无权限，例如取消非自己发起的邀请。 |
REQUEST_ID_INVALID | -2311 | 信令请求ID 无效或已经被处理过。 |
REQUEST_ID_REPEAT | -2312 | 信令请求重复。 |
MAX_SEAT_COUNT_LIMIT | -2340 | 最大麦位超出套餐包数量限制。 |
SEAT_INDEX_NOT_EXIST | -2344 | 麦位编号不存在。 |
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_NOT_SUPPORT_PRELOADING | -4001 | 当前房间不支持预加载。 |
CALL_IN_PROGRESS | -6001 | 错误描述：正在通话中，不允许操作设备/流相关接口。 错误原因： 当您在使用 TUIRoomEngine 直播过程中接听来自 TUICallEngine 的通话时，为了避免通话的音视频数据被直播间观众拉取到，TUIRoomEngine 会做如下处理： 1. 暂停视频流上行，如果您在直播时有调用 setLocalVideoMuteImage 接口设置过垫片图片，直播间观众会看到您设置的垫片图片；TUICallEngine 通话结束后会自动恢复摄像头画面的上行；2. 暂停音频流上行，TUICallEngine 通话结束后会自动恢复麦克风音频的上行。 在 TUICallEngine 通话未结束期间，您在直播间内调用设备和流相关的 API 时均会出现此错误码。 处理建议：您可以在页面上弹框提醒用户 “您正在通话中，请挂断后再试”。 |
SERVER_SYSTEM_ERROR | 100001 | 错误描述： 服务器内部发生未知错误，导致请求无法正常处理 错误原因： 1. 服务器端服务异常或崩溃 2. 服务器资源不足或过载 3. 服务器配置错误 处理建议： 1. 提示用户"服务器繁忙，请稍后重试" 2. 检查服务器日志定位具体问题 3. 联系腾讯云技术支持排查后台服务问题 |
SERVER_INVALID_PARAMETER | 100002 | 错误描述: 服务器接收到非法或不完整的请求参数，导致请求无法处理 产生原因: 1. 必填参数缺失或为空 2. 参数格式不符合要求 3. 参数值超出允许范围 4. 参数类型不匹配 处理建议: 1. 检查请求参数是否完整 2. 验证参数格式和类型是否符合API文档要求 3. 确保参数值在有效范围内 4. 查阅相关API文档确认参数规范 |
ROOM_ID_OCCUPIED | 100003 | 房间ID 已被使用，请选择别的房间ID。 |
ROOM_ID_NOT_EXIST | 100004 | 进房时房间不存在，或许已被解散。 |
USER_NOT_ENTERED | 100005 | 用户不在当前房间内。 |
ROOM_USER_FULL | 100008 | 房间成员已满。 |
NEED_PASSWORD | 100018 | 当前房间需要密码才能进入。 |
WRONG_PASSWORD | 100019 | 进房密码错误。 |
REQUEST_ID_CONFLICT | 100102 | 信令请求冲突。 |
SEAT_LOCKED | 100200 | 当前麦位被锁。 |
SEAT_OCCUPIED | 100210 | 当前麦位已经有人了。 |
ALREADY_IN_SEAT | 100203 | 当前用户已经在麦位上。 |
ALL_SEAT_OCCUPIED | 100205 | 上麦人数已满。 |
USER_NOT_IN_SEAT | 100206 | 当前用户没有在麦上。 |
SEAT_NOT_SUPPORT_LINK_MIC | 100211 | 不支持连麦。 |
ROOM_ALREADY_CONNECTED | 100401 | 当前房间已连线。 |
ROOM_CONNECTED_IN_OTHER | 100403 | 当前房间与其他房间连线中。 |
MAX_CONNECTED_COUNT_LIMIT | 100404 | 当前房间连线超出最大数量限制。 |
ROOM_METADATA_EXCEED_KEY_COUNT_LIMIT | 100500 | 房间自定义信息 key 数量超过上限 |
ROOM_METADATA_EXCEED_VALUE_SIZE_LIMIT | 100501 | 房间自定义信息 value 字节大小超过上限 |
GIFT_ABILITY_NOT_ENABLED | 102001 | 礼物能力未开启 |
GIFT_NOT_EXIST | 102002 | 礼物ID不存在 |
GIFT_SERVER_PRE_VERIFICATION_FAILED | 102004 | 错误描述: 礼物服务器预验证失败, 礼物系统在发送礼物之前，会向您在控制台上配置的回调服务器地址发送“礼物发送确认请求”，如果从您的服务器获得确认码为 0，礼物系统才会真正发出礼物。 错误原因： 1. 礼物系统向您的服务器请求超时了（超时时间为两秒），比如您的服务器没有打开相应的端口，或者防火墙策略限制了外网的 http 协议访问。 2. 您的服务器没有成功解析“礼物发送确认请求”的数据包，导致您的服务器返回了数值不为 0 的确认码。 处理建议: 1. 检查服务器端口开放状态和防火墙设置。 2. 确保服务器能正确处理JSON格式的验证请求。 |
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 | 会中呼叫插件。 |
LIVE_LAYOUT_MANAGER | 5 | 直播布局插件。 |
LIVE_GIFT_MANAGER | 6 | 直播礼物插件 |
TUIAudioPlaybackDevice
TUIAudioPlaybackDevice
音频设备。
枚举 | 取值 | 描述 |
Speakerphone | 0 | 扬声器。 |
Earpiece | 1 | 听筒。 |
TUICamera
TUICamera
前置/后置摄像头。
枚举 | 取值 | 描述 |
Front | 0 | 前置摄像头。 |
Back | 1 | 后置摄像头。 |
TUINetworkInfo
TUINetworkInfo
网络质量信息。
枚举类型 | 描述 |
delay | 网络延迟，单位 ms。 |
downLoss | 下行丢包率，单位 (%) 该数值越小越好。 如果 downLoss 为 0%，则意味着下行链路的网络质量很好，从云端接收的数据包基本不发生丢失。 如果 downLoss 为 30%，则意味着云端向 SDK 传输的音视频数据包中，会有 30%丢失在传输链路中。 |
quality | 网络质量。 |
upLoss | 上行丢包率，单位 (%) 该数值越小越好。 如果 upLoss 为 0%，则意味着上行链路的网络质量很好，上传到云端的数据包基本不发生丢失。 如果 upLoss 为 30%，则意味着 SDK 向云端发送的音视频数据包中，会有 30%丢失在传输链路中。 |
userId | 用户ID。 |
TUINetworkQualityInfo
TUINetworkQualityInfo
网络质量信息（废弃，推荐使用1.6 {@link NetworkInfo}）。
枚举类型 | 描述 |
quality | 网络质量。 |
userId | 用户 ID。 |
