TUICallKit API 简介
TUICallKit API 是音视频通话组件的含 UI 接口，使用TUICallKit API，您可以通过简单接口快速实现一个类微信的音视频通话场景，更详细的接入步骤，详情请参见 快速接入（TUICallKit）。
API 概览
API | 描述 |
登录。 | |
登出。 | |
设置用户的昵称、头像。 | |
发起通话。 | |
主动加入通话。 | |
开启/关闭静音模式。 | |
开启/关闭悬浮窗功能。 | |
开启/关闭来电横幅。 |
API 详情
login
登录。
Future<CompletionHandler> login(int sdkAppId, String userId, String userSig)
参数 | 类型 | 含义 |
sdkAppId | int | 用户 SDKAppID。 |
userId | String | 用户 ID。 |
userSig | String | 用户签名 userSig。 |
返回值 | 包含 errorCode 和 errorMessage 信息：errorCode 为 0 表示调用成功；errorCode 不为 0 表示调用失败的错误码，失败原因见 errorMessage。 |
logout
登出。
Future<void> logout()
setSelfInfo
设置用户昵称、头像。用户昵称不能超过500字节，用户头像必须是URL格式。
Future<CompletionHandler> setSelfInfo(String nickname, String avatar)
参数 | 类型 | 含义 |
nickName | String | 目标用户的昵称，非必填。 |
avatar | String | 目标用户的头像，非必填。 |
返回值 | 包含 errorCode 和 errorMessage 信息：errorCode 为 0 表示调用成功；errorCode 不为 0 表示调用失败的错误码，失败原因见 errorMessage。 |
calls
发起通话。
Future<CompletionHandler> 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。 |
join
主动加入通话。
Future<void> join(String callId)
参数 | 类型 | 含义 |
callId | String | 此次通话的唯一 ID。 |
enableMuteMode
开启后，收到通话请求，不会播放来电铃声。
Future<void> enableMuteMode(bool enable)
参数 | 类型 | 含义 |
enable | bool | true 表示开启静音模式， false 表示关闭静音模式。 |
enableFloatWindow
开启/关闭悬浮窗功能，设置为 false 后，通话界面左上角的悬浮窗按钮会隐藏。
Future<void> enableFloatWindow(bool enable)
参数 | 类型 | 含义 |
enable | bool | true 表示开启浮窗功能， false 表示关闭悬浮窗功能。 |
enableIncomingBanner
开启/关闭来电横幅功能，开启该功能后，收到来电后会通过屏幕上方的横幅提示。
Future<void> enableIncomingBanner(bool enable)
参数 | 类型 | 含义 |
enable | bool | true 表示开启来电横幅功能， false 表示关闭来电横幅功能。 |
