SDKPlayerEventsOnExternal #

类型：interface

播放器相关监听事件。

player.play #

播放事件。

类型

() => void

player.playing #

（暂停、卡顿后）恢复播放事件。

类型

() => void

player.pause #

暂停播放事件。

类型

() => void

player.ended #

结束播放事件。

类型

() => void

player.destroy #

销毁播放器事件。

类型

() => void

player.ratechange #

播放速率变化事件。

类型

(rate: number) => void

参数

player.fullscreen_change #

全屏模式变化事件。

类型

(isFullScreen: boolean) => void

参数

player.pip_change #

PC 端小窗模式变化事件。

类型

(isPip: boolean) => void

参数

player.waiting #

等待加载数据事件。

类型

() => void

player.status #

直播状态变更事件。

类型

(status: string) => void

参数

player.vodConfigChange #

点播视频（预告和回放）断点续播事件。
点播视频播放过程中该事件的触发时机如下：

• PC 端：页面关闭时，SDK 触发该事件。
• 移动端：WebView 的 pagehide 事件触发时或用户手动拖动进度条时，SDK 触发该事件。

类型

(VodInfo: { vid: string; currentTime: number; duration: number;}) => void

参数

lines.number #

多线路数量变化事件。

类型

(lines: number) => void

参数

SDKPlayerEventsEmit #

类型：enum

播放器相关触发事件。

SDKEventsEmit #

类型：enum

非播放器相关触发事件。

SDKEventsExternal #

类型：interface

非播放器相关监听事件。

activity.status #

直播状态变更事件。

类型

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

参数

comment.focus #

聊天互动输入框点击事件。

类型

() => void

comment.send #

发送评论事件。

类型

(msg: string) => void

参数

comment.nickNameClick #

评论区昵称点击事件。

类型

(data: { Nickname: string; ExternalId: string; isTop: boolean; isPresenter: boolean;}) => void

参数

permission.need #

通过该事件判断是否需要弹出自定义登录框。
在 mode 取值为 1 且 disabledLogin 取值为 true 时，观众在参与评论、互动等需要用户信息的场景下，例如点击评论输入框时会触发该事件。
触发该事件后，您需触发自有账号系统的登录流程并通过 updateMode2Token 方法将 mode 取值为 1 时的 Token 更新为 mode 取值为 2 时的 Token。详见第三方用户态登录。

类型

() => void

reservation.click #

立即预约按钮点击事件。

类型

() => void

reservation.attend #

成功预约事件。

类型

(tel: string) => void

参数

card.configChange #

商品卡片配置变化事件。

类型

(config: ProductConfig) => void

参数

card.Change #

商品卡片内容变化事件。当服务端配置的商品卡片列表发生增、删或改动时，SDK 会触发此事件。你可以通过监听此事件，实时同步本地的商品列表数据。

类型

(changes: { product: Product; type: 0 | 1 | 2;}[]) => void

参数

orderMsg.update #

下单消息（包括查看商品消息和下单购买消息）推送事件。

类型

(config: OrderMsgInfo) => void

参数

orderMsg.click #

下单消息（包括查看商品消息和下单购买消息）点击事件。

类型

(msg: OrderMsgInfo) => void

参数

card.explainStatusChange #

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

类型

(config: Partial<Product> & { displayStatus: boolean;}) => void

参数

card.click #

菜单内的商品卡片点击事件。

您可以将 disableCardRedirect 的参数值设为 true 并监听该事件，实现商品卡片的自定义跳转逻辑。

类型

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

参数

floatingCard.click #

浮窗商品卡片点击事件。

您可以将 disableCardRedirect 的参数值设为 true 并监听该事件，实现浮窗商品卡片的自定义跳转逻辑。

类型

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

参数

productDetail.click #

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

您可以将 disableCardRedirect 或 disableProductDetailRedirect 的参数值设为 true 并监听该事件，实现商品详情入口的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

productPurchase.click #

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

您可以将 disableCardRedirect 或 disableProductPurchaseRedirect 的参数值设为 true 并监听该事件，实现商品跳转图的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

productAddCart.click #

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

您可以将 disableProductAddCartRedirect 的参数值设为 true 并监听该事件，实现加购按钮的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

productCart.click #

商品卡片导航栏的查看购物车图标点击事件。当观众点击移动端商品卡片菜单导航栏区域的查看购物车图标时，SDK 会触发此事件。

您可以将 disableProductCartRedirect 的参数值设为 true 并监听该事件，实现查看购物车图标的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

productOrder.click #

商品卡片导航栏的查看订单图标点击事件。当观众点击移动端商品卡片菜单导航栏区域的查看订单图标时，SDK 会触发此事件。

您可以将 disableProductOrderRedirect 的参数值设为 true 并监听该事件，实现查看订单图标的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

