产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
<ConferenceMainView />: TUIRoomkit UI 组件主体。ConferenceMainView 提供的 API。API | 描述 |
获取 roomEngine 实例。如果 roomEngine 不存在，则返回 null。 | |
监听指定类型的事件。当事件发生时，将调用回调函数。 | |
取消监听指定类型的事件。 | |
登录会议系统。 | |
登出会议系统。 | |
开始一个新的会议。 | |
加入一个已经存在的会议。 | |
离开当前会议。 | |
解散当前会议。 | |
设置自己的用户信息。 | |
设置界面语言。 | |
设置界面主题。 | |
禁用应用程序中的文本消息功能。调用此函数后，用户将无法发送或接收文本消息。 | |
禁用应用程序中的屏幕共享功能。调用此函数后，用户将无法与他人共享屏幕。 | |
属性 | 描述 | 类型 | 是否必填 | 默认值 |
displayMode | 组件显示模式控制： permanent：常驻模式。组件始终显示，内部不控制组件的显示与隐藏，若业务端不进行控制，则组件一直保持显示状态。 wake-up：唤醒模式。组件需通过调用 conference start/join接口并正式加入会议后才被激活，之前不会显示。 | 'permanent' | 'wake-up' | 否 | permanent |
<template><ConferenceMainView display-mode="permanent"></ConferenceMainView></template><script setup>import { ConferenceMainView, conference } from '@tencentcloud/roomkit-electron-vue3';const init = async () => {await conference.login({// 获取 sdkAppId 可参考文档开通服务部分，https://write.woa.com/document/139678220708134912#d9d2b8d1-f19f-441b-a436-457748c94997sdkAppId: 0,// 用户在您业务中的唯一标示 IduserId: '',// 本地开发调试可在 https://console.tencentcloud.com/trtc/usersigtool 页面快速生成 userSig, 注意 userSig 与 userId 为一一对应关系userSig: '',});await conference.start('123456', {isSeatEnable: false,isOpenCamera: true,isOpenMicrophone: true,});}init();</script>
<template><ConferenceMainView display-mode="permanent"></ConferenceMainView></template><script>import { ConferenceMainView, conference } from '@tencentcloud/roomkit-electron-vue2.7';export default {components: {ConferenceMainView,},async created() {await conference.login({// 获取 sdkAppId 可参考文档开通服务部分，https://write.woa.com/document/139678220708134912#d9d2b8d1-f19f-441b-a436-457748c94997sdkAppId: 0,// 用户在您业务中的唯一标示 IduserId: '',// 本地开发调试可在 https://console.tencentcloud.com/trtc/usersigtool 页面快速生成 userSig, 注意 userSig 与 userId 为一一对应关系userSig: '',});await conference.start('123456', {isSeatEnable: false,isOpenCamera: true,isOpenMicrophone: true,});},};</script>
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference, TUIRoomEngine } from '@tencentcloud/roomkit-electron-vue3';TUIRoomEngine.once('ready', () => {const roomEngine = conference.getRoomEngine();});
参数 | 类型 | 默认值 | 含义 |
eventType | - | 要监听的事件类型 | |
callback | () => void | - | 事件发生时调用的回调函数 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference, RoomEvent } from '@tencentcloud/roomkit-electron-vue3';conference.on(RoomEvent.RoomStart, () => {console.log('[conference] The meeting has already started.')});conference.on(RoomEvent.ROOM_DISMISS, () => {console.log('[conference] The meeting has been dismissed')});
参数 | 类型 | 默认值 | 含义 |
eventType | - | 要取消监听的事件类型 | |
callback | () => void | - | 之前添加的回调函数 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.off('event', callback);
参数 | 类型 | 默认值 | 含义 |
params | {sdkAppId: number; userId: string; userSig: string; tim?: ChatSDK} | - | 登录参数对象 |
sdkAppId | number | - | |
userId | string | - | 用户ID建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。 |
userSig | string | - | |
tim | ChatSDK (可选) | - |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.login({sdkAppId: 123456,userId: 'testUser',userSig: 'testSig'});
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.logout();
参数 | 类型 | 默认值 | 含义 |
roomId | string | - | 会议房间 ID |
params | - | 开始会议的参数 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.start('123456', {roomName: 'TestRoom',isSeatEnabled: false,isOpenCamera: false,isOpenMicrophone: false,});
参数 | 类型 | 默认值 | 含义 |
roomId | string | - | 会议房间 ID |
params | - | 加入会议的参数 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.join('123456', {isOpenCamera: false,isOpenMicrophone: false,});
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.leave();
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.dismiss();
参数 | 类型 | 默认值 | 含义 |
options | {userName: string; avatarUrl: string} | - | 用户信息对象 |
userName | string（可选） | - | 用户昵称 |
avatarUrl | string（可选） | - | 用户头像 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.setSelfInfo({userName: 'test-name',avatarUlr: 'https://avatar.png'});
参数 | 类型 | 默认值 | 含义 |
language | 'zh-CN' | 'en-US' | - | 语言类型 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.setLanguage('en-US');
参数 | 类型 | 默认值 | 含义 |
theme | 'LIGHT' | 'DARK' | - | 主题类型 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.setTheme('DARK');
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.enableWatermark();
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.disableTextMessaging();
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.disableScreenSharing();
参数 | 类型 | 默认值 | 含义 |
name | - | 需要隐藏的按钮名称 |
// 注意包的名称，如果您使用 vue2 版本请更改包名为 @tencentcloud/roomkit-electron-vue2.7import { conference, FeatureButton } from '@tencentcloud/roomkit-electron-vue3';conference.hideFeatureButton(FeatureButton.SwitchTheme);
参数 | 类型 | 描述 |
ROOM_START | string | 创建会议 |
ROOM_JOIN | string | 加入会议 |
ROOM_LEAVE | string | 离开会议 |
ROOM_DISMISS | string | 会议解散 |
KICKED_OFFLINE | string | 用户被踢下线 |
KICKED_OUT | string | 用户被踢出会议 |
USER_LOGOUT | string | 用户登出 |
ROOM_ERROR | string | 会议错误 |
ROOM_NEED_PASSWORD | string | 入会密码 |
参数 | 类型 | 描述 |
SwitchTheme | string | 切换主题功能按钮 |
SwitchLayout | string | 切换布局功能按钮 |
SwitchLanguage | string | 切换语言功能按钮 |
FullScreen | string | 全屏功能按钮 |
Invitation | string | 邀请功能按钮 |
BasicBeauty | string | 基础美颜功能按钮 |
参数 | 类型 | 描述 | 默认值 |
roomName | string（可选） | 房间名称 | - |
isSeatEnabled | boolean（可选） | 是否启用席位 | false |
isOpenCamera | boolean（可选） | 是否开启摄像头 | false |
isOpenMicrophone | boolean（可选） | 是否开启麦克风 | false |
defaultCameraId | string（可选） | 默认摄像头ID | - |
defaultMicrophoneId | string（可选） | 默认麦克风ID | - |
defaultSpeakerId | string（可选） | 默认扬声器ID | - |
password | string（可选） | 入会密码 | - |
参数 | 类型 | 描述 | 默认值 |
isOpenCamera | boolean（可选） | 是否开启摄像头 | false |
isOpenMicrophone | boolean（可选） | 是否开启麦克风 | false |
defaultCameraId | string（可选） | 默认摄像头ID | - |
defaultMicrophoneId | string（可选） | 默认麦克风ID | - |
defaultSpeakerId | string（可选） | 默认扬声器ID | - |
password | string（可选） | 入会密码 | - |
文档反馈