即时通信 IM API 概览

TUICallKit (含 UI 接口)
TUICallKit API 是音视频通话组件的含 UI 接口，使用 TUICallKit API，您可以通过简单接口快速实现一个类微信的音视频通话场景。
API
描述
﻿login﻿
登录。
﻿logout﻿
登出。
﻿setSelfInfo﻿
设置用户的昵称、头像。
﻿calls﻿
发起通话。
﻿join﻿
主动加入通话。
﻿enableMuteMode﻿
开启/关闭静音模式。
﻿enableFloatWindow﻿
开启/关闭悬浮窗功能。
﻿setCallingBell﻿
设置自定义来电铃音。
﻿enableVirtualBackground﻿
开启/关闭虚拟背景功能。
TUICallEngine (无 UI 接口)
TUICallEngine API 是音视频通话组件的无 UI 接口，如果 TUICallKit 的交互并不满足您的需求，您可以使用这套 API 根据您的业务需求自定义封装。
API
描述
﻿init﻿
初始化 SDK 函数，完成包含通话服务鉴权在内初始化动作。
﻿
﻿
﻿unInit﻿
反初始化函数，释放 TUICallEngine 使用到的相关资源。
﻿addObserver﻿
增加事件回调。
﻿removeObserver﻿
移除回调接口。
﻿calls﻿
发起通话。
﻿accept﻿
接听通话。
﻿reject﻿
拒绝通话。
﻿hangup﻿
结束通话。
﻿join﻿
主动加入通话
﻿inviteUser﻿
邀请其他人加入通话。
﻿startRemoteView﻿
开始订阅远端用户视频流。
﻿stopRemoteView﻿
停止订阅远端用户视频流。
﻿openCamera﻿
开启摄像头。
﻿closeCamera﻿
关闭摄像头。
﻿switchCamera﻿
切换前后摄像头。
﻿openMicrophone﻿
打开麦克风。
﻿closeMicrophone﻿
关闭麦克风。
﻿selectAudioPlaybackDevice﻿
选择音频播放设备（听筒/免提）。
﻿setSelfInfo﻿
设置用户的头像、昵称。
﻿enableMultiDeviceAbility﻿
开启/关闭 TUICallEngine 的多设备登录模式 （尊享版套餐支持）。
﻿setVideoRenderParams﻿
设置用户视频画面的渲染模式。
﻿setVideoEncoderParams﻿
设置视频编码的编码参数。
﻿setBeautyLevel﻿
设置美颜级别。
﻿setBlurBackground﻿
设置视频模糊效果。
﻿setVirtualBackground﻿
设置虚拟背景图片。
TUICallObserver
TUICallObserver 是回调事件类，您可以通过此回调，来监听自己感兴趣的回调事件。
API
描述
﻿onError﻿
通话过程中错误回调。
﻿onUserInviting﻿
当用户被邀请加入通话时的回调。
﻿onCallReceived﻿
通话请求的回调。
﻿onCallNotConnected﻿
当前设备未接通通话。
﻿onCallBegin﻿
通话接通的回调。
﻿onCallEnd﻿
通话结束的回调。
﻿onUserReject﻿
xxxx 用户拒绝通话的回调。
﻿onUserNoResponse﻿
xxxx 用户不响应的回调。
﻿onUserLineBusy﻿
xxxx 用户忙线的回调。
﻿onUserJoin﻿
xxxx 用户加入通话的回调。
﻿onUserLeave﻿
xxxx 用户离开通话的回调。
﻿onUserVideoAvailable﻿
xxxx 用户是否有视频流的回调。
﻿onUserAudioAvailable﻿
xxxx 用户是否有音频流的回调。
﻿onUserVoiceVolumeChanged﻿
所有用户音量大小的反馈回调。
﻿onUserNetworkQualityChanged﻿
所有用户网络质量的反馈回调。
﻿onKickedOffline﻿
当前用户被移下线。
﻿onUserSigExpired﻿
在线时票据过期。
关键类型定义
类型
描述
﻿VideoEncoderParams﻿
视频编码参数。
﻿VideoRenderParams﻿
视频画面的渲染参数。
﻿TUICallMediaType﻿
通话类型。
﻿TUICallParams﻿
通话拓展参数。
﻿TUICamera﻿
摄像头类型。
﻿TUIAudioPlaybackDevice﻿
音频播放路由。
﻿TUIRoomId﻿
房间 ID。

API	描述
login	登录。
logout	登出。
setSelfInfo	设置用户的昵称、头像。
calls	发起通话。
join	主动加入通话。
enableMuteMode	开启/关闭静音模式。
enableFloatWindow	开启/关闭悬浮窗功能。
setCallingBell	设置自定义来电铃音。
enableVirtualBackground	开启/关闭虚拟背景功能。

API	描述
init	初始化 SDK 函数，完成包含通话服务鉴权在内初始化动作。

unInit	反初始化函数，释放 TUICallEngine 使用到的相关资源。
addObserver	增加事件回调。
removeObserver	移除回调接口。
calls	发起通话。
accept	接听通话。
reject	拒绝通话。
hangup	结束通话。
join	主动加入通话
inviteUser	邀请其他人加入通话。
startRemoteView	开始订阅远端用户视频流。
stopRemoteView	停止订阅远端用户视频流。
openCamera	开启摄像头。
closeCamera	关闭摄像头。
switchCamera	切换前后摄像头。
openMicrophone	打开麦克风。
closeMicrophone	关闭麦克风。
selectAudioPlaybackDevice	选择音频播放设备（听筒/免提）。
setSelfInfo	设置用户的头像、昵称。
enableMultiDeviceAbility	开启/关闭 TUICallEngine 的多设备登录模式（尊享版套餐支持）。
setVideoRenderParams	设置用户视频画面的渲染模式。
setVideoEncoderParams	设置视频编码的编码参数。
setBeautyLevel	设置美颜级别。
setBlurBackground	设置视频模糊效果。
setVirtualBackground	设置虚拟背景图片。

API	描述
onError	通话过程中错误回调。
onUserInviting	当用户被邀请加入通话时的回调。
onCallReceived	通话请求的回调。
onCallNotConnected	当前设备未接通通话。
onCallBegin	通话接通的回调。
onCallEnd	通话结束的回调。
onUserReject	xxxx 用户拒绝通话的回调。
onUserNoResponse	xxxx 用户不响应的回调。
onUserLineBusy	xxxx 用户忙线的回调。
onUserJoin	xxxx 用户加入通话的回调。
onUserLeave	xxxx 用户离开通话的回调。
onUserVideoAvailable	xxxx 用户是否有视频流的回调。
onUserAudioAvailable	xxxx 用户是否有音频流的回调。
onUserVoiceVolumeChanged	所有用户音量大小的反馈回调。
onUserNetworkQualityChanged	所有用户网络质量的反馈回调。
onKickedOffline	当前用户被移下线。
onUserSigExpired	在线时票据过期。

类型	描述
VideoEncoderParams	视频编码参数。
VideoRenderParams	视频画面的渲染参数。
TUICallMediaType	通话类型。
TUICallParams	通话拓展参数。
TUICamera	摄像头类型。
TUIAudioPlaybackDevice	音频播放路由。
TUIRoomId	房间 ID。

API 概览

本页目录：

TUICallKit (含 UI 接口)

TUICallEngine (无 UI 接口)

TUICallObserver

关键类型定义