lottery.click #

抽奖入口点击事件。

类型

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

参数

lottery.attend #

参与抽奖事件。

类型

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

参数

lottery.result #

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

类型

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

参数

lottery.winInfo #

提交中奖信息事件。

类型

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

参数

lotteryTicket.click #

领取奖券奖品点击事件。
您可以将 disableLotteryTicketRedirect 的参数值设为 true 并监听该事件，实现奖券奖品领取链接的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

taskAwardPanel.pop #

抽奖面板弹出事件。

类型

(award: { config: TaskAwardConfig | null; viewedTime: number; isLogin: boolean; winningRecordMap: Map<string, IRecordInfo>;}) => void

参数

taskAwardBox.click #

累计观看抽奖中奖结果点击事件。

类型

(award: { index: number; WatchTime: number;}) => void

参数

share.click #

分享点击事件。在 PC 端单击分享，移动端点击复制链接或二维码时会触发该事件。

类型

() => void

player_icon_share.click #

观看页播放器上分享图标点击事件。在观众点击播放器上的分享图标时会触发该事件。

类型

() => void

poster.click #

邀请海报点击事件。

类型

() => void

adFloating.click #

浮标广告点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。
您可以将 disableAdFloatingRedirect 的参数值设为 true 并监听该事件，实现浮标广告的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

adMiddle.click #

页中广告点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。
您可以将 disableAdMiddleRedirect 的参数值设为 true 并监听该事件，实现页中广告的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

adHeader.click #

页头广告点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。
您可以将 disableAdHeaderRedirect 的参数值设为 true 并监听该事件，实现页头广告的自定义跳转逻辑。详见自定义跳转逻辑。

类型

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

参数

adAccount.click #

主播账号点击事件。仅在通过企业直播控制台或服务端 OpenAPI（如支持）配置跳转链接后，才会触发该事件。
您可以将 disableAdAccountRedirect 的参数值设为 true 并监听该事件，实现主播账号的自定义跳转逻辑。详见自定义跳转逻辑。

类型

(account: { AccountHeadRedirectUrl: string;}) => void

参数

ready #

SDK 初始化完成事件，但并不代表播放器已经开始播放视频。

类型

() => void

menu.click #

菜单栏点击事件。

类型

(tab: { terminal: 'pc' | 'mobile'; layout?: 'portrait'; tab: number;}) => void

参数

menu.rendered #

菜单列表首次渲染完成事件。

类型

() => void

thumbs.click #

直播间点赞事件。

类型

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

参数

permissionMode2.need #

通过该事件判断是否需要将 mode 的值从 1 切换为 2。
在 mode 取值为 1 且 disabledLogin 取值为 true 时，观众点击关注主播后触发该事件。
触发该事件后，您需触发自有账号系统的登录流程并通过 updateMode2Token 方法将 mode 取值为 1 时的 Token 更新为 mode 取值为 2 时的 Token。详见关注主播。

类型

() => void

feature.click #

互动功能按钮点击事件。您可以通过设置 disableFeatureProcess 的参数值并监听该事件，阻止指定互动功能的后续执行。

类型

(feature: { feature: string; status: boolean;}) => void

参数

customInteractionIcons.click #

自定义互动工具浮窗点击事件。

类型

(key: string) => void

参数

customMessage.send #

自定义的 IM（长连接消息）信令收到事件。

类型

(msg: string) => void

参数

trial.login #

试看期间直播间登录事件。

类型

() => void

lottery.order #

观众未满足实时抽奖的下单条件时，做任务参与抽奖页面的去完成按钮点击事件。

类型

(award: { ID: number; Name: string;}) => void

参数

award.receive #

实时抽奖信息接收事件。当观众在观看页收到实时抽奖消息时，SDK 会触发此事件。你可以通过监听此事件，自定义抽奖入口提醒或开屏动画。

类型

(award: AwardContext) => void

参数

award.statusChange #

实时抽奖信息变更事件。在抽奖状态（如从“进行中”变为“已开奖”）或参与人数发生变化时，SDK 会触发此事件。你可以通过监听此事件，实时更新自定义抽奖 UI 的状态和进度。

类型

(award: AwardContext) => void

参数

award.conditionAchieved #

实时抽奖参与条件达成事件。当观众满足了参与某个实时抽奖所需的参与条件（如观看时长达标、完成签到等）时，SDK 会触发此事件。你可以通过监听此事件，引导观众点击参与抽奖或展示达成提醒。

类型

(award: IAwardConditionAchieved) => void

参数

luckymoney.withdrawal #

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

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

类型

(luckymoneyInfo: { activityId: string; id: string; timestamp: number;}) => void

参数

checkIn.receive #

收到签到消息事件。当主持人发送签到时，SDK 会触发此事件。你可以通过监听此事件，实现自定义的签到提醒 UI 或强制签到逻辑。

