保利威文档中心

帮助中心

互动接收模块

更新时间:2026-06-17 16:58:37

互动接收模块主要用于接收和处理直播间的各种互动功能,包括签到、卡片推送、条件抽奖、商品库等模块。

一、互动配置

1.1 获取互动设置信息

用于获取管理后台设置的互动功能信息。

Api 方法: getInteractSetting(): InteractSetting

返回值说明: InteractSetting 类型,详细类型说明如下

属性名 说明 类型
productEnabled 商品库开关 boolean
productTrackEnabled 商品库数据上报开关 boolean
productLinkJumpTipEnabled 商品库链接跳转提示开关 boolean
productHotEffectEnabled 商品热卖特效开关 boolean
productHotEffectTips 商品热卖特效提示 ProductHotEffectTips

示例:

const settingInfo = watchCore.interactReceive.getInteractSetting();
console.log('商品库开关', settingInfo.productEnabled);

1.2 获取挂件列表

说明: 获取直播间的挂件列表,包括福利抽奖等挂件

Api 方法: getPendantList(): Promise<InteractPendantItem[]>

返回值说明: 挂件列表数据,Promise<InteractPendantItem[]> 类型

示例:

const pendantList = await watchCore.interactReceive.getPendantList();
console.log('挂件列表', pendantList);

二、事件说明

2.1 商品库点击事件

说明: 观众点击商品后触发该事件。

Event 事件: InteractReceiveEvents.ProductClick

回调参数: Object 对象,详细类型说明如下

属性名 说明 类型
nickname 用户昵称 string
name 商品名称 string
type 商品类型 'delivery'

示例:

watchCore.interactReceive.eventEmitter.on(InteractReceiveEvents.ProductClick, (data) => {
  toast.info(`${data.nickname}点击了${data.name}`);
});

2.2 商品库开关修改事件

说明: 管理后台的商品库开关更改后触发该事件。

Event 事件: InteractReceiveEvents.ProductEnabledChange

回调参数: Object 对象,详细类型说明如下

属性名 说明 类型
productEnabled 商品库开关 boolean

示例:

watchCore.interactReceive.eventEmitter.on(InteractReceiveEvents.ProductEnabledChange, (data) => {
  if (data.productEnabled) {
    console.log('商品库打开,显示商品库');
  } else {
    console.log('商品库关闭,隐藏商品库');
  }
});

三、模块列表

模块名称 功能描述
签到 处理直播间的签到功能,包括获取签到信息、执行签到操作等
卡片推送 接收和处理直播间的卡片推送功能,包括获取卡片信息、记录领取状态等
条件抽奖 提供直播间抽奖相关功能,包括初始化抽奖、获取抽奖信息、参与抽奖等
商品库 提供直播间商品展示和交互功能,包括获取商品列表、商品标签等
联系客服,在线咨询