<TUICallKit/>
:UI 通话组件主体<TUICallKitMini/>
:UI 通话悬浮窗,若 <TUICallKit :allowedMinimized="true"/>
时,则 <TUICallKitMini/>
必须被放置在页面中<TUICallKitMini/>
UI 通话悬浮窗,≥v2.3.2 废弃,不再提供该组件。直接由 <TUICallKit/>
:UI 通话组件主体,实现悬浮窗样式,减少使用复杂度。TUICallKitServer
: 通话实例,成员函数:<TUICallKit/>
API 详情参数 | 说明 | 类型 | 是否必填 | 默认值 |
allowedMinimized | 是否允许最小化,最小化按钮会隐藏 | boolean | 否 | false |
allowedFullScreen | 是否允许全屏,全屏按钮会隐藏 | boolean | 否 | true |
videoDisplayMode | 画面显示模式 | VideoDisplayMode | 否 | VideoDisplayMode.COVER |
videoResolution | 通话分辨率 | VideoResolution | 否 | VideoResolution.RESOLUTION_480P |
beforeCalling | 拨打电话前与收到通话邀请前会执行此函数 | function(type, error) | 否 | - |
afterCalling | 结束通话后会执行此函数 | function() | 否 | - |
onMinimized | 组件切换最小化状态时会执行此函数 | function(oldStatus, newStatus) | 否 | - |
kickedOut | 当前登录用户被踢出登录时会触发该回调,通话也会自动结束 注意: ≥v2.3.2 支持 | function() | 否 | - |
statusChanged | 当通话状态发生变化时,会触发该回调,通话状态种类详见下方备注 注意: ≥v2.3.2 支持 | function({oldStatus, newStatus}) | 否 | - |
@kicked-out | 组件抛出的事件,当前登录用户被踢出登录是会触发该事件,通话也会自动结束 注意: ≥v2.3.2 废弃 | @kicked-out="handleKickedOut" | 否 | - |
@status-changed | 组件抛出的事件,当通话状态发生变化时,会触发该事件,通话状态种类详见下方备注 注意: ≥v2.3.2 废弃 | @status-changed="handleStatusChanged" | 否 | - |
videoDisplayMode
有三个值:VideoDisplayMode.CONTAIN
、VideoDisplayMode.COVER
、VideoDisplayMode.FILL
,默认值是 VideoDisplayMode.COVER
。VideoDisplayMode.CONTAIN
优先保证视频内容全部显示。视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。如果视频尺寸与显示视窗尺寸不一致,在保持长宽比的前提下,将视频进行缩放后填满视窗,缩放后的视频四周会有一圈黑边。VideoDisplayMode.COVER
优先保证视窗被填满。视频尺寸等比缩放,直至整个视窗被视频填满。如果视频长宽与显示窗口不同,则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。VideoDisplayMode.FILL
保证视窗被填满的同时保证视频内容全部显示,但是不保证视频尺寸比例不变。视频的宽高会被拉伸至和视窗尺寸一致。videoResolution
有三个值:VideoResolution.RESOLUTION_480P
、VideoResolution.RESOLUTION_720P
、RESOLUTION_1080P.FILL
,默认值是 VideoResolution.RESOLUTION_480P
。视频 Profile | 分辨率(宽 × 高) | 帧率(fps) | 码率(kbps) |
480p | 640 × 480 | 15 | 900 |
720p | 1280 × 720 | 15 | 1500 |
1080p | 1920 × 1080 | 15 | 2000 |
@status-changed
可以抛出通话组件内部的状态,handleStatusChanged({ oldStatus, newStatus })
接收新状态和旧状态,使用方法参照下方示例代码,其中状态有以下几种:import { STATUS } from "@tencentcloud/call-uikit-vue";
常量 | 含义 |
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 | 正在群组视频通话 |
<TUICallKit:allowedMinimized="true":allowedFullScreen="true":videoDisplayMode="VideoDisplayMode.CONTAIN":videoResolution="VideoResolution.RESOLUTION_1080P":beforeCalling="beforeCalling":afterCalling="afterCalling":onMinimized="onMinimized":kickedOut="handleKickedOut":statusChanged="handleStatusChanged"/><TUICallKitMini />import { TUICallKit, TUICallKitMini, TUICallKitServer, VideoDisplayMode, VideoResolution, STATUS } from "@tencentcloud/call-uikit-vue"; // vue2 要换成 '@tencentcloud/call-uikit-vue2'function beforeCalling(type, error) {console.log("通话前 会执行此函数,类型: ", type, error);}function afterCalling() {console.log("通话后 会执行此函数");}function onMinimized(oldStatus, newStatus) {if (newStatus === true) {console.log("TUICallKit 进入最小化状态");} else {console.log("TUICallKit 退出最小化状态");}}function handleKickedOut() {console.error("The user has been kicked out");}function handleStatusChanged(args: { oldStatus: string; newStatus: string; }) {const { oldStatus, newStatus } = args;if (newStatus === STATUS.CALLING_C2C_VIDEO) {console.log(`[Call Demo] 正在进行 1v1 视频通话,状态变更 ${oldStatus} -> ${newStatus}`);}}
TUICallKitServer
import { TUICallKitServer } from "@tencentcloud/call-uikit-vue";
import { TUICallKitServer } from "@tencentcloud/call-uikit-vue2";
try {await TUICallKitServer.init({ SDKAppID, userID, userSig });// await TUICallKitServer.init({ tim, SDKAppID, userID, userSig}); // 如果工程中已有 tim 实例,需在此处传入alert("初始化完成");} catch (error: any) {alert(`初始化失败,原因:${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 }); // 1v1 通话} catch (error: any) {alert(`拨打失败,原因:${error}`);}
参数 | 类型 | 是否必填 | 含义 |
userID | String | 是 | 目标用户的 userId |
type | Number | 是 | 通话的媒体类型,语音通话(type = 1)、视频通话(type = 2) |
timeout | Number | 否 | 通话的超时时间,0 为不超时, 单位 s(秒)(选填) - 默认 30s |
Object | 否 | 自定义离线消息推送(选填)-- 需 tsignaling 版本 >= 0.8.0 |
参数 | 类型 | 是否必填 | 含义 |
offlinePushInfo.title | String | 否 | 离线推送标题(选填) |
offlinePushInfo.description | String | 否 | 离线推送内容(选填) |
offlinePushInfo.androidOPPOChannelID | String | 否 | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID(选填) |
offlinePushInfo.extension | String | 否 | 离线推送透传内容(选填)(tsignaling 版本 >= 0.9.0) |
try {await TUICallKitServer.groupCall({ userIDList: ['jack', 'tom'], groupID: "xxx", type: TUICallType.VIDEO_CALL }); // 群组通话} catch (error: any) {alert(`拨打失败,原因:${error}`);}
参数 | 类型 | 是否必填 | 含义 |
userIDList | Array<String> | 是 | 邀请列表成员列表 |
type | Number | 是 | 通话的媒体类型,语音通话(type = 1)、视频通话(type = 2) |
groupID | String | 是 | 呼叫群组ID |
timeout | Number | 否 | 通话的超时时间,0 为不超时, 单位 s(秒)(选填) - 默认 30s |
offlinePushInfo | Object | 否 | 自定义离线消息推送(选填)-- 需 tsignaling 版本 >= 0.8.0 |
offlinePushInfo
,与 call
接口中一致。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(`更新用户名昵称头像失败,原因:${error}`);}
参数 | 类型 | 是否必填 | 含义 |
nickName | String | 是 | 用户昵称 |
avatar | String | 是 | 用户头像地址 |
try {await TUICallKitServer.setCallingBell(filePath?: string)} catch (error: any) {alert(`修改铃声失败,原因:${error}`);}
tim.logout();
。try {await TUICallKitServer.destroyed();} catch (error: any) {alert(`销毁实例失败,原因:${error}`);}
本页内容是否解决了您的问题?