腾讯云音视频通话SDKTUICallKit_音视频解决方案_同尘科技
TUICallKit API 简介
TUICallKit API 是音视频通话组件的含 UI 接口,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景,更详细的接入步骤,详情请参见 快速接入TUICallKit。
API 概览
API | 描述 |
createInstance | 创建 TUICallKit 实例(单例模式) |
setSelfInfo | 设置用户的昵称、头像 |
call | 发起 1v1 通话 |
call | 发起 1v1 通话,支持自定义房间号、通话邀请超时时间,离线推送内容等 |
groupCall | 发起群组通话 |
groupCall | 发起群组通话,支持自定义房间号、通话邀请超时时间,离线推送内容等 |
joinInGroupCall | 主动加入当前的群组通话中 |
setCallingBell | 设置自定义来电铃音 |
enableMuteMode | 开启/关闭静音模式 |
enableFloatWindow | 开启/关闭悬浮窗功能 |
API 详情
createInstance
创建 TUICallKit 的单例。KotlinJava
fun createInstance(context: Context): TUICallKit
TUICallKit createInstance(Context context)
setSelfInfo
设置用户昵称、头像。用户昵称不能超过500字节,用户头像必须是 URL 格式。KotlinJava
fun setSelfInfo(nickname: String?, avatar: String?, callback: TUICommonDefine.Callback?)
void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback)
参数如下表所示:
参数 | 类型 | 含义 |
nickname | String | 目标用户的昵称 |
avatar | String | 目标用户的头像 |
call
拨打电话(1v1通话)。KotlinJava
fun call(userId: String, callMediaType: TUICallDefine.MediaType)
void call(String userId, TUICallDefine.MediaType callMediaType)
参数如下表所示:
参数 | 类型 | 含义 |
userId | String | 目标用户的 userId |
callMediaType | TUICallDefine.MediaType | 通话的媒体类型,比如视频通话、语音通话 |
call
拨打电话(1v1通话),支持自定义房间号、通话邀请超时时间,离线推送内容等。
void call(String userId, TUICallDefine.MediaType callMediaType, TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
参数如下表所示:
参数 | 类型 | 含义 |
userId | String | 目标用户的 userId |
callMediaType | TUICallDefine.MediaType | 通话的媒体类型,比如视频通话、语音通话 |
params | TUICallDefine.CallParams | 通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
groupCall
发起群组通话。注意使用群组通话前需要创建IM 群组,如果已经创建,请忽略。群组的创建详见: IM 群组管理 ,或者您也可以直接使用 IM TUIKit,一站式集成聊天、通话等场景。KotlinJava
fun groupCall(groupId: String, userIdList: List?, callMediaType: TUICallDefine.MediaType)
void groupCall(String groupId, List userIdList, TUICallDefine.MediaType callMediaType);
参数如下表所示:
参数 | 类型 | 含义 |
groupId | String | 此次群组通话的群 ID |
userIdList | List | 目标用户的 userId 列表 |
callMediaType | TUICallDefine.MediaType | 通话的媒体类型,比如视频通话、语音通话 |
groupCall
发起群组通话,支持自定义房间号、通话邀请超时时间,离线推送内容等。注意使用群组通话前需要创建IM 群组,如果已经创建,请忽略。群组的创建详见: IM 群组管理 ,或者您也可以直接使用 IM TUIKit,一站式集成聊天、通话等场景。KotlinJava
fun groupCall( groupId: String, userIdList: List?, callMediaType: TUICallDefine.MediaType, params: CallParams?, callback: TUICommonDefine.Callback?)
void groupCall(String groupId, List userIdList, TUICallDefine.MediaType callMediaType, TUICallDefine.CallParams params, TUICommonDefine.Callback callback);
参数如下表所示:
参数 | 类型 | 含义 |
groupId | String | 此次群组通话的群 ID |
userIdList | List | 目标用户的 userId 列表 |
callMediaType | TUICallDefine.MediaType | 通话的媒体类型,比如视频通话、语音通话 |
params | TUICallDefine.CallParams | 通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
joinInGroupCall
加入群组中已有的音视频通话。注意加入群组中已有的音视频通话前,需要提前创建或加入IM 群组,并且群组中已有用户在通话中,如果已经创建,请忽略。群组的创建详见: IM 群组管理 ,或者您也可以直接使用 IM TUIKit,一站式集成聊天、通话等场景。KotlinJava
fun joinInGroupCall(roomId: RoomId?, groupId: String?, callMediaType: TUICallDefine.MediaType?)
void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType);
参数如下表所示:
参数 | 类型 | 含义 |
roomId | TUICommonDefine.RoomId | 此次通话的音视频房间 ID |
groupId | String | 此次群组通话的群 ID |
callMediaType | TUICallDefine.MediaType | 通话的媒体类型,比如视频通话、语音通话 |
setCallingBell
设置自定义来电铃音。
这里仅限传入本地文件地址,需要确保该文件目录是应用可以访问的。铃声设置后与设备绑定,更换用户,铃声依旧会生效。如需恢复默认铃声,filePath
传空即可。KotlinJava
fun setCallingBell(filePath: String?)
void setCallingBell(String filePath);
enableMuteMode
开启/关闭静音模式。开启后,收到通话请求,不会播放来电铃声;通话过程中静音,请调用closeMicrophone方法。KotlinJava
fun enableMuteMode(enable: Boolean)
void enableMuteMode(boolean enable);
enableFloatWindow
开启/关闭悬浮窗功能。默认为false
,通话界面左上角的悬浮窗按钮隐藏,设置为 true 后显示。KotlinJava
fun enableFloatWindow(enable: Boolean)
void enableFloatWindow(boolean enable);
对音视频的解决方案有疑惑?想了解解决方案收费? 联系解决方案专家
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠
阿里云解决方案也看看?: 点击对比阿里云的解决方案
暂无评论,你要说点什么吗?