API | 描述 |
登录。 | |
登出。 | |
设置用户的昵称、头像。 | |
发起通话。 | |
主动加入通话。 | |
开启/关闭静音模式。 | |
开启/关闭悬浮窗功能。 | |
开启/关闭来电横幅。 |
Future<CompletionHandler> login(int sdkAppId, String userId, String userSig);
参数 | 类型 | 含义 |
sdkAppId | int | 用户 SDKAppID。 |
userId | String | 用户 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）。 |
userSig | String | 用户签名 userSig。 userSig 通过使用 SDKSecretKey 对 sdkAppId、userId 等信息进行加密得到（计算方法详见），它是一个鉴权用的票据，用于腾讯云识别当前用户是否能够使用 TRTC 的服务。 |
返回值 | 包含 errorCode 和 errorMessage 信息：errorCode 为 0 表示调用成功；errorCode 不为 0 表示调用失败的错误码，失败原因见 errorMessage。 |
Future<void> logout()
Future<TUIResult> setSelfInfo(String nickname, String avatar)
参数 | 类型 | 含义 |
nickName | String | 目标用户的昵称，非必填 |
avatar | String | 目标用户的头像，非必填 |
返回值 | 包含 errorCode 和 errorMessage 信息：errorCode 为 0 表示调用成功；errorCode 不为 0 表示调用失败的错误码，失败原因见 errorMessage。 |
Future<TUIResult> calls(List<String> userIdList, CallMediaType mediaType, CallParams params)
参数 | 类型 | 含义 |
userIdList | List<String> | 目标用户的userId 列表 |
callMediaType | 通话的媒体类型，比如： CallMediaType.video 或 CallMediaType.audio | |
params | 可选通话扩展参数，例如：房间号、通话邀请超时时间，离线推送自定义内容等 | |
返回值 | 包含 errorCode 和 errorMessage 信息：errorCode 为 0 表示调用成功；errorCode 不为 0 表示调用失败的错误码，失败原因见 errorMessage。 |
Future<void> join(String callId)
参数 | 类型 | 含义 |
callId | String | 此次通话的唯一 ID |
Future<void> enableMuteMode(bool enable)
参数 | 类型 | 含义 |
enable | bool | true 表示开启静音模式， false 表示关闭静音模式。 |
Future<void> enableFloatWindow(bool enable)
参数 | 类型 | 含义 |
enable | bool | true 表示开启浮窗功能， false 表示关闭悬浮窗功能。 |
Future<void> enableIncomingBanner(bool enable)
参数 | 类型 | 含义 |
enable | bool | true 表示开启来电横幅功能， false 表示关闭来电横幅功能。 |
文档反馈