## SDKPlayerEventsOnExternal 类型：`interface` 播放器相关监听事件。 ### player.play 播放事件。 **类型** ```ts () => void ``` ### player.playing （暂停、卡顿后）恢复播放事件。 **类型** ```ts () => void ``` ### player.pause 暂停播放事件。 **类型** ```ts () => void ``` ### player.ended 结束播放事件。 **类型** ```ts () => void ``` ### player.destroy 销毁播放器事件。 **类型** ```ts () => void ``` ### player.ratechange 播放速率变化事件。 **类型** ```ts (rate: number) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"rate","Type":"number","Required":"是","Default":"无","Description":"

播放速率。取值如下：

0.5：0.5 倍速。

0.75：0.75 倍速。

1：1 倍速。

1.25：1.25 倍速。

1.5：1.5 倍速。

2：2 倍速。

\n\n","children":[],"key":"rate"}] return (); ``` ### player.fullscreen_change 全屏模式变化事件。 **类型** ```ts (isFullScreen: boolean) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"isFullScreen","Type":"boolean","Required":"是","Default":"无","Description":"

是否切换到全屏模式。取值如下：

true：切换到全屏模式。

false：切换到非全屏模式。

\n\n","children":[],"key":"isFullScreen"}] return (

); ``` ### player.pip_change PC 端小窗模式变化事件。 **类型** ```ts (isPip: boolean) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"isPip","Type":"boolean","Required":"是","Default":"无","Description":"

是否切换到小窗模式。取值如下：

true：切换到小窗模式。

false：从小窗模式切换回原始播放画面。

\n\n","children":[],"key":"isPip"}] return (

); ``` ### player.waiting 等待加载数据事件。 **类型** ```ts () => void ``` ### player.status 直播状态变更事件。 **类型** ```ts (status: string) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"status","Type":"string","Required":"是","Default":"无","Description":"

直播状态。取值如下：

直播中。

预告。

回放。

结束。

\n\n","children":[],"key":"status"}] return (

); ``` ### player.vodConfigChange 点播视频（预告和回放）断点续播事件。点播视频播放过程中该事件的触发时机如下： - PC 端：页面关闭时，SDK 触发该事件。 - 移动端：WebView 的 `pagehide` 事件触发时或用户手动拖动进度条时，SDK 触发该事件。 **类型** ```ts (VodInfo: { vid: string; currentTime: number; duration: number;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"VodInfo","Type":"-","Required":"是","Default":"-","Description":"

点播视频相关信息。

\n","children":[{"Name":"vid","Type":"string","Required":"是","Default":"无","Description":"

视频 ID，视频的唯一标识。

\n","children":[],"key":"VodInfo-vid"},{"Name":"currentTime","Type":"number","Required":"是","Default":"无","Description":"

当前播放位置。单位为秒。

\n","children":[],"key":"VodInfo-currentTime"},{"Name":"duration","Type":"number","Required":"是","Default":"无","Description":"

视频总时长。单位为秒。

\n","children":[],"key":"VodInfo-duration"}],"key":"VodInfo"}] return (

); ``` ### lines.number 多线路数量变化事件。 **类型** ```ts (lines: number) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"lines","Type":"number","Required":"是","Default":"无","Description":"

当直播状态为直播中时，表示直播频道数量。
当直播状态为回放时，表示回放视频数量。

\n","children":[],"key":"lines"}] return (

); ``` ## SDKPlayerEventsEmit 类型：`enum` 播放器相关触发事件。 | 属性 | 值 | 说明 | | :-- | :-- | :-- | | play | `'player.play'` | 播放事件。 | | pause | `'player.pause'` | 暂停播放事件。 | | pip | `'player.pip'` | PC 端小窗模式变化事件。可用于实现 PC 端小窗模式，详见[ PC 端小窗模式](https://www.volcengine.com/docs/3019/1205059#%E5%B0%8F%E7%AA%97%E6%A8%A1%E5%BC%8F)。取值如下：\ |||- `true`：切换到小窗模式。 |\ |||- `false`：从小窗模式切换回原始播放画面。 | ## SDKEventsEmit 类型：`enum` 非播放器相关触发事件。 :::tip 仅适用于在观看页展示直播间的场景。 ::: | 属性 | 值 | 说明 | | :-- | :-- | :-- | | comment.send | `'comment.send'` | 发送评论事件。可用于发送评论，例如 `webSDK.emit('comment.send', '企业直播')`。 | | comment.disabled | `'comment.disabled'` | 禁用或取消禁用评论输入框。\ |||- 禁用：`webSDK.emit('comment.disabled', true)` |\ |||- 取消禁用：`webSDK.emit('comment.disabled', false)` |\ |||:::tip |\ |||仅在通过 `disabledCommentConfig` 参数设置是否禁用评论输入框以及禁用后的评论输入框提示文字后，才支持触发该事件。详见[配置参数](https://www.volcengine.com/docs/3019/1185514#baseoptions)。 |\ |||::: | ## SDKEventsExternal 类型：`interface` 非播放器相关监听事件。 :::tip 仅适用于在观看页展示直播间的场景。 ::: ### activity.status 直播状态变更事件。 **类型** ```ts (status: 1 | 2 | 3 | 4) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"status","Type":"1 | 2 | 3 | 4","Required":"是","Default":"无","Description":"

直播状态。取值如下：

1：直播中。

2：预告。

3：回放。

4：结束。