类型

(checkInConfig: CheckInContext) => void

参数

checkIn.statusChange #

签到消息状态变更事件，当出现以下情况时，会触发该事件：

• 手动停止签到
• 到期自动停止签到
• 签到消息撤回
• 签到成功

类型

(checkInConfig: CheckInContext) => void

参数

checkIn.click #

观众点击签到工具的“立即参与”入口、”查看详情“入口或签到图标事件。你可以通过监听此事件，获取观众点击的是哪个签到工具。

类型

(id: string) => void

参数

checkIn.result #

签到执行结果事件。观众在签到弹窗中提交签到后触发。

类型

(result: { checkInId: string; activityId: number; status: boolean; info?: string | undefined;}) => void

参数

nickname.modify #

昵称修改点击事件。配合 disableModifyNickname 参数，可实现自定义昵称修改弹窗。

类型

() => void

im.message #

消息接收事件。当直播间聊天中接收到新消息时，SDK 会触发该事件。

类型

(data: any[]) => void

参数

im.playback.message #

回放弹幕接收事件。在开启回放弹幕消息透传后，当回放视频接收到弹幕时，会触发此事件，SDK 会通过此事件透传弹幕数据。

类型

(data: any[]) => void

参数

im.messageDeleted #

IM 消息删除事件。当直播间中的消息被删除时，SDK 会触发此事件。

类型

(messageIds: string[]) => void

参数

im.topMessage #

置顶聊天消息变更事件。当直播间的置顶聊天消息发生变化时，SDK 会触发此事件，透传最新的置顶聊天内容。

类型

(data: any[]) => void

参数

im.reconnect #

IM 重连事件。

类型

() => void

im.reconnectSuccess #

IM 重连成功事件。在 IM 断开后，重连成功时，SDK 会触发此事件。

类型

() => void

im.reconnectFailed #

IM 重连失败事件。在 IM 断开后，重连失败时，SDK 会触发此事件。

类型

(error: unknown) => void

参数

im.onlineCountChanged #

IM 在线人数变化事件。当直播间中的在线人数发生变化时，SDK 会触发此事件。

类型

(count: number) => void

参数

im.likeCountChanged #

消息点赞数值变化事件。当直播间中的消息的点赞数值发生变化时，SDK 会触发此事件。

类型

(count: number) => void

参数

im.userBanned #

用户被禁言事件。当直播间中的用户被禁言时，SDK 会触发此事件。

类型

(data: any) => void

参数

im.userLogin #

用户进场事件。当有用户进入直播间时，SDK 会触发此事件。

类型

(data: any) => void

参数

player.created #

播放器创建完成事件。在播放器实例创建完成后，SDK 会触发此事件。

类型

(playerInstance: any) => void

参数

connect.statusChange #

观看端连麦状态变化事件。当观众端连麦状态发生变化时，SDK 会触发该事件。

类型

(payload: { status: 'init' | 'applying' | 'connecting'; prevStatus: 'init' | 'applying' | 'connecting';}) => void

参数

shopCart.click #

购物车点击事件。当用户点击购物车时触发。

类型

() => void

coupon.entry #

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

类型

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

参数

coupon.click #

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

类型

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

参数

activity.attentionRemind #

认真度检测提醒事件。当系统检测到观众在直播间内有切屏、静音或长时间无互动行为，并触发提醒弹窗时，SDK 会触发此事件。

类型

(data: { reason: 'noInteraction_remind' | 'muted' | 'tabSwitch'; userId: number | undefined; externalUserId: unknown | undefined;}) => void

参数

activity.attentionKickout #

无互动检测踢出事件。当系统检测到观众在直播间内长时间无互动并触发踢出逻辑时，SDK 会触发此事件。

类型

(data: { reason: 'noInteraction_kickout'; userId: number | undefined; externalUserId: unknown | undefined;}) => void

参数

activity.attentionContinueClick #

点击按钮继续观看事件。当因切屏、静音、或长时间无互动行为，被提醒或被踢出的用户点击按钮继续观看直播时，SDK 会触发此事件。

类型

(data: { reason: 'noInteraction_remind' | 'noInteraction_kickout' | 'muted_kickout' | 'muted' | 'tabSwitch'; userId: number | undefined; externalUserId: unknown | undefined;}) => void

参数

activity.attentionContinueRefresh #

刷新页面继续观看事件。当因切屏、静音、或长时间无互动行为，被提醒或被踢出的用户刷新当前页面继续观看直播时，SDK 会触发此事件。

类型

(data: { reason: 'noInteraction_remind' | 'noInteraction_kickout' | 'muted_kickout' | 'muted' | 'tabSwitch'; userId: number | undefined; externalUserId: unknown | undefined;}) => void

参数