话题PK

功能概述

本模块用于接收处理话题PK相关的逻辑

初始化及销毁

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

在线文件引入方式

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

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

import 方式引入(推荐)

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

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

使用流程

监听 "话题开始" 事件

在保利威后台开始话题后,topicSdk.events.TOPIC_START 事件会被触发,事件参数中包含话题PK的id及内容,接入方可以监听此事件并根据内容进行展示。

topicSdk.on(topicSdk.events.TOPIC_START, function(msg) {
  console.log('话题开始:', msg);
});

监听 "话题结束" 事件

在保利威后台点击结束话题,topicSdk.events.TOPIC_OVER 事件会被触发,根据展示话题结束内容。

topicSdk.on(topicSdk.events.TOPIC_OVER, function(msg) {
  console.log('话题结束:', msg);
});

监听 "话题统计" 事件

在其他观众选择正反方观点后,topicSdk.events.TOPIC_UPDATE_DATA 事件会被触发,事件参数中包含正反方的统计人数。

topicSdk.on(topicSdk.events.TOPIC_UPDATE_DATA, function(data) {
  console.log('话题统计:', data);
});

监听 “话题删除” 事件

在保利威后台点击删除话题,topicSdk.events.TOPIC_DELETE 事件会被触发,接入方可以id判断当前展示的话题是否被删除。

topicSdk.on(topicSdk.events.TOPIC_DELETE, function(msg) {
  console.log('话题删除:', msg);
});

监听 “话题挂件入口是否隐藏” 事件

在保利威后台点击话题开关,topicSdk.events.TOPIC_CHANGE_ENTRANCE 事件会被触发,接入方可以判断当前挂件入口是否隐藏。

topicSdk.on(topicSdk.events.TOPIC_CHANGE_ENTRANCE, function(msg) {
    // 挂件入口
    // this.entranceVisible = msg.entranceEnable;
    console.log('挂件入口状态:', msg);
});

注意

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

Last updated