智密腾讯云直播组建--直播间API对象--ZhimiTRTCLiveRoom

函数名	描述
register	注册SDK
isLogined	是否登录SDK
addEventListener	添加事件监听
removeEventListener	移除事件监听
inRoomHook	判断是否已经进入房间
getUserId	获取当前用户UserId
getRoomId	获取当前房间Id
getSDKConfig	获取SDK配置
login	登录SDK
loginWithoutIM	登录SDK（但不登录腾讯云IM）
logout	退出SDK
setProfile	设置用户信息
setLoggerEnable	设置调试输出
createRoom	创建直播间
joinRoom	加入房间
leaveRoom	离开房间
sendRoomTextMsg	发送房间文本消息
sendRoomCustomMsg	发送房间自定义消息
getUserInfo	获取用户信息
checkPermission	获取权限
startPreview	开始预览本地画面
stopPreview	停止预览本地画面
startPublish	开始推流
stopPublish	停止推流
getRoomVideoUrl	获取直播间拉流连接
startPlayRoomTRTC	开始播放直播间 TRTC 流
stopPlayRoomTRTC	停止播放直播间 TRTC 流
startPlayJoinAnchorTRTC	开始播放直播间连麦 TRTC 流
stopPlayJoinAnchorTRTC	停止播放连麦 TRTC 流
setMuted	设置本地麦克风静音
getMuted	获取本地麦克风静音状态
switchCamera	切换摄像头
getRoomOnlines	获取房间在线人数
getRoomUsers	获取房间在线人员列表
kickout	踢人
sendGift	发送礼物
muteUser	禁言观众
unmuteUser	取消禁言观众
requestJoinAnchor	请求连麦

---

register - 注册SDK

该函数注册SDK与全局监听器，该函数请在App.vue的onLaunch生命周期中调用，确保每次应用生命周期有且仅有调用一次。

调用例子

import { ZhimiTRTCLiveRoom } from '@/utils/ZhimiTRTCLiveRoom'

export default {
  onLaunch: function() {
    ZhimiTRTCLiveRoom.register()
  },
}

---

isLogined - 是否登录SDK

该函数用于判断是否登录SDK。请注意，该函数仅判断是否登录过SDK，对于腾讯云IM是否登录没有实质性作用，仅用于判断是否login过。

调用例子

import { ZhimiTRTCLiveRoom } from '@/utils/ZhimiTRTCLiveRoom'

const isLogined = ZhimiTRTCLiveRoom.isLogined()
if (isLogined) {
  console.log('已经登录SDK')
} else {
  console.log('未登录SDK')
}

---

addEventListener - 添加事件监听

该函数用于监听SDK事件。请注意，该函数会直接监听来自腾讯云IM与腾讯云TRTC的底层事件并且给予反馈，开发者需要根据腾讯云官方文档进行事件处理。

注意：一般不建议开发者自行监听，容易造成内存溢出与数据处理问题，可以参考二次封装的事件模型

函数定义

addEventListener(listener)

参数	描述
listener	回调函数，腾讯云IM与腾讯云TRTC的底层事件会直接反馈给该回调函数

调用例子

import { ZhimiTRTCLiveRoom } from '@/utils/ZhimiTRTCLiveRoom'

ZhimiTRTCLiveRoom.addEventListener(({type, data}) => {
  // type => 事件名
  // data => 回调数据
  console.log('收到数据', type, data)
})

---

removeEventListener - 移除事件监听

该函数用于移除已经添加的事件监听

函数定义
 

removeEventListener(listener)

参数	描述
listener	回调函数，传入addEventListener的时候对应的函数

调用例子

import { ZhimiTRTCLiveRoom } from '@/utils/ZhimiTRTCLiveRoom'

const callback = ({type, data}) => {
  // type => 事件名
  // data => 回调数据
  console.log('收到数据', type, data)
}

// 添加事件监听
ZhimiTRTCLiveRoom.addEventListener(callback)
// 移除事件监听
ZhimiTRTCLiveRoom.removeEventListener(callback)

---

inRoomHook - 判断是否已经进入房间

该函数用于判断是否已经进入了房间，如果已经进入房间则会返回房间的Id，否则抛出异常，请开发者调用的时候自行try catch处理异常

调用例子

import { ZhimiTRTCLiveRoom } from '@/utils/ZhimiTRTCLiveRoom'

try {
  const roomI