TUICommonDefine

最近更新时间:2023-11-20 14:52:11

我的收藏
TUICommonDefine

结构体类型

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

枚举类型

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

TUIError

TUIError

错误码枚举定义

枚举
取值
描述
TUIErrorSuccess
0
操作成功
TUIErrorFailed
-1
暂未归类的通用错误
TUIErrorFreqLimit
-2
请求被限频,请稍后重试
TUIErrorSDKAppIDNotFound
-1000
未找到 SDKAppID,请在腾讯云视立方 SDK 控制台确认应用信息。
TUIErrorInvalidParameter
-1001
调用 API 时,传入的参数不合法,检查入参是否合法
TUIErrorSdkNotInitialized
-1002
未登录,请调用Login接口
TUIErrorPermissionDenied
-1003
获取权限失败,当前未授权音/视频权限,请查看是否开启设备权限。Room场景下请使用以下错误码来处理:
摄像头没有系统授权: ERR_CAMERA_NOT_AUTHORIZED
麦克风没有系统授权: ERR_MICROPHONE_NOT_AUTHORIZED
TUIErrorRequirePayment
-1004
该功能需要开通额外的套餐,请在 腾讯云视立方 SDK 按需开通对应套餐
TUIErrorCameraStartFail
-1100
系统问题,打开摄像头失败。检查摄像头设备是否正常
TUIErrorCameraNotAuthorized
-1101
摄像头没有系统授权, 检查系统授权
TUIErrorCameraOccupied
-1102
摄像头被占用,检查是否有其他进程使用摄像头
TUIErrorCameraDeviceEmpty
-1103
当前无摄像头设备,请插入摄像头设备解决该问题
TUIErrorMicrophoneStartFail
-1104
系统问题,打开麦克风失败。检查麦克风设备是否正常
TUIErrorMicrophoneNotAuthorized
-1105
麦克风没有系统授权,检查系统授权
TUIErrorMicrophoneOccupied
-1106
麦克风被占用
TUIErrorMicrophoneDeviceEmpty
-1107
当前无麦克风设备
TUIErrorGetScreenSharingTargetFailed
-1108
获取屏幕分享源(屏幕和窗口)失败,检查屏幕录制权限
TUIErrorStartScreenSharingFailed
-1109
开启屏幕分享失败,检查房间内是否有人正在屏幕分享
TUIErrorRoomIdNotExist
-2100
进房时房间不存在,或许已被解散
TUIErrorOperationInvalidBeforeEnterRoom
-2101
需要进房后才可使用此功能
TUIErrorExitNotSupportedForRoomOwner
-2102
房主不支持退房操作,Conference(会议)房间类型: 可以先转让房主,再退房。LivingRoom(直播)房间类型: 房主只能解散房间
TUIErrorOperationNotSupportedInCurrentRoomType
-2103
当前房间类型下不支持该操作
TUIErrorOperationNotSupportedInCurrentSpeechMode
-2104
当前发言模式下不支持该操作
TUIErrorRoomIdInvalid
-2105
创建房间ID 非法,自定义 ID 必须为可打印 ASCII 字符(0x20-0x7e),最长48个字节
TUIErrorRoomIdOccupied
-2106
房间ID 已被使用,请选择别的房间 ID
TUIErrorRoomNameInvalid
-2107
房间名称非法,名称最长30字节,字符编码必须是 UTF-8 ,如果包含中文
TUIErrorAlreadyInOtherRoom
-2108
当前用户已在别的房间内,需要先退房才能加入新的房间:
单个roomEngine实例只支持用户进入一个房间,如果要进入不同的房间请先退房或者使用新的roomEngine实例。
TUIErrorUserNotExist
-2200
用户不存在
TUIErrorUserNotEntered
-2201
用户不在当前房间内
TUIErrorUserNeedOwnerPermission
-2300
需要房主权限才能操作
TUIErrorUserNeedAdminPermission
-2301
需要房主或者管理员权限才能操作
TUIErrorRequestNoPermission
-2310
信令请求无权限,例如取消非自己发起的邀请。
TUIErrorRequestIdInvalid
-2311
信令请求ID 无效或已经被处理过。
TUIErrorMaxSeatCountLimit
-2340
最大麦位超出套餐包数量限制
TUIErrorAlreadyInSeat
-2341
当前用户已经在麦位上
TUIErrorSeatOccupied
-2342
当前麦位已经有人了
TUIErrorSeatLocked
-2343
当前麦位被锁
TUIErrorSeatIndexNotExist
-2344
麦位编号不存在
TUIErrorUserNotInSeat
-2345
当前用户没有在麦上
TUIErrorAllSeatOccupied
-2346
上麦人数已满
TUIErrorOpenMicrophoneNeedSeatUnlock
-2360
当前麦位音频被锁
TUIErrorOpenMicrophoneNeedPermissionFromAdmin
-2361
需要向房主或管理员申请后打开麦克风
TUIErrorOpenCameraNeedSeatUnlock
-2370
当前麦位视频被锁, 需要由房主解锁麦位后,才能打开摄像头
TUIErrorOpenCameraNeedPermissionFromAdmin
-2371
需要向房主或管理员申请后打开摄像头
TUIErrorSendMessageDisabledForAll
-2380
当前房间已开启全员禁言
TUIErrorSendMessageDisabledForCurrent
-2381
当前房间内,您已被禁言


TUINetworkQuality

TUINetworkQuality

网络质量

枚举
取值
描述
TUINetworkQualityUnknown
0
未定义
TUINetworkQualityExcellent
1
当前网络非常好
TUINetworkQualityGood
2
当前网络比较好
TUINetworkQualityPoor
3
当前网络一般
TUINetworkQualityBad
4
当前网络较差
TUINetworkQualityVeryBad
5
当前网络很差
TUINetworkQualityDown
6
当前网络不满足 TRTC 的最低要求


TUINetworkInfo

TUINetworkInfo

网络质量信息

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


TUIMessage

TUIMessage

消息

枚举类型
描述
avatarURL
消息发送者头像
message
消息文本
messageId
消息 ID
timestamp
消息时间
userId
消息发送者
userName
消息发送者昵称


TUISuccessBlock

TUISuccessBlock

成功回调

void (^TUISuccessBlock)(void)

TUIErrorBlock

TUIErrorBlock

失败回调

void (^TUIErrorBlock)(TUIError code, NSString* _Nonnull message)
参数
描述
code
错误码
message
错误信息