腾讯云即时通信IMTUICallEngine_AI解决方案_同尘科技
TUICallEngine API 简介
TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套接口自己封装交互。
API 概览
API | 描述 |
init | 初始化 SDK 函数,完成包含通话服务鉴权在内初始化动作 |
| |
unInit | 反初始化函数,释放 TUICallEngine 使用到的相关资源。 |
addObserver | 增加事件回调 |
removeObserver | 移除回调接口 |
call | 发起 1v1 通话 |
groupCall | 发起群组通话 |
accept | 接听通话 |
reject | 拒绝通话 |
hangup | 结束通话 |
ignore | 忽略通话 |
inviteUser | 在群组通话中,邀请其他人加入 |
joinInGroupCall | 主动加入当前的群组通话中 |
switchCallMediaType | 切换通话媒体类型,比如视频通话切音频通话 |
startRemoteView | 开始订阅远端用户视频流 |
stopRemoteView | 停止订阅远端用户视频流 |
openCamera | 开启摄像头 |
closeCamera | 关闭摄像头 |
switchCamera | 切换前后摄像头 |
openMicrophone | 打开麦克风 |
closeMicrophone | 关闭麦克风 |
selectAudioPlaybackDevice | 选择音频播放设备(听筒/免提) |
setSelfInfo | 设置用户的头像、昵称 |
enableMultiDeviceAbility | 开启/关闭 TUICallEngine 的多设备登录模式 (尊享版套餐支持) |
setVideoRenderParams | 设置用户视频画面的渲染模式 |
setVideoEncoderParams | 设置视频编码的编码参数 |
queryRecentCalls | 查询通话记录 |
deleteRecordCalls | 删除通话记录 |
setBeautyLevel | 设置美颜级别 |
API 详情
init
初始化函数,请在使用所有功能之前先调用该函数,以便完成包含通话服务鉴权在内初始化动作。
Future init(int sdkAppID, String userId, String userSig)
unInit
反初始化函数,释放TUICallEngine
使用到的相关资源。
Future unInit()
addObserver
添加回调接口,您可以通过这个接口,监听TUICallObserver
相关的事件回调。
Future addObserver(TUICallObserver observer)
removeObserver
移除回调接口。
Future removeObserver(TUICallObserver observer)
call
拨打电话(1v1通话)。
Future call(String userId, TUICallMediaType mediaType, TUICallParams params)
参数如下表所示:
参数 | 类型 | 含义 |
userId | String | 目标用户的 userId |
mediaType | TUICallMediaType | 通话的媒体类型,比如视频通话、语音通话 |
params | TUICallParams | 通话参数扩展字段,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
groupCall
发起群组通话。注意:使用群组通话前需要创建 IM 群组,如果已经创建,请忽略。
Future groupCall(String groupId, List userIdList, TUICallMediaType mediaType, TUICallParams params)
参数 | 类型 | 含义 |
groupId | String | 此次群组通话的群 ID |
userIdList | List | 目标用户的 userId 列表 |
mediaType | TUICallMediaType | 通话的媒体类型,比如视频通话、语音通话 |
params | TUICallParams | 通话参数扩展字段,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
accept
接受当前通话,当您作为被叫收到 onCallReceived()
的回调时,可以调用该函数接听来电。
Future accept()
reject
拒绝当前通话,当您作为被叫收到 onCallReceived()
的回调时,可以调用该函数拒绝来电。
Future reject()
ignore
忽略当前通话,当您作为被叫收到 onCallReceived()
的回调时,可以调用该函数忽略来电,此时主叫会收到onUserLineBusy
的回调。
备注:如果您的业务中存在直播、会议等场景,在直播/会议中的情况时,也可以调用这个函数来忽略此次来电。
Future ignore()
hangup
挂断当前通话,当您处于通话中,可以调用该函数结束通话。
Future hangup()
inviteUser
邀请用户加入此次群组通话。
使用场景:一个群组通话中的用户主动邀请其他人时使用。
Future iniviteUser(List userIdList, TUICallParams params, TUIValueCallback callback)
参数 | 类型 | 含义 |
userIdList | List | 目标用户的 userId 列表 |
params | TUICallParams | 通话参数扩展字段,例如:离线推送自定义内容 |
joinInGroupCall
主动加入此次群组通话。
使用场景:群组内用户主动加入此次群组通话使用。
Future joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType mediaType)
参数 | 类型 | 含义 |
roomId | TUIRoomId | 此次通话的音视频房间 ID |
groupId | String | 此次群组通话的群 ID |
mediaType | TUICallMediaType | 通话的媒体类型,比如视频通话、语音通话 |
switchCallMediaType
切换视频通话到语音通话。
Future switchCallMediaType(TUICallMediaType mediaType)
参数 | 类型 | 含义 |
mediaType | TUICallMediaType | 通话的媒体类型,比如视频通话、语音通话 |
startRemoteView
设置显示视频画面的 View 对象。
Future startRemoteView(String userId, intviewId)
参数 | 类型 | 含义 |
userId | String | 目标用户的 userId |
intviewId | Int | 显示视频画面的 widget 对应的 ID |
stopRemoteview
停止订阅远端用户的视频数据。
Future stopRemoteView(String userId)
参数 | 类型 | 含义 |
userId | String | 目标用户的 userId |
openCamera
开启摄像头。
Future openCamera(TUICamera camera, int? viewId)
参数 | 类型 | 含义 |
camera | TUICamera | 前置/后置 摄像头 |
viewId | Int | 显示视频画面的 widget 对应的 ID |
closeCamera
关闭摄像头。
Future closeCamera()
switchCamera
切换前后摄像头。
Future switchCamera(TUICamera camera)
参数 | 类型 | 含义 |
camera | TUICamera | 前置/后置 摄像头 |
openMicrophone
打开麦克风。
Future openMicrophone()
closeMicrophone
关闭麦克风。
Future closeMicrophone()
selectAudioPlaybackDevice
选择音频播放设备。
目前支持听筒、扬声器,在通话场景中,可以使用这个接口来开启/关闭免提模式。
Future selectAudioPlaybackDevice(TUIAudioPlaybackDevice device)
参数 | 类型 | 含义 |
device | TUIAudioPlaybackDevice | 听筒/扬声器 |
setSelfInfo
设置用户昵称、头像。
用户昵称不能超过500字节,用户头像必须是 URL 格式。
Future setSelfInfo(String nickname, String avatar)
参数 | 类型 | 含义 |
nickname | String | 用户昵称 |
avatar | String | 用户头像(格式为 URL) |
enableMultiDeviceAbility
开启/关闭 TUICallEngine 的多设备登录模式 (尊享版套餐支持)。
Future enableMultiDeviceAbility(bool enable)
setVideoRenderParams
设置用户视频画面的渲染模式。
Future setVideoRenderParams(String userId, VideoRenderParams params)
参数如下表所示:
参数 | 类型 | 含义 |
userId | String | 目标用户的 userId |
params | VideoRenderParams | 视频画面渲染参数,例如:画面旋转角度、填充模式 |
setVideoEncoderParams
设置视频编码的编码参数。该设置能够决定远端用户看到的画面质量,同时也能决定云端录制出的视频文件的画面质量。
Future setVideoEncoderParams(VideoEncoderParams params)
参数如下表所示:
参数 | 类型 | 含义 |
params | VideoEncoderParams | 视频编码的参数,例如:分辨率、视频宽高比 |
queryRecentCalls
查询通话记录。
Future queryRecentCalls(TUICallRecentCallsFilter filter, TUIValueCallback callback)
参数如下表所示:
参数 | 类型 | 含义 |
filter | TUICallRecentCallsFilter | 查询过滤条件 |
deleteRecordCalls
删除通话记录。
Future deleteRecordCalls(List callIdList, TUIValueCallback callback)
参数如下表所示:
参数 | 类型 | 含义 |
callIdList | List | 待删除记录的 ID 列表 |
setBeautyLevel
设置美颜级别。
Future setBeautyLevel(double level)
参数如下表所示:
参数 | 类型 | 含义 |
level | double | 美颜等级,使用范围0.0~9.0 |
对即时通讯IM解决方案有疑惑?想了解解决方案收费? 联系解决方案专家
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠
阿里云解决方案也看看?: 点击对比阿里云的解决方案
暂无评论,你要说点什么吗?