产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
API | 描述 |
登录 | |
登出 | |
设置用户的昵称、头像 | |
发起 1v1 通话 | |
发起群组通话 | |
主动加入当前的群组通话中 | |
设置自定义来电铃音 | |
开启/关闭静音模式 | |
开启/关闭悬浮窗功能 | |
开启/关闭来电横幅显示，v2.3.1+ 支持 |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {SDKAppID: 0,userID: 'mike',userSig: '',};TUICallKit.login(options, (res) => {if (res.code === 0) {console.log('login success');} else {console.log(`login failed, error message = ${res.msg}`);}});
参数 | 类型 | 含义 |
options | Object | 初始化参数 |
options.SDKAppID | Number | 用户 SDKAppID |
options.userID | String | 用户 ID |
options.userSig | String | 用户签名 userSig |
callback | Function | 回调函数，code = 0 表示调用成功；code != 0 表示调用失败，失败原因见 msg |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');TUICallKit.logout((res) => {if (res.code === 0) {console.log('logout success');} else {console.log(`logout failed, error message = ${res.msg}`);}});
参数 | 类型 | 含义 |
callback | Function | 回调函数，code = 0 表示调用成功；code != 0 表示调用失败，失败原因见 msg |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {nickName: 'jack',avatar: 'https:/****/user_avatar.png'}TUICallKit.setSelfInfo(options, (res) => {if (res.code === 0) {console.log('setSelfInfo success');} else {console.log(`setSelfInfo failed, error message = ${res.msg}`);}});
参数 | 类型 | 含义 |
options | Object | 初始化参数 |
options.nickName | String | 目标用户的昵称，非必填 |
options.avatar | String | 目标用户的头像，非必填 |
callback | Function | 回调函数，code = 0 表示调用成功；code != 0 表示调用失败，失败原因见 msg |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {userID: 'mike',callMediaType: 1, // 语音通话(callMediaType = 1)、视频通话(callMediaType = 2)roomID: 0,strRoomID: '1223', // 使用字符串房间号};TUICallKit.call(options, (res) => {if (res.code === 0) {console.log('call success');} else {console.log(`call failed, error message = ${res.msg}`);}});
参数 | 类型 | 含义 |
options | Object | 初始化参数 |
options.userID | String | 目标用户的 userID |
options.callMediaType | Number | 通话的媒体类型，比如：语音通话(callMediaType = 1)、视频通话(callMediaType = 2) |
options.roomID | Number | 自定义数字房间号。只要有 roomID，就用的是数字房间号，即使 strRoomID 存在。 |
options.strRoomID | String | 自定义字符串房间号。如果想使用字符串房间号，设置 strRoomID 后需要将 roomID = 0。 |
callback | Function | 回调函数，code = 0 表示调用成功；code != 0 表示调用失败，失败原因见 msg |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {groupID: 'myGroup',userIDList: ['mike', 'tom'],callMediaType: 1, // 语音通话(callMediaType = 1)、视频通话(callMediaType = 2)};TUICallKit.groupCall(options, (res) => {if (res.code === 0) {console.log('call success');} else {console.log(`call failed, error message = ${res.msg}`);}});
参数 | 类型 | 含义 |
options | Object | 初始化参数 |
options.groupID | String | 此次群组通话的群 ID |
options.userIDList | List | 目标用户的userId 列表 |
options.callMediaType | Number | 通话的媒体类型，比如：语音通话(callMediaType = 1)、视频通话(callMediaType = 2) |
options.roomID | Number | 自定义数字房间号。只要有 roomID，就用的是数字房间号，即使 strRoomID 存在。 |
options.strRoomID | String | 自定义字符串房间号。如果想使用字符串房间号，设置 strRoomID 后需要将 roomID = 0。 |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {roomID: 9898,groupID: 'myGroup',callMediaType: 1, // 语音通话(callMediaType = 1)、视频通话(callMediaType = 2)};TUICallKit.joinInGroupCall(options, (res) => {if (res.code === 0) {console.log('joinInGroupCall success');} else {console.log(`joinInGroupCall failed, error message = ${res.msg}`);}});
参数 | 类型 | 含义 |
options | Object | 初始化参数 |
options.roomID | Number | 此次通话的音视频房间 ID，目前仅支持数字房间号，后续版本会支持字符串房间号 |
options.groupID | String | 此次群组通话的群 ID |
options.callMediaType | Number | 通话的媒体类型，比如：语音通话(callMediaType = 1)、视频通话(callMediaType = 2) |
callback | Function | 回调函数，code = 0 表示调用成功；code != 0 表示调用失败，失败原因见 msg |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');// 【1】通过 uni.saveFile 保存音频文件到本地，具体参考 saveFile 接口: https://zh.uniapp.dcloud.io/api/file/file.html#savefileconst tempFilePath = './static/rain.mp3';let musicFilePath = '';uni.saveFile({tempFilePath: tempFilePath,success: (res) => {console.warn('保存文件成功 = ', JSON.stringify(res));musicFilePath = res.savedFilePath;// 【2】相对路径转绝对路径，否则访问不到musicFilePath = plus.io.convertLocalFileSystemURL(musicFilePath);// 【3】设置铃声TUICallKit.setCallingBell(musicFilePath, (res) => {if (res.code === 0) {console.log('setCallingBell success');} else {console.log(`setCallingBell failed, error message = ${res.msg}`);}});},fail: (err) => {console.error('save failed');},});
参数 | 类型 | 含义 |
filePath | String | 来电铃音本地文件地址 |
callback | Function | 回调函数，code = 0 表示调用成功；code != 0 表示调用失败，失败原因见 msg |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const enable = true;TUICallKit.enableMuteMode(enable);
参数 | 类型 | 含义 |
enable | Boolean | 开启、关闭静音；true 表示开启静音 |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const enable = true;TUICallKit.enableFloatWindow(enable);
参数 | 类型 | 含义 |
enable | Boolean | 开启、关闭悬浮窗功能；true 表示开启浮窗 |
false，被叫端收到邀请后默认弹出全屏通话等待界面，开启后先展示一个横幅，然后根据需要拉起全屏通话界面。const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const enable = true;TUICallKit.enableIncomingBanner(enable);
文档反馈