<ConferenceMainView />:
The component body of TUIRoomkit UI.ConferenceMainView
provided API.API | Description |
Access the roomEngine instance. If roomEngine does not exist, it will return null. | |
Listen to specified types of apid Integration with TUIRoomKit
.Event. When the event occurs, the callback function will be called. | |
Cancel listening for events of a specified type. | |
Log in to the conference system. | |
Log out of the meeting system. | |
Start a new meeting. | |
Join an existing meeting. | |
Leave the current meeting. | |
Dismiss the current meeting. | |
Set your user information. | |
Set the interface language. | |
Set the interface topic. | |
Disable the screen sharing feature in the application. After invoking this function, users will not be able to share their screen with others. | |
Disable the text messaging feature in the application. After invoking this function, users will not be able to send or receive text messages. | |
Hide specific feature buttons in the application. By invoking this function and passing in the appropriate FeatureButton enumerated values, the corresponding buttons will be hidden from the user interface. |
Attribute | Description | Type | Required | Default Value |
displayMode | Control of component display pattern: permanent: Permanent mode. The component is always displayed; internal control of the component's visibility is not exerted. If not controlled by the business end, the component will always remain visible. wake-up: Wake-up mode. The component is activated only after calling the conference start/join interface and officially joining the conference; it will not be displayed beforehand. | 'permanent' | 'wake-up' | No | 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: 0,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: 0,userId: '',userSig: '',});await conference.start('123456', {isSeatEnable: false,isOpenCamera: true,isOpenMicrophone: true,});},};</script>
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference, TUIRoomEngine } from '@tencentcloud/roomkit-electron-vue3';TUIRoomEngine.once('ready', () => {const roomEngine = conference.getRoomEngine();});
Parameter | Type | Default Value | Meaning |
eventType | - | Event Type to Listen For | |
callback | () => void | - | Callback Function Called When the Event Occurs |
// Note the package name. If you are using the vue2 version, please change the package name to @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')});
Parameter | Type | Default Value | Meaning |
eventType | - | The type of event to cancel listening for | |
callback | () => void | - | The callback function added previously |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.off('event', callback);
Parameter | Type | Default Value | Meaning |
params | {sdkAppId: number; userId: string; userSig: string; tim?: ChatSDK} | - | Log in to the parameter object |
sdkAppId | number | - | In the Real-time Audio and Video Console click Application Management > create an application. After creating a new application, you can access the sdkAppId information in Application Information. |
userId | string | - | It's advised to limit the User ID length to 32 bytes, allowing only uppercase and lowercase letters (a-zA-Z), digits (0-9), underscores, and hyphens. |
userSig | string | - | |
tim | ChatSDK (optional) | - | If you want to leverage more capabilities of the Instant Messaging SDK while integrating roomEngine, you can pass the created tim instance into TUIRoomEngine. For how to create a tim instance, please refer to TIM.create. |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.login({sdkAppId: 123456,userId: 'testUser',userSig: 'testSig'});
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.logout();
Parameter | Type | Default Value | Meaning |
roomId | string | - | Meeting Room ID |
params | - | Parameters for starting a meeting |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.start('123456', {roomName: 'TestRoom',isSeatEnabled: false,isOpenCamera: false,isOpenMicrophone: false,});
Parameter | Type | Default Value | Meaning |
roomId | string | - | Meeting Room ID |
params | - | Parameters for joining the meeting |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.join('123456', {isOpenCamera: false,isOpenMicrophone: false,});
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.leave();
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.dismiss();
Parameter | Type | Default Value | Meaning |
options | {userName: string; avatarUrl: string} | - | User information object |
userName | string (Optional) | - | User's nickname |
avatarUrl | string (Optional) | - | User profile photo |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.setSelfInfo({userName: 'test-name',avatarUlr: 'https://avatar.png'});
Parameter | Type | Default Value | Meaning |
language | 'zh-CN' | 'en-US' | - | Language |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.setLanguage('en-US');
Parameter | Type | Default Value | Meaning |
theme | 'LIGHT' | 'DARK' | - | Topic Type |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.setTheme('DARK');
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.enableWatermark();
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.disableTextMessaging();
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference } from '@tencentcloud/roomkit-electron-vue3';conference.disableScreenSharing();
Parameter | Type | Default Value | Meaning |
name | - | Names of Buttons to be Hidden |
// Note the package name. If you are using the vue2 version, please change the package name to @tencentcloud/roomkit-electron-vue2.7import { conference, FeatureButton } from '@tencentcloud/roomkit-electron-vue3';conference.hideFeatureButton(FeatureButton.SwitchTheme);
Parameter | Type | Description |
ROOM_START | string | Creating a Meeting |
ROOM_JOIN | string | Joining a Meeting |
ROOM_LEAVE | string | Leave Meeting |
ROOM_DISMISS | string | Meeting Dismissed |
KICKED_OFFLINE | string | User kicked offline |
KICKED_OUT | string | Participant removed from meeting |
USER_LOGOUT | string | User logged out |
ROOM_ERROR | string | Meeting error |
ROOM_NEED_PASSWORD | string | Meeting password |
Parameter | Type | Description |
SwitchTheme | string | Switch Topic Feature Button |
SwitchLayout | string | Switch Layout Feature Button |
SwitchLanguage | string | Switch Language Feature Button |
FullScreen | string | Fullscreen Feature Button |
Invitation | string | Invite Feature Button |
BasicBeauty | string | Basic Beauty Button |
Parameter | Type | Description | Default Value |
roomName | string (Optional) | Room Name | - |
isSeatEnabled | boolean (optional) | Enable Seats | false |
isOpenCamera | boolean (optional) | Whether to enable the camera | false |
isOpenMicrophone | boolean (optional) | Whether to enable the microphone | false |
defaultCameraId | string (Optional) | Default Camera ID | - |
defaultMicrophoneId | string (Optional) | Default Microphone ID | - |
defaultSpeakerId | string (Optional) | Default Speaker ID | - |
password | string (Optional) | Meeting password | - |
Parameter | Type | Description | Default Value |
isOpenCamera | boolean (optional) | Whether to enable the camera | false |
isOpenMicrophone | boolean (optional) | Whether to enable the microphone | false |
defaultCameraId | string (Optional) | Default Camera ID | - |
defaultMicrophoneId | string (Optional) | Default Microphone ID | - |
defaultSpeakerId | string (Optional) | Default Speaker ID | - |
password | string (Optional) | Meeting password | - |
Was this page helpful?