Tencent Cloud

API 概览

最后更新时间：2024-08-09 17:05:01

TUICallKit（含 UI 组件）
TUICallKit 是音视频通话组件的含 UI 组件，您可以通过该组件快速实现一个类微信的音视频通话场景。
API
描述
﻿init﻿
初始化 TUICallKit 组件实例
﻿call﻿
发起 1v1 通话，支持自定义房间号、通话邀请超时时间，离线推送内容等
﻿groupCall﻿
发起群组通话，支持自定义房间号、通话邀请超时时间，离线推送内容等
﻿joinInGroupCall﻿
主动加入当前的群组通话中，v3.1.2+ 支持
﻿setCallingBell﻿
设置自定义来电铃音，v3.0.0+ 支持
﻿setSelfInfo﻿
设置用户昵称和头像，v2.2.0+ 支持
﻿enableMuteMode﻿
开启/关闭来电铃声，v3.1.2+ 支持
﻿enableFloatWindow﻿
开启/关闭悬浮窗功能，v3.1.0+ 支持
﻿enableVirtualBackground﻿
开启/关闭模糊背景的功能按钮，v3.2.4+ 支持
﻿setLanguage﻿
设置 TUICallKit 组件通话语言
﻿hideFeatureButton﻿
隐藏按钮，v3.2.9+ 支持
﻿setLocalViewBackgroundImage﻿
设置本地用户通话界面背景图，v3.2.9+ 支持
﻿setRemoteViewBackgroundImage﻿
设置远端用户通话界面背景图，v3.2.9+ 支持
﻿setLayoutMode﻿
设置通话界面布局模式，v3.3.0+ 支持
﻿setCameraDefaultState﻿
设置摄像头是否默认打开，v3.3.0+ 支持
﻿destroyed﻿
销毁 TUICallKit 组件实例
TUICallEngine (无 UI 接口)
TUICallEngine API 是音视频通话组件的无 UI 接口，您可以使用这套 API 根据您的业务需求自定义封装。
API
描述
﻿createInstance﻿
创建 TUICallEngine 实例（单例模式）
﻿destroyInstance﻿
销毁 TUICallEngine 实例（单例模式）
﻿on﻿
监听事件
﻿off﻿
取消监听事件
﻿login﻿
登录接口
﻿logout﻿
登出接口
﻿setSelfInfo﻿
设置用户昵称和头像
﻿call﻿
发起 1v1 通话
﻿groupCall﻿
群聊邀请通话
﻿accept﻿
接听通话
﻿reject﻿
拒绝通话
﻿hangup﻿
结束通话
﻿switchCallMediaType﻿
音视频通话切换
﻿startRemoteView﻿
启动远端画面渲染
﻿stopRemoteView﻿
停止远端画面渲染
﻿startLocalView﻿
启动本地画面渲染，注意：后续将废弃，建议使用 openCamera
﻿stopLocalView﻿
停止本地画面渲染，注意：后续将废弃，建议使用 closeCamera
﻿openCamera﻿
开启摄像头
﻿closeCamara﻿
关闭摄像头
﻿switchCamera﻿
切换前后置摄像头，注意：仅移动端支持。v3.0.0+ 支持
﻿openMicrophone﻿
打开麦克风
﻿closeMicrophone﻿
关闭麦克风
﻿setVideoQuality﻿
设置视频质量
﻿getDeviceList﻿
获取设备列表
﻿switchDevice﻿
切换摄像头或麦克风设备
﻿enableAIVoice﻿
开启/关闭 AI 降噪
﻿enableMultiDeviceAbility﻿
开启/关闭 TUICallEngine 的多设备登录模式。v2.1.1+ 支持
﻿setBlurBackground﻿
开关/设置背景虚化，v3.0.6+ 支持
﻿setVirtualBackground﻿
开关/设置图片背景虚化，v3.0.6+ 支持
事件类型定义
TUICallEvent 是 TUICallEngine 对应的事件类，您可以通过监听如下事件，来监听自己感兴趣的事件。
EVENT
描述
﻿TUICallEvent.ERROR﻿
通话过程中错误事件
﻿TUICallEvent.SDK_READY﻿
SDK 进入 ready 状态时收到该事件
﻿TUICallEvent.KICKED_OUT﻿
用户重复登录，被踢下线
﻿TUICallEvent.USER_ACCEPT﻿
xxxx 用户接通的事件
﻿TUICallEvent.USER_ENTER﻿
xxxx 用户加入通话的事件
﻿TUICallEvent.USER_LEAVE﻿
xxxx 用户离开通话的事件
﻿TUICallEvent.REJECT﻿
xxxx 用户拒绝通话的事件
﻿TUICallEvent.NO_RESP﻿
xxxx 用户不响应的事件
﻿TUICallEvent.LINE_BUSY﻿
xxxx 用户忙线的事件
﻿TUICallEvent.USER_VIDEO_AVAILABLE﻿
xxxx 用户是否有视频流的事件
﻿TUICallEvent.USER_AUDIO_AVAILABLE﻿
xxxx 用户是否有音频流的事件
﻿TUICallEvent.USER_VOICE_VOLUME﻿
所有用户音量大小的反馈事件
﻿TUICallEvent.GROUP_CALL_INVITEE_LIST_UPDATE﻿
群聊更新邀请列表收到该事件
﻿TUICallEvent.ON_CALL_BEGIN﻿
通话接通的事件，v1.4.6+ 支持
﻿TUICallEvent.INVITED﻿
通话请求的事件，
后续废弃，建议使用 TUICallEvent.ON_CALL_RECEIVED
﻿TUICallEvent.ON_CALL_RECEIVED﻿
通话请求的事件，v1.4.6+ 支持
﻿TUICallEvent.CALLING_CANCEL﻿
通话取消的事件，
后续废弃，建议使用 TUICallEvent.ON_CALL_CANCELED
﻿TUICallEvent.ON_CALL_CANCELED﻿
通话取消的事件，v1.4.6+ 支持
﻿TUICallEvent.ON_CALL_BEGIN﻿
通话接通时抛出的事件
﻿TUICallEvent.CALLING_END﻿
通话结束的事件
﻿TUICallEvent.DEVICED_UPDATED﻿
设备列表更新的事件
﻿TUICallEvent.CALL_TYPE_CHANGED﻿
通话的媒体类型发生改变的回调
﻿TUICallEvent.ON_USER_NETWORK_QUALITY_CHANGED﻿
所有用户网络质量的事件，v3.0.7+ 支持
文档链接
﻿TUICallEngine﻿
﻿TUICallEvent﻿
﻿

