云席功能

功能概述

本模块用于云席功能相关逻辑,如展示在云席列表,关注用户,新人入座等

初始化及销毁

在实例化该模块并进行使用之前,需要对SDK进行初始化配置,详细见参考文档

在线文件引入方式

// script 标签引入,根据版本号引入JS版本。
<script src="https://websdk.videocc.net/interactions-receive-sdk/0.24.0/lib/polyv-ir.umd.js"></script>

<script>
    const { SeatTable } = window.PolyvIRSDK;
</script>

import 方式引入(推荐)

import { SeatTable } from '@polyv/interactions-receive-sdk';

const seatTableSdk = new SeatTable();
// 销毁 SDK 实例,清除逻辑
seatTableSdk.destroy();

使用流程

监听 "入座" 事件

在观众入座后,announcementSdk.events.ADD_SEATING 事件会被触发,事件参数中包含用户信息,接入方可以监听此事件并根据内容进行展示。

announcementSdk.on(announcementSdk.events.ADD_SEATING, function(msg) {
  console.log(`入座信息:` + msg);
});

监听 “更新嘉宾信息” 事件

后台主动推送嘉宾信息,announcementSdk.events.UPDATE_SETTING 事件会被触发,接入方可以据此移除公告显示。

announcementSdk.on(announcementSdk.events.UPDATE_SETTING, function(msg) {
  console.log('嘉宾列表信息:' + msg.list);
});

注意

如果不需要再使用云席SDK时,请调用SDK实例的destroy方法去销毁实例。

Last updated