製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
TUICallKit is an audio/video call component that includes UI elements. You can use its APIs to quickly implement an audio/video call application similar to WeChat. For directions on integration, see Integrating TUICallKit.API | Description |
login | |
logout | |
Sets the user nickname and profile photo. | |
Makes a one-to-one call. | |
Makes a group call. | |
Joins a group call. | |
Sets the ringtone. | |
Sets whether to turn on the mute mode. | |
Sets whether to enable floating windows. | |
Sets whether to display incoming banner. v2.3.1 supported. |
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}`);}});
Parameter | Type | Description |
options | Object | Initialization parameters |
options.SDKAppID | Number | User SDKAppID |
options.userID | String | userID |
options.userSig | String | User Signature |
callback | Function | callback function, code = 0 means the call was successful; code ! = 0 means the call failed, see msg for the reason. |
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}`);}});
Parameter | Type | Description |
callback | Function | callback function, code = 0 means the call was successful; code ! = 0 means the call failed, see msg for the reason. |
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}`);}});
Parameter | Type | Description |
options | Object | Initialization parameters |
options.nickName | String | Nickname of the target user, not required |
options.avatar | String | Target user's avatar, not required |
callback | Function | callback function, code = 0 means the call was successful; code ! = 0 means the call failed, see msg for the reason. |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {userID: 'mike',callMediaType: 1, // audio call(callMediaType = 1)、video call(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}`);}});
Parameter | Type | Description |
options | Object | Initialization parameters |
options.userID | String | The userID of the target user |
options.callMediaType | Number | Media type of the call, e.g., voice call (callMediaType = 1), video call (callMediaType = 2) |
options.roomID | Number | Customize the numeric room number. As long as the roomID is present, the numeric room number is used, even if strRoomID is present. |
options.strRoomID | String | Customize the string room number. If you want to use a string room number, you need to set roomID = 0 after setting strRoomID. |
callback | Function | callback function, code = 0 means the call was successful; code ! = 0 means the call failed, see msg for the reason. |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {groupID: 'myGroup',userIDList: ['mike', 'tom'],callMediaType: 1, // audio call(callMediaType = 1)、video call(callMediaType = 2)};TUICallKit.groupCall(options, (res) => {if (res.code === 0) {console.log('call success');} else {console.log(`call failed, error message = ${res.msg}`);}});
Parameter | Type | Description |
options | Object | Initialization parameters |
options.groupID | String | Group ID for this group cal |
options.userIDList | List | The target user IDs. |
options.callMediaType | Number | Media type of the call, e.g., voice call (callMediaType = 1), video call (callMediaType = 2) |
options.roomID | Number | Customize the numeric room number. As long as the roomID is present, the numeric room number is used, even if strRoomID is present. |
options.strRoomID | String | Customize the string room number. If you want to use a string room number, you need to set roomID = 0 after setting strRoomID. |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const options = {roomID: 9898,groupID: 'myGroup',callMediaType: 1, // audio call(callMediaType = 1)、video call(callMediaType = 2)};TUICallKit.joinInGroupCall(options, (res) => {if (res.code === 0) {console.log('joinInGroupCall success');} else {console.log(`joinInGroupCall failed, error message = ${res.msg}`);}});
Parameter | Type | Description |
options | Object | Initialization parameters |
options.roomID | Number | Customize the numeric room number. As long as the roomID is present, the numeric room number is used, even if strRoomID is present. |
options.strRoomID | String | Customize the string room number. If you want to use a string room number, you need to set roomID = 0 after setting strRoomID. |
options.groupID | String | Group ID for this group cal |
options.callMediaType | Number | Media type of the call, e.g., voice call (callMediaType = 1), video call (callMediaType = 2) |
callback | Function | callback function, code = 0 means the call was successful; code ! = 0 means the call failed, see msg for the reason. |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');// 【1】Save audio files locally through uni.saveFile. Reference.: https://zh.uniapp.dcloud.io/api/file/file.html#savefileconst tempFilePath = './static/rain.mp3';let musicFilePath = '';uni.saveFile({tempFilePath: tempFilePath,success: (res) => {musicFilePath = res.savedFilePath;// 【2】Convert relative path to absolute path, otherwise access will not be possiblemusicFilePath = plus.io.convertLocalFileSystemURL(musicFilePath);// 【3】set ringtoneTUICallKit.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');},});
Parameter | Type | Description |
filePath | String | Ringtone local file address |
callback | Function | callback function, code = 0 means the call was successful; code ! = 0 means the call failed, see msg for the reason. |
const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const enable = true;TUICallKit.enableMuteMode(enable);
Parameter | Type | Description |
enable | Boolean | Mute on, mute off; true means mute on |
false, and the floating window button in the top left corner of the call view is hidden. If it is set to true, the button will become visible.const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const enable = true;TUICallKit.enableFloatWindow(enable);
Parameter | Type | Description |
enable | Boolean | Enable/disable the floating window function; true means floating window is enabled. |
false, The callee will pop up a full-screen call view by default when receiving the invitation. If it is set to true, the callee will display a banner first.const TUICallKit = uni.requireNativePlugin('TencentCloud-TUICallKit');const enable = true;TUICallKit.enableIncomingBanner(enable);
フィードバック