SDKEventsExternal #

类型：interface
小程序 SDK 非播放器相关的监听事件，如抽奖、奖券等模块的事件。

error #

SDK 发生错误时触发的事件，例如初始化失败、重复登录等。
类型

(payload: { code: SDKErrorCode; message: string; _originalError?: unknown;}) => void

参数

ready #

在 SDK 初始化完成时，SDK 会触发此事件。您可以通过监听此事件，确认 SDK 已准备就绪，并可以开始调用其他功能接口，例如进入直播间。
类型

(payload: {}) => void

参数

activity.status #

直播状态变更事件。
类型

(status: 1 | 2 | 3 | 4 | 5) => void

参数

bottomIcon.click #

观看页图标点击事件。当用户点击底部操作区的图标或横屏播放器右上角的图标时，SDK 会触发此事件。
注意事项：

• 该事件同时覆盖 SDK 内置图标（如后台播放、清晰度、倍速等）和您自定义的图标。
• 点赞按钮（key 为 HEART）不会触发此事件。如需监听点赞行为，请监听 SDK 提供的 thumb.click 事件。

类型

(payload: { icon: BottomIcon; roomType: 'portrait' | 'landscape';}) => void

参数

backgroundPlayback.success #

后台播放请求成功事件。当调用 requestBackgroundPlayback 方法或点击 SDK 后台播放按钮成功进入后台播放模式时触发。
类型

(payload: { source: 'bottom-icon' | 'api'; playerType: 'video' | 'live-player' | string; errMsg: string;}) => void

参数

backgroundPlayback.fail #

后台播放请求失败事件。当调用 requestBackgroundPlayback 方法或点击 SDK 后台播放按钮进入后台播放模式失败时触发。
类型

(payload: { source: 'bottom-icon' | 'api'; playerType: 'video' | 'live-player' | string; errMsg: string; reason: 'unsupported' | 'player_not_ready' | 'wechat_fail';}) => void

参数

card.click #

菜单内的商品卡片点击事件。您可以通过监听此事件，实现商品卡片的自定义跳转逻辑。详见功能实现：自定义跳转逻辑。
类型

(card: { Id: number; cardIndex: number; text: string; url: string; UAInfos: UAInfos[]; DirectUrls: string[];}) => void

参数

card.configChange #

商品卡片内容或菜单配置变更事件。
类型

(payload: { menus: Menu[]; product: ProductV2;}) => void

参数

card.explainStatusChange #

商品卡片讲解状态或浮窗展示状态变化事件。
类型

(payload: { displayStatus: boolean; Id?: number; Title?: string; RedirectUrl?: string; UAInfos?: UAInfos[];}) => void

参数

productDetail.click #

商品详情点击事件。当观众点击商品图、商品名称、商品价格等商品信息区域时，SDK 会触发此事件。

若您在初始化时通过 jumpConfig.webviewUrlPath 配置了宿主 Webview 页面，并在 jumpConfig.features 中包含 productDetail，则 SDK 会在抛出该事件后执行默认跳转；若未包含，则仅抛出事件，由您自行处理跳转逻辑。
类型

(card: { Id?: number; text?: string; url: string; originUrl?: string; UAInfos?: UAInfos[]; DirectUrls?: string[]; source?: ProductCardClickSource;}) => void

参数

productPurchase.click #

商品购买点击事件。当观众点击商品的跳转图时，SDK 会触发此事件。

若您在初始化时通过 jumpConfig.webviewUrlPath 配置了宿主 Webview 页面，并在 jumpConfig.features 中包含 productPurchase，则 SDK 会在抛出该事件后执行默认跳转；若未包含，则仅抛出事件，由您自行处理跳转逻辑。
类型

(card: { Id?: number; text?: string; url: string; originUrl?: string; originRedirectUrl?: string; UAInfos?: UAInfos[]; DirectUrls?: string[]; source?: ProductCardClickSource;}) => void

参数

productAddCart.click #

加入购物车点击事件。当观众点击商品的加购按钮时，SDK 会触发此事件。