\n\n","children":[],"key":"status"}] return (

); ``` ### comment.focus 聊天互动输入框点击事件。 **类型** ```ts () => void ``` ### comment.send 发送评论事件。 **类型** ```ts (msg: string) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"msg","Type":"string","Required":"是","Default":"无","Description":"

发送的评论内容。

\n","children":[],"key":"msg"}] return (

); ``` ### comment.nickNameClick 评论区昵称点击事件。 **类型** ```ts (data: { Nickname: string; ExternalId: string; isTop: boolean; isPresenter: boolean;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"-","Required":"是","Default":"-","Description":"

评论昵称的相关信息。

\n","children":[{"Name":"Nickname","Type":"string","Required":"是","Default":"无","Description":"

用户昵称。

\n","children":[],"key":"data-Nickname"},{"Name":"ExternalId","Type":"string","Required":"是","Default":"无","Description":"

外部用户 ID。

\n","children":[],"key":"data-ExternalId"},{"Name":"isTop","Type":"boolean","Required":"是","Default":"无","Description":"

评论是否置顶。取值如下：

true：置顶。

false：未置顶。

","children":[],"key":"data-isTop"},{"Name":"isPresenter","Type":"boolean","Required":"是","Default":"无","Description":"

当前用户是否为主持人。取值如下：

true：主持人

false：非主持人。

","children":[],"key":"data-isPresenter"}],"key":"data"}] return (

); ``` ### permission.need 通过该事件判断是否需要弹出自定义登录框。在 `mode` 取值为 `1` 且 `disabledLogin` 取值为 `true` 时，观众在参与评论、互动等需要用户信息的场景下，例如点击评论输入框时会触发该事件。触发该事件后，您需触发自有账号系统的登录流程并通过 [updateMode2Token](1185516#websdkbase-updatemode2token) 方法将 `mode` 取值为 `1` 时的 Token 更新为 `mode` 取值为 `2` 时的 Token。详见[第三方用户态登录](https://www.volcengine.com/docs/3019/1205059#%E7%AC%AC%E4%B8%89%E6%96%B9%E7%94%A8%E6%88%B7%E6%80%81%E7%99%BB%E5%BD%95)。 **类型** ```ts () => void ``` ### reservation.click 立即预约按钮点击事件。 **类型** ```ts () => void ``` ### reservation.attend 成功预约事件。 **类型** ```ts (tel: string) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"tel","Type":"string","Required":"是","Default":"无","Description":"

预约手机号。

\n","children":[],"key":"tel"}] return (

); ``` ### card.configChange 商品卡片配置变化事件。 **类型** ```ts (config: ProductConfig) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"config","Type":"ProductConfig","Required":"是","Default":"无","Description":"

企业直播服务端返回的最新商品卡片配置。

\n","children":[],"key":"config"}] return (

); ``` ### card.Change 商品卡片内容变化事件。当服务端配置的商品卡片列表发生增、删或改动时，SDK 会触发此事件。你可以通过监听此事件，实时同步本地的商品列表数据。 **类型** ```ts (changes: { product: Product; type: 0 | 1 | 2;}[]) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"changes","Type":"-","Required":"是","Default":"-","Description":"

商品卡片变化列表。每一项表示一条商品卡片的变化记录。

\n","children":[{"Name":"product","Type":"Product","Required":"是","Default":"无","Description":"

发生变更的商品卡片信息。

\n","children":[],"key":"changes-product"},{"Name":"type","Type":"0 | 1 | 2","Required":"是","Default":"无","Description":"

商品卡片的变更类型。取值如下：

0：删除该商品卡片。

1：新增该商品卡片。

2：更新该商品卡片。

","children":[],"key":"changes-type"}],"key":"changes"}] return (

); ``` ### orderMsg.update 下单消息（包括查看商品消息和下单购买消息）推送事件。 **类型** ```ts (config: OrderMsgInfo) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"config","Type":"OrderMsgInfo","Required":"是","Default":"无","Description":"

企业直播服务端返回的最新下单消息配置。

