API | 描述 |
初始化 TUICallKit 组件实例 | |
发起 1v1 通话 | |
发起群组通话 | |
主动加入当前的群组通话中 | |
设置自定义来电铃音 | |
设置用户昵称和头像 | |
开启/关闭来电铃声 | |
开启/关闭悬浮窗功能 | |
设置 TUICallKit 组件通话语言 | |
销毁 TUICallKit 组件实例 |
<TUICallKit/>
属性介绍属性 | 描述 | 类型 | 是否必填 | 默认值 | 支持 vue | 支持 react |
allowedMinimized | 是否允许悬浮窗 | boolean | 否 | false |
√
| √ |
allowedFullScreen | 是否允许通话界面全屏 | boolean | 否 | true | √ | √ |
通话界面显示模式 | VideoDisplayMode | 否 | VideoDisplayMode.COVER | √ | √ | |
通话分辨率 | VideoResolution | 否 | VideoResolution.RESOLUTION_480P | √ | √ | |
beforeCalling | 拨打电话前与收到通话邀请前会执行此函数 | function(type, error) | 否 | - | √ | √ |
afterCalling | 结束通话后会执行此函数 | function() | 否 | - | √ | √ |
onMinimized | function(oldStatus, newStatus) | 否 | - | √ | × | |
kickedOut | 组件抛出的事件,当前登录用户被踢出登录时会触发该事件,通话也会自动结束 | function() | 否 | - | √ | × |
statusChanged | function({oldStatus, newStatus}) | 否 | - | √ | × |
import { TUICallKit, VideoDisplayMode, VideoResolution } from "@tencentcloud/call-uikit-react";<TUICallKitvideoDisplayMode={VideoDisplayMode.CONTAIN}videoResolution={VideoResolution.RESOLUTION_1080P}beforeCalling={handleBeforeCalling}afterCalling={handleAfterCalling}/>function handleBeforeCalling(type: string, error: any) {console.log("[TUICallkit Demo] handleBeforeCalling:", type, error);}function handleAfterCalling() {console.log("[TUICallkit Demo] handleAfterCalling");}
<template><TUICallKit:allowedMinimized="true":allowedFullScreen="true":videoDisplayMode="VideoDisplayMode.CONTAIN":videoResolution="VideoResolution.RESOLUTION_1080P":beforeCalling="beforeCalling":afterCalling="afterCalling":onMinimized="onMinimized":kickedOut="handleKickedOut":statusChanged="handleStatusChanged"/></template><script lang="ts" setup>import { TUICallKit, TUICallKitServer, VideoDisplayMode, VideoResolution, STATUS } from "@tencentcloud/call-uikit-vue";function beforeCalling(type: string, error: any) {console.log("[TUICallkit Demo] beforeCalling:", type, error);}function afterCalling() {console.log("[TUICallkit Demo] afterCalling");}function onMinimized(oldStatus: string, newStatus: string) {console.log("[TUICallkit Demo] onMinimized: " + oldStatus + " -> " + newStatus);}function kickedOut() {console.log("[TUICallkit Demo] kickedOut");}function statusChanged(args: { oldStatus: string; newStatus: string; }) {const { oldStatus, newStatus } = args;if (newStatus === STATUS.CALLING_C2C_VIDEO) {console.log(`[TUICallkit Demo] statusChanged: ${oldStatus} -> ${newStatus}`);}}</script>
import { TUICallKitServer } from "@tencentcloud/call-uikit-react";// Replace it with the call-uikit npm package you are currently using
try {await TUICallKitServer.init({ SDKAppID, userID, userSig });// If you already have a tim instance in your project, you need to pass it in here// await TUICallKitServer.init({ tim, SDKAppID, userID, userSig});alert("[TUICallKit] Initialization succeeds.");} catch (error: any) {alert(`[TUICallKit] Initialization failed. Reason: ${error}`);}
参数 | 类型 | 是否必填 | 含义 |
SDKAppID | Number | 是 | 云通信应用的 SDKAppID |
userID | String | 是 | 当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_) |
userSig | String | 是 | |
tim | Any | 否 | tim 参数适用于业务中已存在 TIM 实例,为保证 TIM 实例唯一性 |
try {await TUICallKitServer.call({userID: callUserID,type: TUICallType.VIDEO_CALL,});} catch (error: any) {alert(`[TUICallKit] Call failed. Reason: ${error}`);}
参数 | 类型 | 是否必填 | 含义 |
userID | String | 是 | 目标用户的 userId |
type | 是 | ||
roomID | Number | 否 | 数字房间号,范围 [1, 2147483647] |
timeout | Number | 否 | 通话的超时时间,0 为不超时, 单位 s(秒)(选填) - 默认 30s |
userData | String | 否 | 扩展字段: 用于在邀请信令中增加扩展信息 |
Object | 否 | 自定义离线消息推送 |
try {await TUICallKitServer.groupCall({userIDList: ['jack', 'tom'],groupID: "xxx",type: TUICallType.VIDEO_CALL});} catch (error: any) {alert(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);}
参数 | 类型 | 是否必填 | 含义 |
userIDList | Array<String> | 是 | 邀请列表成员列表 |
type | 是 | ||
groupID | String | 是 | |
roomID | Number | 否 | 数字房间号,范围 [1, 2147483647] |
timeout | Number | 否 | 通话的超时时间,0 为不超时, 单位 s(秒)(选填) - 默认 30s |
userData | String | 否 | 扩展字段:用于在邀请信令中增加扩展信息 |
Object | 否 | 自定义离线消息推送 |
TUICallKitServer.setLanguage("zh-cn"); // "en" | "zh-cn"
参数 | 类型 | 是否必填 | 含义 |
lang | String | 是 | 语言类型 en 或 zh-cn |
try {await TUICallKitServer.setSelfInfo({ nickName: "xxx", avatar: "http://xxx" });} catch (error: any) {alert(`[TUICallKit] Failed to call the setSelfInfo API. Reason: ${error}`;}
参数 | 类型 | 是否必填 | 含义 |
nickName | String | 是 | 用户昵称 |
avatar | String | 是 | 用户头像地址 |
try {await TUICallKitServer.setCallingBell(filePath?: string)} catch (error: any) {alert(`[TUICallKit] Failed to call the setCallingBell API. Reason: ${error}`);}
false
,通话界面左上角的悬浮窗按钮隐藏,设置为 true 后显示。try {await TUICallKitServer.enableFloatWindow(enable: Boolean)} catch (error: any) {alert(`[TUICallKit] Failed to call the enableFloatWindow API. Reason: ${error}`);}
try {await TUICallKitServer.enableMuteMode(enable: boolean)} catch (error: any) {alert(`[TUICallKit] Failed to call the enableMuteMode API. Reason: ${error}`);}
try {const params = {type: TUICallType.VIDEO_CALL,groupID: "xxx",roomID: 0,};await TUICallKitServer.joinInGroupCall(params);} catch (error: any) {alert(`[TUICallKit] Failed to call the enableMuteMode API. Reason: ${error}`);}
参数 | 类型 | 是否必填 | 含义 |
type | 是 | 通话的媒体类型,例如视频通话、语音通话 | |
groupID | string | 是 | 此次群组通话的群 ID |
roomID | number | 是 | 此次通话的音视频房间 ID |
tim
,需要手动退出tim.logout();
。try {await TUICallKitServer.destroyed();} catch (error: any) {alert(`[TUICallKit] Failed to call the destroyed API. Reason: ${error}`);}
videoDisplayMode
属性有三个值:VideoDisplayMode.CONTAIN
VideoDisplayMode.COVER
VideoDisplayMode.FILL
,默认值是VideoDisplayMode.COVER
。属性 | 值 | 描述 |
videoDisplayMode | VideoDisplayMode.CONTAIN | 优先保证视频内容全部显示。 视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。 如果视频尺寸与显示视窗尺寸不一致,在保持长宽比的前提下,将视频进行缩放后填满视窗,缩放后的视频四周会有一圈黑边。 |
| VideoDisplayMode.COVER | 优先保证视窗被填满。 视频尺寸等比缩放,直至整个视窗被视频填满。 如果视频长宽与显示窗口不同,则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。 |
| VideoDisplayMode.FILL | 保证视窗被填满的同时保证视频内容全部显示,但是不保证视频尺寸比例不变。 视频的宽高会被拉伸至和视窗尺寸一致。 |
videoResolution
有三个值:VideoResolution.RESOLUTION_480P
VideoResolution.RESOLUTION_720P
VideoResolution.RESOLUTION_1080P
,默认值是VideoResolution.RESOLUTION_480P
。视频 Profile | 分辨率(宽 × 高) | 帧率(fps) | 码率(kbps) |
480p | 640 × 480 | 15 | 900 |
720p | 1280 × 720 | 15 | 1500 |
1080p | 1920 × 1080 | 15 | 2000 |
STATUS 属性值 | 描述 |
STATUS.IDLE | 闲置状态 |
STATUS.BE_INVITED | 收到通话邀请 |
STATUS.DIALING_C2C | 正在 1v1 呼叫 |
STATUS.DIALING_GROUP | 正在群组呼叫 |
STATUS.CALLING_C2C_AUDIO | 正在 1v1 语音通话 |
STATUS.CALLING_C2C_VIDEO | 正在 1v1 视频通话 |
STATUS.CALLING_GROUP_AUDIO | 正在群组语音通话 |
STATUS.CALLING_GROUP_VIDEO | 正在群组视频通话 |
TUICallType 类型 | 描述 |
TUICallType.AUDIO_CALL | 语音通话 |
TUICallType.VIDEO_CALL | 视频通话 |
参数 | 类型 | 是否必填 | 含义 |
offlinePushInfo.title | String | 否 | 离线推送标题(选填) |
offlinePushInfo.description | String | 否 | 离线推送内容(选填) |
offlinePushInfo.androidOPPOChannelID | String | 否 | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID(选填) |
offlinePushInfo.extension | String | 否 | 离线推送透传内容(选填)(tsignaling 版本 >= 0.9.0) |
本页内容是否解决了您的问题?