API | 描述 |
登录 | |
登出 | |
设置用户的昵称、头像 | |
发起 1v1 通话 | |
发起群组通话 | |
主动加入当前的群组通话中 | |
开启/关闭静音模式 | |
开启/关闭悬浮窗功能 |
TUIResult result = TUICallKit.instance.login(sdkAppId: 1400000001, // 请替换为第一步得到的SDKAppIDuserId: 'xxxxxx', // 请替换为您的User IDuserSig: 'xxxxxx'); // 您可以在控制台计算一个UserSig并填到该位置// 返回值TUIResult的定义:class TUIResult {String code;String? message;TUIResult({required this.code, required this.message});}
参数 | 类型 | 含义 |
sdkAppId | int | 用户 SDKAppID |
userId | String | 用户 ID |
userSig | String | 用户签名 userSig |
返回值 | 包含code和message信息:code = 0 表示调用成功;code != 0 表示调用失败,失败原因见message |
TUIResult result = TUICallKit.instance.logout()// 返回值TUIResult的定义:class TUIResult {String code;String? message;TUIResult({required this.code, required this.message});}
参数 | 类型 | 含义 |
返回值 | 包含code和message信息:code = 0 表示调用成功;code != 0 表示调用失败,失败原因见message |
// 函数定义为: Future<TUIResult> setSelfInfo(String nickname, String avatar)TUIResult result = TUICallKit.instance.setSelfInfo('userName', 'url:********');// 返回值TUIResult的定义:class TUIResult {String code;String? message;TUIResult({required this.code, required this.message});}
参数 | 类型 | 含义 |
nickName | String | 目标用户的昵称,非必填 |
avatar | String | 目标用户的头像,非必填 |
返回值 | 包含code和message信息:code = 0 表示调用成功;code != 0 表示调用失败,失败原因见message |
// call的定义为:Future<void> call(String userId, TUICallMediaType callMediaType)TUICallKit.instance.call('mike', TUICallMediaType.video);// TUICallMediaType 定义为:enum TUICallMediaType {none,audio,video}
参数 | 类型 | 含义 |
userId | String | 目标用户的 userID |
callMediaType | 通话的媒体类型,比如: TUICallMediaType.video 或 TUICallMediaType.audio |
// groupCall定义为:Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType)TUICallKit.instance.groupCall('0001', ['denny', 'mike', 'tommy'], TUICallMediaType.video);
参数 | 类型 | 含义 |
groupId | String | 此次群组通话的群 ID |
userIdList | List<String> | 目标用户的userId 列表 |
callMediaType | 通话的媒体类型,比如: TUICallMediaType.video 或 TUICallMediaType.audio |
// joinInGroupCall定义为:Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)final roomId = TUIRoomID(intRoomId: 123);TUICallKit.instance.joinInGroupCall(, ['denny', 'mike', 'tommy'], TUICallMediaType.video);
参数 | 类型 | 含义 |
roomId | 此次通话的音视频房间 ID,目前仅支持数字房间号,后续版本会支持字符串房间号 | |
groupId | String | 此次群组通话的群 ID |
callMediaType | 通话的媒体类型,比如: TUICallMediaType.video 或 TUICallMediaType.audio |
final enable = true;TUICallKit.instance..enableMuteMode(enable);
参数 | 类型 | 含义 |
enable | Boolean | 开启、关闭静音;true 表示开启静音 |
final enable = true;TUICallKit.instance..enableFloatWindow(enable);
参数 | 类型 | 含义 |
enable | Boolean | 开启、关闭悬浮窗功能;true 表示开启浮窗 |
本页内容是否解决了您的问题?