若您在初始化时通过 jumpConfig.webviewUrlPath 配置了宿主 Webview 页面，并在 jumpConfig.features 中包含 productAddCart，则 SDK 会在抛出该事件后执行默认跳转；若未包含，则仅抛出事件，由您自行处理跳转逻辑。
类型

(card: { Id?: number; text?: string; url: string; originUrl?: string; UAInfos?: UAInfos[]; DirectUrls?: string[]; source?: ProductCardClickSource;}) => void

参数

floatingCard.click #

浮窗商品卡片点击事件。您可以通过监听此事件，实现商品卡片的自定义跳转逻辑。详见功能实现：自定义跳转逻辑。
类型

(card: { Id: number; text: string; url: string; UAInfos: UAInfos[]; DirectUrls: string[];}) => void

参数

shopCart.click #

购物车按钮点击事件。用户点击移动端横屏或竖屏直播间的购物车按钮时触发。
类型

() => void

reservation.click #

当用户点击直播间的“立即预约”按钮时，SDK 会触发此事件。您可以通过监听此事件，实现自定义的预约逻辑或进行数据埋点。
类型

(payload: {}) => void

参数

reservation.attend #

在用户成功提交预约信息并完成预约时，SDK 会触发此事件。您可以通过监听此事件，获取用户的预约信息或更新预约相关的 UI 状态。
类型

(payload: { tel: string;}) => void

参数

countdown.finish #

当直播倒计时自然结束时，SDK 会触发此事件。
类型

(payload: {}) => void

参数

lottery.click #

抽奖入口点击事件。
类型

(award: { awardId: number;}) => void

参数

lottery.attend #

参与抽奖事件。
类型

(award: { awardId: number;}) => void

参数

lottery.result #

抽奖开奖事件。仅当抽奖开奖时用户在线，才会触发该事件。
类型

(award: { awardId: number; ifWin: boolean;}) => void

参数

lottery.winInfo #

提交中奖信息事件。
类型

(award: { awardId: number; awardTel: string; awardAddress?: string;}) => void

参数

lotteryTicket.click #

领取奖券奖品点击事件。您可以通过监听此事件，实现商品卡片的自定义跳转逻辑。详见功能实现：自定义跳转逻辑。
类型

(award: { url: string; ActivityId: number; TaskAwardId: number; TaskAwardItemId?: string;}) => void

参数

adFloating.click #

浮标广告点击事件。仅在通过企业直播控制台或服务端 OpenAPI 配置了跳转链接后，才会触发该事件。您可以通过监听此事件，实现浮标广告的自定义跳转逻辑。详见功能实现：自定义跳转逻辑。
类型

(ad: { AdvertisementRedirectUrl?: string;}) => void

参数

imageText.linkClick #

互动工具菜单中的文本超链接点击事件。您可以通过监听此事件，实现互动工具菜单中的文本超链接的自定义跳转逻辑。
类型

(payload: { url: string; text: string;}) => void

参数

announcement.linkClick #

公告内容中的超链接点击事件。您可以通过监听此事件，实现公告内容中的超链接的自定义跳转逻辑。
类型

(payload: { url: string; text: string; announcementId?: number;}) => void

参数

richText.linkClick #

图文介绍菜单富文本超链接点击事件。您可以通过监听此事件，实现图文介绍菜单富文本超链接的自定义跳转逻辑。
类型

(payload: { url: string; text: string; title?: string;}) => void

参数

thumb.click #

直播间点赞事件。
类型

(thumb: { count: number;}) => void

参数

thumb.count_change #

点赞数变更事件。
类型

(thumb: { count: number;}) => void

参数

coupon.get_list #

获取可用卡券列表事件。
类型

(payload: { idList?: number[];}) => void

参数

coupon.update_list #

卡券列表状态更新事件。
类型

(payload: { imageText: ImageTextInfo[];}) => void

参数

coupon.show_by_id #

展示指定卡券事件。
类型

(payload: { couponId: number; from?: string;}) => void

参数

coupon.show_auto #

自动弹出卡券事件。
类型

(payload: { couponId: number; coupon?: ActivityCouponInfo;}) => void

参数

coupon.close #

关闭卡券弹窗事件。
类型

(payload: { couponId: number;}) => void

参数

coupon.pick_up #

