<LiveMainView />:
TUILiveKit UI 组件主体。LiveMainView
提供的 API。API | 描述 |
获取 roomEngine 实例。如果 roomEngine 不存在,则返回 null。 | |
监听指定类型的事件。当事件发生时,将调用回调函数。 | |
取消监听指定类型的事件。 | |
登录直播系统。 | |
登出直播系统。 | |
开始一个新的直播。 | |
加入一个已经存在的直播。 | |
离开当前直播。 | |
解散当前直播。 | |
设置自己的用户信息。 | |
设置界面语言。 | |
设置界面主题。 |
import { liveRoom, TUIRoomEngine } from '@tencentcloud/livekit-web-vue3';TUIRoomEngine.once('ready', () => {const roomEngine = liveRoom.getRoomEngine();});
参数 | 类型 | 默认值 | 含义 |
eventType | - | 要监听的事件类型 | |
callback | () => void | - | 事件发生时调用的回调函数 |
import { liveRoom, RoomEvent } from '@tencentcloud/livekit-web-vue3';liveRoom.on(RoomEvent.RoomStart, () => {console.log('[liveRoom] The live has already started.')});liveRoom.on(RoomEvent.ROOM_DISMISS, () => {console.log('[liveRoom] The live has been dismissed')});
参数 | 类型 | 默认值 | 含义 |
eventType | - | 要取消监听的事件类型 | |
callback | () => void | - | 之前添加的回调函数 |
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.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 | - | userSig 签名 |
tim | ChatSDK (可选) | - |
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.login({sdkAppId: 123456,userId: 'testUser',userSig: 'testSig'});
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.logout();
参数 | 类型 | 默认值 | 含义 |
roomId | string | - | 直播房间 ID |
params | - | 开始直播的参数 |
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.start('123456', {roomName: 'TestRoom',isOpenCamera: false,isOpenMicrophone: false,});
参数 | 类型 | 默认值 | 含义 |
roomId | string | - | 直播房间 ID |
params | - | 加入直播的参数 |
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.join('123456', {isOpenCamera: false,isOpenMicrophone: false,});
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.leave();
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.dismiss();
参数 | 类型 | 默认值 | 含义 |
options | {userName: string; avatarUrl: string} | - | 用户信息对象 |
userName | string(可选) | - | 用户昵称 |
avatarUrl | string(可选) | - | 用户头像 |
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.setSelfInfo({userName: 'test-name',avatarUlr: 'https://avatar.png'});
参数 | 类型 | 默认值 | 含义 |
language | 'zh-CN' | 'en-US' | - | 语言类型 |
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.setLanguage('en-US');
参数 | 类型 | 默认值 | 含义 |
theme | 'LIGHT' | 'DARK' | - | 主题类型 |
import { liveRoom } from '@tencentcloud/livekit-web-vue3';liveRoom.setTheme('DARK');
参数 | 类型 | 描述 |
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 | 切换主题功能按钮 |
SwitchLanguage | string | 切换语言功能按钮 |
参数 | 类型 | 描述 | 默认值 |
roomName | string(可选) | 直播间名称 | - |
isOpenCamera | boolean(可选) | 是否开启摄像头 | false |
isOpenMicrophone | boolean(可选) | 是否开启麦克风 | false |
defaultCameraId | string(可选) | 默认摄像头ID | - |
defaultMicrophoneId | string(可选) | 默认麦克风ID | - |
defaultSpeakerId | string(可选) | 默认扬声器ID | - |
参数 | 类型 | 描述 | 默认值 |
isOpenCamera | boolean(可选) | 是否开启摄像头 | false |
isOpenMicrophone | boolean(可选) | 是否开启麦克风 | false |
defaultCameraId | string(可选) | 默认摄像头ID | - |
defaultMicrophoneId | string(可选) | 默认麦克风ID | - |
defaultSpeakerId | string(可选) | 默认扬声器ID | - |
本页内容是否解决了您的问题?