Pj-trtc-web NPM

bash npm install pj-trtc-web

使用示例

<template>
<PjTrtcWeb
ref="trtcRef"
:params="trtcParams"
:autoEnterRoom="false"
@roomEvent="handleRoomEvent"
@error="handleError"
/>
</template>
<script setup lang="ts">
import { ref } from 'vue'
import { PjTrtcWeb } from 'pj-trtc-web'
import type { RoomEvents } from 'pj-trtc-web'
const trtcRef = ref(null)
// TRTC 参数配置
const trtcParams = {
sdkAppId: 'your-sdkAppId', // 腾讯云 SDKAppId
roomId: 'room-id', // 房间号
userId: 'user-id', // 用户ID
userSig: 'user-sig', // 用户签名
privateMapKey: '' // 权限密钥（可选）
}
// 处理房间事件
const handleRoomEvent = (event: RoomEvents, ...args: any[]) => {
switch(event) {
case RoomEvents.EnterRoom:
console.log('进入房间成功')
break
case RoomEvents.ExitRoom:
console.log('退出房间成功')
break
// ... 处理其他事件
}
}
// 处理错误
const handleError = (error: Error) => {
console.error('TRTC错误:', error)
}
// 手动进入房间
const enterRoom = () => {
trtcRef.value.start()
}
// 手动退出房间
const exitRoom = () => {
trtcRef.value.exit()
}
</script>

Props

属性名	类型	必填	默认值	说明
params	Object	否	null	TRTC 参数配置对象
autoEnterRoom	Boolean	否	false	是否自动进入房间

params 对象属性

属性名	类型	必填	说明
sdkAppId	string/number	是	腾讯云 SDKAppId
roomId	string/number	是	房间号
userId	string	是	用户ID
userSig	string	是	用户签名
privateMapKey	string	否	权限密钥

事件

事件名	参数	说明
roomEvent	event: RoomEvents, ...args	房间相关事件
error	error: Error	错误事件

RoomEvents 事件类型

EnterRoom: 进入房间成功
ExitRoom: 退出房间成功
KickedOut: 被踢出房间
RemoteUserEnter: 远端用户进入房间
RemoteUserExit: 远端用户退出房间
RemoteVideoAvailable: 远端视频可用
RemoteVideoUnavailable: 远端视频不可用
RemoteAudioAvailable: 远端音频可用
RemoteAudioUnavailable: 远端音频不可用
ScreenShareStopped: 屏幕分享停止

方法

方法名	参数	返回值	说明
start	params?: TRTCParams	void	进入房间。可选参数，如果不传则使用 props 中的 params
exit	-	void	退出房间
setVideoDisplayName	userId: string, displayName: string	void	设置远端用户视频显示名称
getCameraList	-	Promise<DeviceInfo[]>	获取摄像头列表
getMicrophoneList	-	Promise<DeviceInfo[]>	获取麦克风列表
switchCamera	deviceId: string	void	切换摄像头
switchMicrophone	deviceId: string	void	切换麦克风