领取卡券按钮点击事件。
类型

(payload: { couponId: number;}) => void

参数

coupon.pick_up_status #

领取卡券状态事件。
类型

(payload: { couponId: number; status?: CouponPickUpStatusValue; res?: CouponPickUpResponse;}) => void

参数

coupon.pick_up_error #

领取卡券异常事件。
类型

(payload: { couponId: number; res?: CouponPickUpResponse;}) => void

参数

coupon.entry_click #

卡券入口点击事件。当用户点击观看页面的卡券图标、互动工具中的卡券和商品卡片菜单里的卡券图标等卡券入口时，SDK 会触发此事件。
类型

(payload: { couponId?: number; coupon?: ActivityCouponInfo; couponInfo?: ActivityCouponInfo; terminal?: 'pc' | 'mobile'; source?: string;}) => void

参数

coupon.click #

卡券领取按钮点击事件。当用户点击卡券中的“立即领取”按钮时，SDK 会触发此事件。
类型

(payload: { callback?: ((canPick: boolean, msg?: string) => void) | undefined; }) => void

参数

luckymoney.withdrawal #

立即提现按钮点击事件。
仅在同时满足以下条件时，才会触发该事件：

• 红包为现金红包
• 通过企业直播控制台或服务端 OpenAPI 配置了自定义地址或微信小程序
• 观众抢到红包并点击立即提现按钮

类型

(luckymoneyInfo: { activityId: string; redPacketId: number; timestamp: number; type?: 'miniapp' | 'custom'; customRedirectUrl?: string; detail?: { redPacketId?: number; };}) => void

参数

feature.click #

互动功能按钮点击事件。您可以通过设置 disableFeatureProcess 并监听该事件，接管指定互动功能的默认处理逻辑。
类型

(payload: { feature: 'Comment' | 'Question' | 'Questionnaire' | 'CheckIn' | 'Lottery' | 'Thumb' | 'Luckymoney' | 'Reservation' | 'Coupon'; status: boolean;}) => void

参数

liveBonus.lotteryTicket.click #

福利任务奖券奖品领取点击事件。当用户点击福利任务领奖弹窗中的「前往领取奖品」按钮时触发。
类型

(payload: { url?: string; activityId?: number | string; taskId?: number | string;}) => void

参数

liveBonus.cashWithdraw.click #

福利任务现金奖励立即提现点击事件。当用户点击福利任务领奖弹窗中的「立即提现」按钮，且奖励配置了提现跳转地址时触发。
类型

(payload: { activityId?: number | string; taskId?: number | string; source: 'reward_detail' | 'auto_receive'; redirectType: 'miniapp' | 'custom'; miniAppId?: string; miniAppRedirectParam?: string; customRedirectUrl?: string;}) => void

参数

questionnaire.complete #

问卷提交完成事件。当用户提交问卷后，无论成功或失败，SDK 都会触发此事件。
类型

(payload: { activityId: number; questionnaireId: number; answers: Array<{ questionId: number; answer: string | string[]; }>; status: 'success' | 'fail'; errorCode?: string | number; errorMessage?: string;}) => void

参数

player.play #

开始播放事件。在播放器接收到播放指令并成功开始尝试拉流时，SDK 会触发此事件。
类型

() => void

player.playing #

恢复播放事件。在播放器由于卡顿、暂停后重新进入播放状态，且画面开始流畅更新时，SDK 会触发此事件。
类型

() => void

player.pause #

暂停播放事件。在播放器执行暂停操作并停止画面更新时，SDK 会触发此事件。
类型

() => void

player.ended #

播放结束事件。在当前视频内容播放完毕时，SDK 会触发此事件。
注意
小程序 SDK 为兼容历史行为保留该参数；Web SDK 同名事件无参数。
类型

(isAllReplayEnded: boolean) => void

参数

player.destroy #

销毁播放器事件。在播放器组件被卸载、页面销毁，或 SDK 播放器从视频态切换回封面态时，SDK 会触发此事件。
类型

() => void

player.status #

直播状态映射文案变更事件。
类型

(status: '直播' | '预告' | '回放' | '结束' | '已关闭') => void

参数