\n","children":[],"key":"config"}] return (

); ``` ### card.explainStatusChange 商品卡片讲解状态或浮窗展示状态变化事件。 **类型** ```ts (config: Partial & { displayStatus: boolean;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"config","Type":"-","Required":"是","Default":"-","Description":"

企业直播服务端返回的最新商品卡片配置。

\n","children":[{"Name":"displayStatus","Type":"boolean","Required":"是","Default":"无","Description":"

商品卡片的讲解状态或浮窗展示状态。取值如下：

true：讲解中或浮窗展示中。

false：未讲解或未浮窗展示。

","children":[],"key":"config-displayStatus"}],"key":"config"}] return (

); ``` ### card.click 菜单内的商品卡片点击事件。
您可以将 `disableCardRedirect` 的参数值设为 `true` 并监听该事件，实现商品卡片的自定义跳转逻辑。详见[自定义跳转逻辑](https://www.volcengine.com/docs/3019/1205059#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%B3%E8%BD%AC%E9%80%BB%E8%BE%91)。 **类型** ```ts (card: { text: string; url: string; UAInfos: UAInfos[]; DirectUrls: string[];}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"card","Type":"-","Required":"是","Default":"-","Description":"

商品卡片菜单配置信息。

\n","children":[{"Name":"text","Type":"string","Required":"是","Default":"无","Description":"

商品卡片的标题。

\n","children":[],"key":"card-text"},{"Name":"url","Type":"string","Required":"是","Default":"无","Description":"

商品卡片的跳转链接。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"card-url"},{"Name":"UAInfos","Type":"UAInfos[]","Required":"是","Default":"无","Description":"

商品卡片菜单配置的环境信息。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"card-UAInfos"},{"Name":"DirectUrls","Type":"string[]","Required":"是","Default":"无","Description":"

商品卡片的直达链接。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"card-DirectUrls"}],"key":"card"}] return (

); ``` ### floatingCard.click 浮窗商品卡片点击事件。
您可以将 `disableCardRedirect` 的参数值设为 `true` 并监听该事件，实现商品卡片的自定义跳转逻辑。详见[自定义跳转逻辑](https://www.volcengine.com/docs/3019/1205059#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%B3%E8%BD%AC%E9%80%BB%E8%BE%91)。 **类型** ```ts (card: { text: string; url: string; UAInfos: UAInfos[]; DirectUrls: string[];}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"card","Type":"-","Required":"是","Default":"-","Description":"

商品卡片菜单配置信息。

\n","children":[{"Name":"text","Type":"string","Required":"是","Default":"无","Description":"

商品卡片的标题。

\n","children":[],"key":"card-text"},{"Name":"url","Type":"string","Required":"是","Default":"无","Description":"

商品卡片的跳转链接。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"card-url"},{"Name":"UAInfos","Type":"UAInfos[]","Required":"是","Default":"无","Description":"

商品卡片菜单配置的环境信息。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"card-UAInfos"},{"Name":"DirectUrls","Type":"string[]","Required":"是","Default":"无","Description":"

商品卡片的直达链接。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"card-DirectUrls"}],"key":"card"}] return (

); ``` ### lottery.click 抽奖入口点击事件。 **类型** ```ts (award: { awardId: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

抽奖信息。

\n","children":[{"Name":"awardId","Type":"string","Required":"是","Default":"无","Description":"

抽奖 ID。

\n","children":[],"key":"award-awardId"}],"key":"award"}] return (

); ``` ### lottery.attend 参与抽奖事件。 **类型** ```ts (award: { awardId: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

抽奖信息。

\n","children":[{"Name":"awardId","Type":"string","Required":"是","Default":"无","Description":"

抽奖 ID。

\n","children":[],"key":"award-awardId"}],"key":"award"}] return (

); ``` ### lottery.result 抽奖开奖事件。仅当抽奖开奖时用户在线，才会触发该事件。 **类型** ```ts (award: { awardId: string; ifWin: boolean;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

抽奖开奖信息。

\n","children":[{"Name":"awardId","Type":"string","Required":"是","Default":"无","Description":"

抽奖 ID。

\n","children":[],"key":"award-awardId"},{"Name":"ifWin","Type":"boolean","Required":"是","Default":"无","Description":"

是否中奖。取值如下：

true：中奖。

false：未中奖。

","children":[],"key":"award-ifWin"}],"key":"award"}] return (

); ``` ### lottery.winInfo 提交中奖信息事件。 **类型** ```ts (award: { awardId: string; awardTel: string; awardAddress?: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

提交的中奖信息。

\n","children":[{"Name":"awardId","Type":"string","Required":"是","Default":"无","Description":"

抽奖 ID。

\n","children":[],"key":"award-awardId"},{"Name":"awardTel","Type":"string","Required":"是","Default":"无","Description":"

观众输入的手机号。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"award-awardTel"},{"Name":"awardAddress","Type":"string | undefined","Required":"否","Default":"无","Description":"

观众输入的收货地址。该参数是否有值取决于您在控制台或服务端 OpenAPI（如支持）的配置。

\n","children":[],"key":"award-awardAddress"}],"key":"award"}] return (

); ``` ### lotteryTicket.click 领取奖券奖品点击事件。您可以将 `disableLotteryTicketRedirect` 的参数值设为 `true` 并监听该事件，实现奖券奖品领取链接的自定义跳转逻辑。详见[自定义跳转逻辑](https://www.volcengine.com/docs/3019/1205059#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%B3%E8%BD%AC%E9%80%BB%E8%BE%91)。 **类型** ```ts (award: { url: string; ActivityId: string; TaskAwardId: string; TaskAwardItemId: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

奖券奖品相关信息。

\n","children":[{"Name":"url","Type":"string","Required":"是","Default":"无","Description":"

奖品链接。

\n","children":[],"key":"award-url"},{"Name":"ActivityId","Type":"string","Required":"是","Default":"无","Description":"

直播间活动 ID。

\n","children":[],"key":"award-ActivityId"},{"Name":"TaskAwardId","Type":"string","Required":"是","Default":"无","Description":"

抽奖配置 ID。

\n","children":[],"key":"award-TaskAwardId"},{"Name":"TaskAwardItemId","Type":"string","Required":"是","Default":"无","Description":"

累计观看抽奖的奖品 ID。

\n","children":[],"key":"award-TaskAwardItemId"}],"key":"award"}] return (

); ``` ### taskAwardPanel.pop 抽奖面板弹出事件。 **类型** ```ts (award: { config: TaskAwardConfig | null; viewedTime: number; isLogin: boolean; winningRecordMap: Map;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

抽奖信息。

\n","children":[{"Name":"config","Type":"TaskAwardConfig | null","Required":"是","Default":"无","Description":"

本次累计观看抽奖活动的抽奖配置信息。

\n","children":[],"key":"award-config"},{"Name":"viewedTime","Type":"number","Required":"是","Default":"无","Description":"

当前观众累计的观看时长。单位为秒。

\n","children":[],"key":"award-viewedTime"},{"Name":"isLogin","Type":"boolean","Required":"是","Default":"无","Description":"

当前观众是否登录直播间。取值如下：

true：已登录。

false：未登录。

","children":[],"key":"award-isLogin"},{"Name":"winningRecordMap","Type":"MapIRecordInfo>","Required":"是","Default":"无","Description":"

当前观众的中奖记录。

\n","children":[],"key":"award-winningRecordMap"}],"key":"award"}] return (

); ``` ### taskAwardBox.click 累计观看抽奖中奖结果点击事件。 **类型** ```ts (award: { index: number; WatchTime: number;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

抽奖信息。

\n","children":[{"Name":"index","Type":"number","Required":"是","Default":"无","Description":"

抽奖宝箱序号。从 0 开始计数。

\n","children":[],"key":"award-index"},{"Name":"WatchTime","Type":"number","Required":"是","Default":"无","Description":"

累计观看时长。单位为分钟。

\n","children":[],"key":"award-WatchTime"}],"key":"award"}] return (

); ``` ### share.click 分享点击事件。在 PC 端单击**分享**，移动端点击**复制链接**或**二维码**时会触发该事件。 **类型** ```ts () => void ``` ### poster.click 邀请海报点击事件。 **类型** ```ts () => void ``` ### adFloating.click 浮标广告点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。您可以将 `disableAdFloatingRedirect` 的参数值设为 `true` 并监听该事件，实现浮标广告的自定义跳转逻辑。详见[自定义跳转逻辑](https://www.volcengine.com/docs/3019/1205059#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%B3%E8%BD%AC%E9%80%BB%E8%BE%91)。 **类型** ```ts (ad: { AdvertisementRedirectUrl: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"ad","Type":"-","Required":"是","Default":"-","Description":"

浮标广告信息。

\n","children":[{"Name":"AdvertisementRedirectUrl","Type":"string","Required":"是","Default":"无","Description":"

浮标广告跳转链接。

\n","children":[],"key":"ad-AdvertisementRedirectUrl"}],"key":"ad"}] return (

); ``` ### adMiddle.click 页中广告点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。您可以将 `disableAdMiddleRedirect` 的参数值设为 `true` 并监听该事件，实现页中广告的自定义跳转逻辑。详见[自定义跳转逻辑](https://www.volcengine.com/docs/3019/1205059#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%B3%E8%BD%AC%E9%80%BB%E8%BE%91)。 **类型** ```ts (ad: { AdvertisementRedirectUrl: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"ad","Type":"-","Required":"是","Default":"-","Description":"

页中广告信息。

\n","children":[{"Name":"AdvertisementRedirectUrl","Type":"string","Required":"是","Default":"无","Description":"

页中广告跳转链接。

\n","children":[],"key":"ad-AdvertisementRedirectUrl"}],"key":"ad"}] return (

); ``` ### adHeader.click 页头广告点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。您可以将 `disableAdHeaderRedirect` 的参数值设为 `true` 并监听该事件，实现页头广告的自定义跳转逻辑。详见[自定义跳转逻辑](https://www.volcengine.com/docs/3019/1205059#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%B3%E8%BD%AC%E9%80%BB%E8%BE%91)。 **类型** ```ts (ad: { AdvertisementRedirectUrl: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"ad","Type":"-","Required":"是","Default":"-","Description":"

页头广告信息。

\n","children":[{"Name":"AdvertisementRedirectUrl","Type":"string","Required":"是","Default":"无","Description":"

页头广告跳转链接。

\n","children":[],"key":"ad-AdvertisementRedirectUrl"}],"key":"ad"}] return (

); ``` ### adAccount.click 主播账号点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。您可以将 `disableAdAccountRedirect` 的参数值设为 `true` 并监听该事件，实现主播账号的自定义跳转逻辑。详见[自定义跳转逻辑](https://www.volcengine.com/docs/3019/1205059#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B7%B3%E8%BD%AC%E9%80%BB%E8%BE%91)。 **类型** ```ts (account: { AccountHeadRedirectUrl: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"account","Type":"-","Required":"是","Default":"-","Description":"

主播账号信息。

\n","children":[{"Name":"AccountHeadRedirectUrl","Type":"string","Required":"是","Default":"无","Description":"

主播账号的跳转链接。

\n","children":[],"key":"account-AccountHeadRedirectUrl"}],"key":"account"}] return (

); ``` ### ready SDK 初始化完成事件，但并不代表播放器已经开始播放视频。 **类型** ```ts () => void ``` ### menu.click 菜单栏点击事件。 **类型** ```ts (tab: { terminal: 'pc' | 'mobile'; layout?: 'portrait'; tab: number;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"tab","Type":"-","Required":"是","Default":"-","Description":"

菜单栏相关信息。

\n","children":[{"Name":"terminal","Type":"\"pc\" | \"mobile\"","Required":"是","Default":"无","Description":"

观众的终端类型。取值如下：

\"pc\"：PC 端。

\"mobile\"：移动端。

","children":[],"key":"tab-terminal"},{"Name":"layout","Type":"\"portrait\" | undefined","Required":"否","Default":"无","Description":"

参数值固定为 portrait，表示观众在移动端竖屏直播间中点击菜单栏。

\n","children":[],"key":"tab-layout"},{"Name":"tab","Type":"number","Required":"是","Default":"无","Description":"

菜单类型。取值如下：

3：聊天互动菜单。

31：热门评论菜单。

5：聚合直播菜单。

2：商品卡片菜单。

1：图文介绍菜单。

4：互动工具菜单。

6：互动问答菜单。

7：内嵌链接菜单。

61：邀请榜单菜单。

","children":[],"key":"tab-tab"}],"key":"tab"}] return (

); ``` ### menu.rendered 菜单列表首次渲染完成事件。 **类型** ```ts () => void ``` ### thumbs.click 直播间点赞事件。 **类型** ```ts (thumb: { count: number;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"thumb","Type":"-","Required":"是","Default":"-","Description":"

点赞信息。

\n","children":[{"Name":"count","Type":"number","Required":"是","Default":"无","Description":"

点赞数量。

\n","children":[],"key":"thumb-count"}],"key":"thumb"}] return (

); ``` ### permissionMode2.need 通过该事件判断是否需要将 `mode` 的值从 `1` 切换为 `2`。在 `mode` 取值为 `1` 且 `disabledLogin` 取值为 `true` 时，观众点击关注主播后触发该事件。触发该事件后，您需触发自有账号系统的登录流程并通过 [updateMode2Token](1185516#websdkbase-updatemode2token) 方法将 `mode` 取值为 `1` 时的 Token 更新为 `mode` 取值为 `2` 时的 Token。详见[关注主播](https://www.volcengine.com/docs/3019/1205059#%E5%85%B3%E6%B3%A8%E4%B8%BB%E6%92%AD)。 **类型** ```ts () => void ``` ### feature.click 互动功能按钮点击事件。您可以通过设置 `disableFeatureProcess` 的参数值并监听该事件，阻止指定互动功能的后续执行。 **类型** ```ts (feature: { feature: string; status: boolean;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"feature","Type":"-","Required":"是","Default":"-","Description":"

互动功能信息。

\n","children":[{"Name":"feature","Type":"string","Required":"是","Default":"无","Description":"

互动功能。取值如下：

Comment：评论功能。

Gift：礼物打赏功能。

Lottery：实时抽奖功能。

Thumb：评论点赞功能。

Luckymoney：红包功能。

Reservation：直播预约功能。

Question：互动问答功能。

CheckIn：签到功能。

Vote：投票功能。

Questionnaire：问卷功能。

TaskAward：累计观看抽奖功能。

","children":[],"key":"feature-feature"},{"Name":"status","Type":"boolean","Required":"是","Default":"无","Description":"

是否阻止互动功能的后续执行。取值如下：

true：阻止。

false：不阻止。

","children":[],"key":"feature-status"}],"key":"feature"}] return (

); ``` ### customInteractionIcons.click 自定义互动工具浮窗点击事件。 **类型** ```ts (key: string) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"key","Type":"string","Required":"是","Default":"无","Description":"

互动工具浮窗的唯一标识。

\n","children":[],"key":"key"}] return (

); ``` ### customMessage.send 自定义的 IM（长链接消息）信令收到事件。 **类型** ```ts (msg: string) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"msg","Type":"string","Required":"是","Default":"无","Description":"

通过 SendCustomSystemMessageAPI 接口发送的自定义的 IM 信令。

\n","children":[],"key":"msg"}] return (

); ``` ### trial.login 试看期间直播间登录事件。 **类型** ```ts () => void ``` ### lottery.order 观众未满足实时抽奖的下单条件时，做任务参与抽奖页面的去完成按钮点击事件。 **类型** ```ts (award: { ID: number; Name: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"-","Required":"是","Default":"-","Description":"

抽奖信息。

\n","children":[{"Name":"ID","Type":"number","Required":"是","Default":"无","Description":"

抽奖 ID。

\n","children":[],"key":"award-ID"},{"Name":"Name","Type":"string","Required":"是","Default":"无","Description":"

奖品名称。

\n","children":[],"key":"award-Name"}],"key":"award"}] return (

); ``` ### award.receive 实时抽奖信息接收事件。当观众在观看页收到实时抽奖消息时，SDK 会触发此事件。你可以通过监听此事件，自定义抽奖入口提醒或开屏动画。 **类型** ```ts (award: AwardContext) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"AwardContext","Required":"是","Default":"无","Description":"

实时抽奖的配置信息。

\n","children":[],"key":"award"}] return (

); ``` ### award.statusChange 实时抽奖信息变更事件。在抽奖状态（如从“进行中”变为“已开奖”）或参与人数发生变化时，SDK 会触发此事件。你可以通过监听此事件，实时更新自定义抽奖 UI 的状态和进度。 **类型** ```ts (award: AwardContext) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"AwardContext","Required":"是","Default":"无","Description":"

变更后的实时抽奖配置信息。

\n","children":[],"key":"award"}] return (

); ``` ### award.conditionAchieved 实时抽奖参与条件达成事件。当观众满足了参与某个实时抽奖所需的参与条件（如观看时长达标、完成签到等）时，SDK 会触发此事件。你可以通过监听此事件，引导观众点击参与抽奖或展示达成提醒。 **类型** ```ts (award: IAwardConditionAchieved) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"award","Type":"IAwardConditionAchieved","Required":"是","Default":"无","Description":"

达成条件的实时抽奖信息。

\n","children":[],"key":"award"}] return (

); ``` ### luckymoney.withdrawal 立即提现按钮点击事件。仅在同时满足以下条件时，才会触发该事件： - 红包为现金红包 - 通过企业直播控制台或服务端 OpenAPI 配置了自定义地址或微信小程序 - 观众抢到红包并点击立即提现按钮 **类型** ```ts (luckymoneyInfo: { activityId: string; id: string; timestamp: number;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"luckymoneyInfo","Type":"-","Required":"是","Default":"-","Description":"

红包相关信息。

\n","children":[{"Name":"activityId","Type":"string","Required":"是","Default":"无","Description":"

直播间活动 ID。

\n","children":[],"key":"luckymoneyInfo-activityId"},{"Name":"id","Type":"string","Required":"是","Default":"无","Description":"

红包 ID。

\n","children":[],"key":"luckymoneyInfo-id"},{"Name":"timestamp","Type":"number","Required":"是","Default":"无","Description":"

点击立即提现按钮的时间。Unix 时间戳，单位为秒。

\n","children":[],"key":"luckymoneyInfo-timestamp"}],"key":"luckymoneyInfo"}] return (

); ``` ### checkIn.receive 收到签到消息事件。当主持人发送签到时，SDK 会触发此事件。你可以通过监听此事件，实现自定义的签到提醒 UI 或强制签到逻辑。 **类型** ```ts (checkInConfig: CheckInContext) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"checkInConfig","Type":"CheckInContext","Required":"是","Default":"无","Description":"

签到消息的配置信息。包含签到状态、签到人数等。

\n","children":[],"key":"checkInConfig"}] return (

); ``` ### checkIn.statusChange 签到消息状态变更事件，当出现以下情况时，会触发该事件： - 手动停止签到 - 到期自动停止签到 - 签到消息撤回 - 签到成功 **类型** ```ts (checkInConfig: CheckInContext) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"checkInConfig","Type":"CheckInContext","Required":"是","Default":"无","Description":"

签到配置信息。

\n","children":[],"key":"checkInConfig"}] return (

); ``` ### checkIn.click 点击签到消息事件。 **类型** ```ts (id: string) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"id","Type":"string","Required":"是","Default":"无","Description":"

签到 ID。

\n","children":[],"key":"id"}] return (

); ``` ### nickname.modify 昵称修改点击事件。配合 [disableModifyNickname](1185514#baseoptions) 参数，可实现自定义昵称修改弹窗。 **类型** ```ts () => void ``` ### im.message 消息接收事件。当直播间聊天中接收到新消息时，SDK 会触发该事件。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (data: any[]) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"any[]","Required":"是","Default":"无","Description":"

消息数据数组。每个元素表示一条接收到的消息。

\n","children":[],"key":"data"}] return (

); ``` ### im.playback.message 回放弹幕接收事件。在开启回放弹幕消息透传后，当回放视频接收到弹幕时，会触发此事件，SDK 会通过此事件透传弹幕数据。 :::tip 使用该事件无需建立 IM 长连接。 ::: **类型** ```ts (data: any[]) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"any[]","Required":"是","Default":"无","Description":"

弹幕消息数据数组。数组中的每个元素都表示一条弹幕消息。

\n","children":[],"key":"data"}] return (

); ``` ### im.messageDeleted IM 消息删除事件。当直播间中的消息被删除时，SDK 会触发此事件。 :::tip - 该事件可能会重复发送，请在接收到事件时注意对消息 ID 进行去重。 - 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (messageIds: string[]) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"messageIds","Type":"string[]","Required":"是","Default":"无","Description":"

被删除的消息 ID 列表。

\n","children":[],"key":"messageIds"}] return (

); ``` ### im.topMessage 置顶聊天消息变更事件。当直播间的置顶聊天消息发生变化时，SDK 会触发此事件，透传最新的置顶聊天内容。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (data: any[]) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"any[]","Required":"是","Default":"无","Description":"

最新的置顶聊天内容数组；取消置顶时为空数组。

\n","children":[],"key":"data"}] return (

); ``` ### im.reconnect IM 重连事件。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts () => void ``` ### im.reconnectSuccess IM 重连成功事件。在 IM 断开后，重连成功时，SDK 会触发此事件。 **类型** ```ts () => void ``` ### im.reconnectFailed IM 重连失败事件。在 IM 断开后，重连失败时，SDK 会触发此事件。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (error: unknown) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"error","Type":"unknown","Required":"是","Default":"无","Description":"

错误信息。

\n","children":[],"key":"error"}] return (

); ``` ### im.onlineCountChanged IM 在线人数变化事件。当直播间中的在线人数发生变化时，SDK 会触发此事件。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (count: number) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"count","Type":"number","Required":"是","Default":"无","Description":"

当前在线人数。

\n","children":[],"key":"count"}] return (

); ``` ### im.likeCountChanged 消息点赞数值变化事件。当直播间中的消息的点赞数值发生变化时，SDK 会触发此事件。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (count: number) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"count","Type":"number","Required":"是","Default":"无","Description":"

当前点赞数值。

\n","children":[],"key":"count"}] return (

); ``` ### im.userBanned 用户被禁言事件。当直播间中的用户被禁言时，SDK 会触发此事件。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (data: any) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"any","Required":"是","Default":"无","Description":"

禁言相关信息。

\n","children":[],"key":"data"}] return (

); ``` ### im.userLogin 用户进场事件。当有用户进入直播间时，SDK 会触发此事件。 :::tip 要使用该事件，请确保您已调用 [initIM()](1185516#initim) 接口初始化 IM（即时通信）数据并建立长链接。 ::: **类型** ```ts (data: any) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"any","Required":"是","Default":"无","Description":"

用户进场的消息数据，即系统通知中的进场消息数据。

\n","children":[],"key":"data"}] return (

); ``` ### player.created 播放器创建完成事件。在播放器实例创建完成后，SDK 会触发此事件。 **类型** ```ts (playerInstance: any) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"playerInstance","Type":"any","Required":"是","Default":"无","Description":"

播放器实例。你可以通过监听此事件，获取播放器实例并进行自定义操作。

\n","children":[],"key":"playerInstance"}] return (

); ``` ### connect.statusChange 观看端连麦状态变化事件。当观众端连麦状态发生变化时，SDK 会触发该事件。 **类型** ```ts (payload: { status: 'init' | 'applying' | 'connecting'; prevStatus: 'init' | 'applying' | 'connecting';}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"payload","Type":"-","Required":"是","Default":"-","Description":"

连麦状态变化信息。

\n","children":[{"Name":"status","Type":"\"init\" | \"applying\" | \"connecting\"","Required":"是","Default":"无","Description":"

当前连麦状态。取值如下：

init：初始状态。

applying：申请中。

connecting：连麦中。

","children":[],"key":"payload-status"},{"Name":"prevStatus","Type":"\"init\" | \"applying\" | \"connecting\"","Required":"是","Default":"无","Description":"

上一次连麦状态。

\n","children":[],"key":"payload-prevStatus"}],"key":"payload"}] return (

); ``` ### shopCart.click 购物车点击事件。当用户点击购物车时触发。 **类型** ```ts () => void ``` ### coupon.entry 卡券入口点击事件。当用户点击观看页面的卡券图标、互动工具中的卡券和商品卡片菜单里的卡券图标等卡券入口时，SDK 会触发此事件。 **类型** ```ts (payload: { couponId?: number; couponInfo?: CouponContext; terminal?: 'pc' | 'mobile'; source?: string;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"payload","Type":"-","Required":"是","Default":"-","Description":"

事件的参数对象。

\n","children":[{"Name":"couponId","Type":"number | undefined","Required":"否","Default":"无","Description":"

卡券 ID。

\n","children":[],"key":"payload-couponId"},{"Name":"couponInfo","Type":"CouponContext | undefined","Required":"否","Default":"无","Description":"

卡券详细配置信息。

\n","children":[],"key":"payload-couponInfo"},{"Name":"terminal","Type":"\"pc\" | \"mobile\" | undefined","Required":"否","Default":"无","Description":"

观众的终端类型。取值如下：

\"pc\"：PC 端。

\"mobile\"：移动端。

","children":[],"key":"payload-terminal"},{"Name":"source","Type":"string | undefined","Required":"否","Default":"无","Description":"

触发位置来源。

\n","children":[],"key":"payload-source"}],"key":"payload"}] return (

); ``` ### coupon.click 卡券领取按钮点击事件。当用户点击卡券中的“立即领取”按钮时，SDK 会触发此事件。 **类型** ```ts (payload: { callback?: ((canPick: boolean, msg?: string) => void) | undefined; }) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"payload","Type":"-","Required":"是","Default":"-","Description":"

事件的参数对象。

\n","children":[{"Name":"callback","Type":"((canPick: boolean, msg?: string) =\\> void) | undefined","Required":"否","Default":"无","Description":"

回调函数。你可以通过执行该函数，控制是否允许用户领取卡券。\n传入参数：

canPick：是否允许领取。取值如下：

true：允许。

false：不允许。

msg：不允许领取时，用于提示用户的消息。

","children":[],"key":"payload-callback"}],"key":"payload"}] return (

); ``` ### activity.attentionRemind 认真度检测提醒事件。当系统检测到观众在直播间内有切屏、静音或长时间无互动行为，并触发提醒弹窗时，SDK 会触发此事件。 **类型** ```ts (data: { reason: 'noInteraction_remind' | 'muted' | 'tabSwitch'; userId: number | undefined; externalUserId: unknown | undefined;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"-","Required":"是","Default":"-","Description":"

认真度检测提醒的详细数据。

\n","children":[{"Name":"reason","Type":"\"noInteraction_remind\" | \"muted\" | \"tabSwitch\"","Required":"是","Default":"无","Description":"

触发提醒的原因。取值如下：

'noInteraction_remind'：长时间无互动。

'muted'：静音状态。

'tabSwitch'：切屏。

","children":[],"key":"data-reason"},{"Name":"userId","Type":"number | undefined","Required":"否","Default":"无","Description":"

用户 ID，观众在企业直播系统中的唯一标识。

\n","children":[],"key":"data-userId"},{"Name":"externalUserId","Type":"unknown","Required":"是","Default":"无","Description":"

观众的关联用户 ID，即在第三方平台中的唯一标识。观众通过不同方式登录直播间，关联用户 ID 的取值如下所示。

微信：观众在企业直播微信服务号的 OpenID。

企业微信：绑定企业直播的企业内部成员 OpenID。

自定义：自定义登录时通过 UserId 传入的值。详见自定义登录。

OAuth 2.0：您自有账号系统中用户 ID 对应的字段。

飞书：绑定企业直播的飞书企业成员 Open ID。

手机号：观众通过手机号注册企业直播后生成的 passport_id。

白名单：观众输入的白名单校验信息。

\n **说明**：如果您集成了观播 SDK，且 SDK 的鉴权模式为自定义模式，关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时、或调用 GetActivityLoginSecret 后生成 JWT 时，传入的 UserIdStr（观众 ID）。","children":[],"key":"data-externalUserId"}],"key":"data"}] return (

); ``` ### activity.attentionKickout 无互动检测踢出事件。当系统检测到观众在直播间内长时间无互动并触发踢出逻辑时，SDK 会触发此事件。 **类型** ```ts (data: { reason: 'noInteraction_kickout'; userId: number | undefined; externalUserId: unknown | undefined;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"-","Required":"是","Default":"-","Description":"

无互动检测踢出的详细数据。

\n","children":[{"Name":"reason","Type":"\"noInteraction_kickout\"","Required":"是","Default":"无","Description":"

触发踢出的原因。固定值为 'noInteraction_kickout'，表示长时间无互动踢出。

\n","children":[],"key":"data-reason"},{"Name":"userId","Type":"number | undefined","Required":"否","Default":"无","Description":"

用户 ID，观众在企业直播系统中的唯一标识。

\n","children":[],"key":"data-userId"},{"Name":"externalUserId","Type":"unknown","Required":"是","Default":"无","Description":"

观众的关联用户 ID，即在第三方平台中的唯一标识。观众通过不同方式登录直播间，关联用户 ID 的取值如下所示。

微信：观众在企业直播微信服务号的 OpenID。

企业微信：绑定企业直播的企业内部成员 OpenID。

自定义：自定义登录时通过 UserId 传入的值。详见自定义登录。

OAuth 2.0：您自有账号系统中用户 ID 对应的字段。

飞书：绑定企业直播的飞书企业成员 Open ID。

手机号：观众通过手机号注册企业直播后生成的 passport_id。

白名单：观众输入的白名单校验信息。

); ``` ### activity.attentionContinueClick 点击按钮继续观看事件。当因切屏、静音、或长时间无互动行为，被提醒或被踢出的用户点击按钮继续观看直播时，SDK 会触发此事件。 **类型** ```ts (data: { reason: 'noInteraction_remind' | 'noInteraction_kickout' | 'muted' | 'tabSwitch'; userId: number | undefined; externalUserId: unknown | undefined;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"-","Required":"是","Default":"-","Description":"

点击按钮继续观看的详细数据。

\n","children":[{"Name":"reason","Type":"\"noInteraction_remind\" | \"muted\" | \"tabSwitch\" | \"noInteraction_kickout\"","Required":"是","Default":"无","Description":"

触发继续观看的原因。取值如下：

'noInteraction_remind'：长时间无互动被提醒。

'noInteraction_kickout'：长时间无互动被踢出。

'muted'：静音被提醒。

'tabSwitch'：切屏被提醒。

","children":[],"key":"data-reason"},{"Name":"userId","Type":"number | undefined","Required":"否","Default":"无","Description":"

用户 ID，观众在企业直播系统中的唯一标识。

\n","children":[],"key":"data-userId"},{"Name":"externalUserId","Type":"unknown","Required":"是","Default":"无","Description":"

观众的关联用户 ID，即在第三方平台中的唯一标识。观众通过不同方式登录直播间，关联用户 ID 的取值如下所示。

微信：观众在企业直播微信服务号的 OpenID。

企业微信：绑定企业直播的企业内部成员 OpenID。

自定义：自定义登录时通过 UserId 传入的值。详见自定义登录。

OAuth 2.0：您自有账号系统中用户 ID 对应的字段。

飞书：绑定企业直播的飞书企业成员 Open ID。

手机号：观众通过手机号注册企业直播后生成的 passport_id。

白名单：观众输入的白名单校验信息。

); ``` ### activity.attentionContinueRefresh 刷新页面继续观看事件。当因切屏、静音、或长时间无互动行为，被提醒或被踢出的用户刷新当前页面继续观看直播时，SDK 会触发此事件。 **类型** ```ts (data: { reason: 'noInteraction_remind' | 'noInteraction_kickout' | 'muted' | 'tabSwitch'; userId: number | undefined; externalUserId: unknown | undefined;}) => void ``` **参数** ```mixin-react const columns = [{ title: '名称', dataIndex: 'Name', width: 240, },{ title: '类型', dataIndex: 'Type', width: 240, render: (col, item, index) => { if(col.includes('')){ return

; } return col; } },{ title: '说明', dataIndex: 'Description', width: 500, render: (__html, item, index) => { return

; } }, ]; const data = [{"Name":"data","Type":"-","Required":"是","Default":"-","Description":"

刷新页面继续观看的详细数据。

\n","children":[{"Name":"reason","Type":"\"noInteraction_remind\" | \"muted\" | \"tabSwitch\" | \"noInteraction_kickout\"","Required":"是","Default":"无","Description":"

触发刷新页面继续观看的原因。取值如下：

'noInteraction_remind'：长时间无互动被提醒。

'noInteraction_kickout'：长时间无互动被踢出。

'muted'：静音被提醒。

'tabSwitch'：切屏被提醒。

","children":[],"key":"data-reason"},{"Name":"userId","Type":"number | undefined","Required":"否","Default":"无","Description":"

用户 ID，观众在企业直播系统中的唯一标识。

\n","children":[],"key":"data-userId"},{"Name":"externalUserId","Type":"unknown","Required":"是","Default":"无","Description":"

观众的关联用户 ID，即在第三方平台中的唯一标识。观众通过不同方式登录直播间，关联用户 ID 的取值如下所示。

微信：观众在企业直播微信服务号的 OpenID。

企业微信：绑定企业直播的企业内部成员 OpenID。

自定义：自定义登录时通过 UserId 传入的值。详见自定义登录。

OAuth 2.0：您自有账号系统中用户 ID 对应的字段。

飞书：绑定企业直播的飞书企业成员 Open ID。

手机号：观众通过手机号注册企业直播后生成的 passport_id。

白名单：观众输入的白名单校验信息。

); ```