tencent cloud

Recent Pages

API 概览

TUICallKit（含 UI 组件）

TUICallEngine (无 UI 接口)

事件类型定义

文档链接

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

API	描述
init	初始化 TUICallKit 组件实例
call	发起 1v1 通话，支持自定义房间号、通话邀请超时时间，离线推送内容等
groupCall	发起群组通话，支持自定义房间号、通话邀请超时时间，离线推送内容等
joinInGroupCall	主动加入当前的群组通话中，v3.1.2+ 支持
setCallingBell	设置自定义来电铃音，v3.0.0+ 支持
setSelfInfo	设置用户昵称和头像，v2.2.0+ 支持
enableMuteMode	开启/关闭来电铃声，v3.1.2+ 支持
enableFloatWindow	开启/关闭悬浮窗功能，v3.1.0+ 支持
enableVirtualBackground	开启/关闭模糊背景的功能按钮，v3.2.4+ 支持
setLanguage	设置 TUICallKit 组件通话语言
hideFeatureButton	隐藏按钮，v3.2.9+ 支持
setLocalViewBackgroundImage	设置本地用户通话界面背景图，v3.2.9+ 支持
setRemoteViewBackgroundImage	设置远端用户通话界面背景图，v3.2.9+ 支持
setLayoutMode	设置通话界面布局模式，v3.3.0+ 支持
setCameraDefaultState	设置摄像头是否默认打开，v3.3.0+ 支持
destroyed	销毁 TUICallKit 组件实例

API	描述
createInstance	创建 TUICallEngine 实例（单例模式）
destroyInstance	销毁 TUICallEngine 实例（单例模式）
on	监听事件
off	取消监听事件
login	登录接口
logout	登出接口
setSelfInfo	设置用户昵称和头像
call	发起 1v1 通话
groupCall	群聊邀请通话
accept	接听通话
reject	拒绝通话
hangup	结束通话
switchCallMediaType	音视频通话切换
startRemoteView	启动远端画面渲染
stopRemoteView	停止远端画面渲染
startLocalView	启动本地画面渲染，注意：后续将废弃，建议使用 openCamera
stopLocalView	停止本地画面渲染，注意：后续将废弃，建议使用 closeCamera
openCamera	开启摄像头
closeCamara	关闭摄像头
switchCamera	切换前后置摄像头，注意：仅移动端支持。v3.0.0+ 支持
openMicrophone	打开麦克风
closeMicrophone	关闭麦克风
setVideoQuality	设置视频质量
getDeviceList	获取设备列表
switchDevice	切换摄像头或麦克风设备
enableAIVoice	开启/关闭 AI 降噪
enableMultiDeviceAbility	开启/关闭 TUICallEngine 的多设备登录模式。v2.1.1+ 支持
setBlurBackground	开关/设置背景虚化，v3.0.6+ 支持
setVirtualBackground	开关/设置图片背景虚化，v3.0.6+ 支持

EVENT	描述
TUICallEvent.ERROR	通话过程中错误事件
TUICallEvent.SDK_READY	SDK 进入 ready 状态时收到该事件
TUICallEvent.KICKED_OUT	用户重复登录，被踢下线
TUICallEvent.USER_ACCEPT	xxxx 用户接通的事件
TUICallEvent.USER_ENTER	xxxx 用户加入通话的事件
TUICallEvent.USER_LEAVE	xxxx 用户离开通话的事件
TUICallEvent.REJECT	xxxx 用户拒绝通话的事件
TUICallEvent.NO_RESP	xxxx 用户不响应的事件
TUICallEvent.LINE_BUSY	xxxx 用户忙线的事件
TUICallEvent.USER_VIDEO_AVAILABLE	xxxx 用户是否有视频流的事件
TUICallEvent.USER_AUDIO_AVAILABLE	xxxx 用户是否有音频流的事件
TUICallEvent.USER_VOICE_VOLUME	所有用户音量大小的反馈事件
TUICallEvent.GROUP_CALL_INVITEE_LIST_UPDATE	群聊更新邀请列表收到该事件
TUICallEvent.ON_CALL_BEGIN	通话接通的事件，v1.4.6+ 支持
TUICallEvent.INVITED	通话请求的事件，后续废弃，建议使用 TUICallEvent.ON_CALL_RECEIVED
TUICallEvent.ON_CALL_RECEIVED	通话请求的事件，v1.4.6+ 支持
TUICallEvent.CALLING_CANCEL	通话取消的事件，后续废弃，建议使用 TUICallEvent.ON_CALL_CANCELED
TUICallEvent.ON_CALL_CANCELED	通话取消的事件，v1.4.6+ 支持
TUICallEvent.ON_CALL_BEGIN	通话接通时抛出的事件
TUICallEvent.CALLING_END	通话结束的事件
TUICallEvent.DEVICED_UPDATED	设备列表更新的事件
TUICallEvent.CALL_TYPE_CHANGED	通话的媒体类型发生改变的回调
TUICallEvent.ON_USER_NETWORK_QUALITY_CHANGED	所有用户网络质量的事件，v3.0.7+ 支持

tencent cloud

注册

登录

Recent Pages

API 概览

TUICallKit（含 UI 组件）

TUICallEngine (无 UI 接口)

事件类型定义

文档链接

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？