PictureInPictureMode #

画中画模式。支持传入以下值或空数组。传空数组表示关闭画中画模式。

• push：当用户从当前直播间或点播间进入新页面时，开启小窗模式。
• pop：当用户从当前直播间或点播间返回上一页时，开启小窗模式。

类型

'push' | 'pop'

BottomIconConfig #

类型：interface
观看页图标配置。用于在初始化 SDK 时，对观看页的图标列表进行全局配置，包括图标顺序、显隐、资源替换和最多展示数量等。

maxVisibleCount #

类型：{ portrait?: number | undefined; landscape?: number | undefined; } | undefined
外层最多展示的图标数量。用于控制底部操作区在外层直接展示的按钮数量，超出部分会被折叠到"更多"面板中。不计入数量的特殊项："更多"入口按钮本身不计入数量统计；点赞按钮（key 为 HEART）也不计入该数量。
成员

transformIconList #

图标列表回调。SDK 在拿到服务端下发数据并计算完各项内置能力的默认显隐后，在即将渲染横屏或竖屏底部图标前，会触发此回调。您可以在此回调中对传入的图标列表进行排序、过滤、替换图标或文案、修改样式、添加自定义业务数据等，然后返回一个新的列表给 SDK 渲染。

• 适用场景：调整按钮的展示顺序、隐藏按钮、替换按钮的图标资源或文案、新增自定义按钮等。
• 注意事项：点赞按钮的固定 key 为 HEART，但它不会出现在本回调传入的 iconList 中，也不参与本回调的排序和过滤。如需修改点赞按钮，请使用 updateBottomIcon 方法。

类型

(params: { iconList: BottomIcon[]; roomType: 'portrait' | 'landscape';}) => BottomIcon[]

参数

返回值
BottomIcon[] 您需要返回一个新的 BottomIcon 数组。SDK 会按您返回的列表顺序渲染底部图标。

BottomIcon #

类型：interface
直播间底部或播放器操作区图标数据结构。

key #

类型：string
图标的 key。用于在图标列表中唯一标识一个图标。SDK 内置的图标 key 统一使用大写字母加下划线的格式，目前包括：

• BACKGROUND_PLAYBACK：后台播放按钮。
• CLARITY：清晰度切换按钮。
• BACKRATE：倍速切换按钮。
• NOTIFICATION_SWITCH：互动特效通知开关。
• RICHTEXT：图文菜单按钮。
• IMAGE_TEXT_LIVE：互动工具按钮。
• SHOPPING：购物车按钮。
• HEART：点赞按钮。该图标不会出现在 transformIconList 中，但可通过 updateBottomIcon 方法单独配置。
  您自定义的图标 key 无强制格式要求，但建议保持稳定、可识别。

visible #

类型：boolean | undefined
是否展示该图标。取值如下：

• true：展示该图标。为默认值。
• false：不展示该图标，也不会进入"更多"面板。

showIn #

类型："portrait" | "landscape" | undefined
指定该图标仅在特定直播间形态下展示。未配置时在横屏和竖屏下均展示。取值如下：

• portrait：仅在竖屏直播间展示。
• landscape：仅在横屏直播间展示。

iconUrl #

类型：string
图标图片的资源地址。建议使用公网 URL（以 https:// 开头）或 data URL；如使用小程序本地资源路径（例如 /images/icon.png），请确保该路径在宿主小程序运行时可正常访问。

title #

类型：string
图标的文案。在外层展示区域（底部操作区或播放器工具栏）不展示该文案；当图标被折叠进入"更多"面板后，会在图标下方展示该文案作为功能名称。

style #

类型：string | undefined
图标图片节点的内联样式。用于控制图片本身的视觉效果，例如图片尺寸、透明度等。示例：width: 70%; height: 70%;。

containerStyle #

类型：string | undefined
图标外层可点击容器的内联样式。用于控制容器的布局效果，例如容器间距、内边距、背景色等。示例：padding: 0 10rpx;。

data #

类型：Record<string, unknown> | undefined
您自定义透传的数据。当用户点击该图标时，SDK 触发 bottomIcon.click 事件，该字段会原样传出，您可以从中取出业务所需的自定义信息（如埋点参数、跳转链接等）。

JumpConfig #

类型：interface
SDK 外链跳转的默认配置。支持指定功能范围，跳转至您自定义的 Web View 页面。

webviewUrlPath #

类型：string | undefined
您自定义的 Webview 页面路径。例如 /pages/webview/webview。配置后，当用户在直播间内点击支持跳转的外链时，SDK 会自动构造跳转路径（拼接 url=<encodeURIComponent(目标链接)> 参数）并调用 wx.navigateTo 进行页面跳转。您无需在每个点击事件中重复实现跳转逻辑。

features #

类型：JumpFeature[] | undefined
指定 SDK 外链跳转的功能范围。如果不传此参数或传入空数组，则表示对所有支持的功能启用自动跳转。通过传入 JumpFeature 数组，您可以为指定的功能模块开启自动跳转。

JumpFeature #

支持开启 SDK 默认外链跳转的功能入口。用于精确控制自动跳转逻辑的生效范围。支持以下功能：

• card：点击菜单内商品卡片整体区域，例如商品图、标题、价格等信息区域。
• floatingCard：点击直播间内浮窗商品卡片的整体区域。
• productDetail：点击商品详情入口，例如商品图、商品名称、商品价格等商品信息区域。
• productPurchase：点击商品购买入口，例如商品跳转图等购买引导区域。
• productAddCart：点击商品的加入购物车按钮。
• productCart：点击商品操作区的“购物车”入口。
• productOrder：点击商品操作区的“订单”入口。
• adFloating：浮标广告点击。
• lotteryTicket：抽奖奖券奖品点击。
• liveBonusLotteryTicket：福利任务奖券奖品领取点击。
• liveBonusCashWithdraw：福利任务现金奖励立即提现自定义链接点击。
• imageTextLink：互动工具菜单中的文本超链接点击。
• announcementLink：公告内容中的超链接点击。
• richTextLink：图文介绍菜单富文本超链接点击。
• luckymoneyWithdrawal：红包提现自定义链接点击。

类型

| 'card'
  | 'floatingCard'
  | 'productDetail'
  | 'productPurchase'
  | 'productAddCart'
  | 'productCart'
  | 'productOrder'
  | 'adFloating'
  | 'lotteryTicket'
  | 'liveBonusLotteryTicket'
  | 'liveBonusCashWithdraw'
  | 'imageTextLink'
  | 'announcementLink'
  | 'richTextLink'
  | 'luckymoneyWithdrawal'

UAInfos #

类型：interface
直达链接的配置信息。

UAName #

类型：string
环境名称，与 UAAddress 一一对应。

UAAddress #

类型：string
环境 UA（User Agent），与 UAName 一一对应。

Menu #

类型：interface
菜单配置。

Name #

类型：string
菜单名称。

Type #

类型：number
菜单类型。取值如下：

• 1：图文介绍。
• 2：商品卡片。
• 3：聊天互动。
• 4：互动工具。
• 6：互动问答。
• 7：内嵌链接。
• 8：私聊互动。

Index #

类型：number
菜单序号。

ProductLinkConfig #

类型：interface
商品卡片菜单的跳转配置，用于配置商品详情、加入购物车等入口的默认链接、UA 匹配链接和小程序直达链接。

Default #

类型：string | undefined
默认 H5 跳转链接。未命中 UA 匹配链接或小程序直达链接时，SDK 使用该链接作为兜底链接。默认值为 ''。

UAList #

类型：string[] | undefined
UA 匹配跳转链接列表。SDK 会按商品菜单中的 UA 配置顺序匹配当前环境，命中后使用对应位置的链接。该参数仅在 EnableUA 取值为 true 时生效。默认值为 []。

MiniApp #

类型：string | undefined
移动端微信环境下的小程序直达链接。配置后，SDK 可在满足小程序跳转条件时打开对应小程序。该参数仅在 EnableMiniApp 取值为 true 时生效。默认值为 ''。

ProductMeta #

类型：interface
商品卡片菜单的导航栏配置，用于控制移动端商品卡片菜单导航栏区域的购物车和订单图标。

EnableViewCart #

类型：boolean | undefined
是否在移动端商品卡片菜单的导航栏区域展示购物车图标。默认值为 false。取值如下：

• true：展示购物车图标。
• false：不展示购物车图标。

ViewCartUrl #

类型：string | undefined
移动端购物车图标的跳转链接。链接为空时，SDK 仍触发购物车点击事件，但不执行默认打开。默认值为 ''。

EnableViewOrder #

类型：boolean | undefined
是否在移动端商品卡片菜单的导航栏区域展示订单图标。默认值为 false。取值如下：

• true：展示订单图标。
• false：不展示订单图标。

ViewOrderUrl #

类型：string | undefined
移动端订单图标的跳转链接。链接为空时，SDK 仍触发订单点击事件，但不执行默认打开。默认值为 ''。

ProductV2 #

类型：interface
商品卡片配置。

EnableFloating #

类型：boolean
是否开启浮层展示。取值如下：

• true：开启。观众在移动端点击商品卡片后，在当前观看页以浮层形式展示商品详情页。观众可以在观看直播的同时查看商品详情页，实现边看边买。
• false：关闭。观众点击商品卡片后，页面自动跳转至新的浏览器标签页展示商品详情页。观众无法同时观看直播与商品详情页。

EnableUA #

类型：boolean
是否开启直达链接功能。该功能仅移动端支持。取值如下：

• true：开启。
• false：关闭。

UAInfos #

类型：UAInfos[]
直达链接的配置信息。

EnableMiniApp #

类型：boolean
是否开启微信小程序跳转功能。该功能仅移动端支持。取值如下：

• true：开启。
• false：关闭。

MiniAppId #

类型：string
跳转的微信小程序的原始 ID。

Product #

类型：Product[]
商品配置信息。

ProductsPosition #

类型：POSITION_MAP
浮窗商品卡片在 PC 端观看页的展示位置。

DisplayEnable #

类型：number
商品卡片在观看页的入口。取值如下：

• 1：观看页支持展示商品卡片菜单和浮窗商品卡片。移动端观看页可同步展示购物车图标。

• 2：观看页仅支持展示浮窗商品卡片。

Product #

类型：interface
商品配置信息。

Title #

类型：string
商品名称。

Remark #

类型：string
商品介绍。

Highlight #

类型：string
商品的售卖价，即当前价格。

Strikethrough #

类型：string
商品的参考价，即原价。

IntroduceImage #

类型：string
商品图的 URL，包含协议头。

RedirectImage #

类型：string
跳转图的 URL，包含协议头。

RedirectUrl #

类型：string
跳转链接，即商品详情页的链接，包含协议头。如果观众无法跳转至直达链接或微信小程序，则会跳转至该链接。

DirectUrls #

类型：string[]
直达链接，包含协议头。当观众在环境 UA 匹配成功的移动端平台上点击商品卡片时，即可跳转至该链接。

Index #

类型：number
商品卡片的序号。

Id #

类型：number
商品卡片的 ID。

ExplainStatus #

类型：number
商品讲解状态。取值如下：

• 0：未讲解。
• 1：讲解中。
• 2：讲解结束。

FloatingStatus #

类型：number
是否浮窗展示商品卡片。取值如下：

• 1：浮窗展示。
• 其他值：非浮窗展示。

FloatingTime #

类型：number
浮窗商品卡片展示时间。Unix 时间戳，单位为秒。

ExplainTime #

类型：number
最近一次修改商品讲解状态的时间。Unix 时间戳，单位为秒。取值为 0 表示未修改过商品讲解状态。

EnableStatus #

类型：number
是否上架商品。取值如下：

• 0：下架。
• 1：上架。

MiniAppDirectUrl #

类型：string
微信小程序链接，包含协议头。当观众在移动端微信环境点击商品卡片时，即可跳转至该微信小程序。

DetailRedirectUrl #

类型：ProductLinkConfig | undefined
商品详情入口的跳转配置。当观众点击商品图、商品名称、商品价格等商品信息区域后跳转。若未配置该项，观众点击商品信息区域后会跳转至 RedirectUrl 中配置的链接。默认值为 无。

EnableAddCart #

类型：boolean | undefined
是否开启商品的加入购物车功能，展示加购按钮。默认值为 false。取值如下：

• true：开启。
• false：关闭。

AddCartUrl #

类型：ProductLinkConfig | undefined
加入购物车图标的跳转配置。链接为空时，SDK 仍触发加入购物车点击（productAddCart.click）事件，但不执行默认打开。默认值为 无。

SellingPointTag #

类型：string
卖点标签。

ReminderType #

类型：ReminderEnumType
在商品讲解期间的浮窗商品卡片和商品卡片菜单中，动效展示的提醒类型。

HotSale #

类型：string
热卖提醒数量。

Stock #

类型：string
库存提醒数量。

PromotionTagUrl #

类型：string
活动标签的 URL，包含协议头。

PromotionTagType #

类型：PromotionTagEnumType
活动标签类型。

IsOrderMsgEnable #

类型：IsOrderMsgEnableEnum
是否开启下单消息。

OutOfStock #

类型：IsOutOfStockEnum
是否售罄。

PriceHidden #

类型：IsPriceHiddenEnum
是否隐藏价格。

MemberPrice #

类型：string | undefined
会员价。

CustomContent #

类型：string | undefined
通过服务端 OpenAPI 透传的自定义扩展信息。

ReminderEnumType #

类型：enum
在商品讲解期间的浮窗商品卡片和商品卡片菜单中，动效展示的提醒类型。

PromotionTagEnumType #

类型：enum
活动标签类型。

IsOrderMsgEnableEnum #

类型：enum
是否开启下单消息。

IsOutOfStockEnum #

类型：enum
是否售罄。

IsPriceHiddenEnum #

类型：enum
是否隐藏价格。

POSITION_MAP #

类型：enum
浮窗商品卡片在 PC 端观看页的展示位置。

ImageTextInfo #

类型：interface
互动工具的详细信息。

Context #

类型：ImageTextContextInfo[]
互动工具上下文列表。

CreateTime #

类型：number
互动工具的创建时间。Unix 时间戳，单位为毫秒。

ImageTextId #

类型：number
互动工具 ID。

IsDelete #

类型：boolean
互动工具是否已被删除。取值如下：

• true：已删除。
• false：未删除。

ImageTextContextInfo #

类型：interface
互动工具的详细信息。

ImageTextContext #

类型：string | undefined
互动工具的文本内容。

ImageTextType #

类型：number
互动工具的类型标识。用于区分是卡券、红包还是其他互动形式。

CouponContext #

类型：ActivityCouponInfo | undefined
卡券相关的上下文信息。

RedPacket #

类型：LuckymoneyRedPacketInfo | undefined
红包相关的上下文信息。

ActivityCouponInfo #

类型：interface
卡券的详细发放信息。包含发放规则、状态、时间限制等信息。

AllowCloseIcon #

类型：boolean
观看页的卡券图标是否支持关闭。默认值为 false。取值如下：

• true：支持。
• false：不支持。

Count #

类型：number
发放的卡券个数。取值为 -1 表示无限制。

Rule #

类型：number
领取卡券的截止时间。默认值为 0。取值如下：

• 0：无时间限制。卡券互动工具被发送至观看页后，观众可随时领取卡券。
• 1：卡券在手动停止发放前，均支持领取。
• 2：卡券互动工具被发送至观看页后的指定分钟数内，均支持领取卡券。
• 3：卡券在截止时间前，均支持领取。

Duration #

类型：number
倒计时。取值范围为 [1,300]。单位为分钟。

CutOffTime #

类型：number
定时截止时间。Unix 时间戳，单位为秒。

Status #

类型：CouponSendStatus
卡券发放状态。取值如下：

• 0：初始状态，尚未开始发放。
• 1：发放中，观众可领取。
• 2：已结束，卡券不可再领取。
• 3：已撤回。
• 4：已删除。

Id #

类型：number
卡券 ID。可以通过企业直播控制台或服务端 OpenAPI 获取。

PickupCount #

类型：number
卡券已被领取的数量。

SendTime #

类型：number
卡券发送时间。Unix 时间戳，单位为秒。

EndTime #

类型：number
卡券结束发送时间。Unix 时间戳，单位为秒。

PickupPeopleCount #

类型：number
已领取卡券的人数。

IsWatchLiveLimit #

类型：0 | 1
是否开启观看直播参与条件。默认值为 0。取值如下：

• 0：不开启。在卡券被发送至观看页后，观众可直接领取卡券，而无需先观看直播。
• 1：开启。在卡券被发送至观看页后，观众必须先观看直播，才能领取卡券。

IsViewerLevelLimit #

类型：0 | 1
是否开启观众等级参与条件。默认值为 0。取值如下：

• 0：不开启。卡券的领取不受观众等级限制。
• 1：开启。在卡券被发送至观看页后，满足观众等级条件的用户才能看见并领取卡券。

ViewerLevelConfigMetas #

类型：CouponViewerLevelMeta[] | undefined
可领取该卡券的观众等级配置列表。

Coupon #

类型：CouponBaseInfo | undefined
卡券基础信息。

SendCouponType #

类型：number | undefined
卡券发送方式。默认值为 0。取值如下：

• 0：手动发送。
• 1：定时发送。

AutoSendTime #

类型：number | undefined
定时发送卡券的时间。Unix 时间戳，单位为秒。

CouponSendStatus #

类型：enum
卡券发放状态。

CouponViewerLevelMeta #

类型：interface
观众等级配置的详细信息。

ViewerLevelConfigId #

类型：number
观众等级配置 ID。

ViewerLevelName #

类型：string
观众等级名称。

CouponBaseInfo #

类型：interface
卡券的基础描述信息。包含名称、描述、图片等信息。

Name #

类型：string
卡券名称。

Description #

类型：string
卡券描述。

ThirdPartyId #

类型：string
关联卡券 ID，即您自有商城系统中的卡券 ID。

Pic #

类型：string
卡券图片 URL。

Id #

类型：number
卡券 ID。

LuckymoneyRedPacketInfo #

类型：interface
红包详情信息。包含参与条件、领取限制、金额统计等信息。

AwardCondition #

类型：{ CheckIn?: string | undefined; Questionnaire?: string | undefined; Quiz?: string | undefined; RightQuiz?: string | undefined; Vote?: string | undefined; } | undefined
红包参与条件。定义了观众领取红包前需要完成的任务或满足的状态。
成员

BarragePwd #

类型：string | undefined
拆红包所需的弹幕口令。观众在聊天区域发送该口令后方可参与抢红包。

DeadLine #

类型：number | undefined
红包领取的截止时间。Unix 时间戳，单位为秒。

IsOpenSmsNotification #

类型：number | undefined
是否开启短信通知。取值如下：

• 0：未开启。
• 1：开启。

IsOpenWeChatWithdraw #

类型：number | undefined
是否开启微信提现。取值如下：

• 0：未开启。
• 1：开启。

JoinUserNumber #

类型：number | undefined
已参与抢红包的人数。

OpenRedPacketType #

类型：number | undefined
开奖方式。默认值为 0。取值如下：

• 0：自动开奖。
• 1：手动开奖。

RedPacketCoverImage #

类型：string | undefined
观看页展示的红包图标的 URL，包含协议头。

RedPacketID #

类型：number | undefined
红包 ID。

RedPacketNumber #

类型：number | undefined
红包个数。

RedPacketStatus #

类型：number | undefined
红包状态。取值如下：

• 0：初始化。
• 1：已发送。
• 2：开奖中。
• 3：开奖成功。
• 4：开奖失败。

RedPacketType #

类型：number | undefined
红包类型。取值如下：

• 0：现金红包。
• 1：积分红包。

RewardsPointsUnit #

类型：string | undefined
积分单位名称。例如“金币”、“积分”等。

SendTime #

类型：number | undefined
红包的发送时间。Unix 时间戳，单位为秒。

TotalAmount #

类型：number | undefined
红包总金额或总积分。取值如下：

• -1：红包总金额或总积分无限制
• 1-2000000：红包的总金额或总积分数

CouponPickUpStatusValue #

类型：enum
卡券领取接口返回状态。

CouponPickUpResponse #

类型：interface
卡券领取接口的完整响应对象。

Status #

类型：CouponPickUpStatusValue | undefined
接口请求的响应状态。取值与 CouponPickUpStatusValue 一致。

Message #

类型：string | undefined
接口返回的提示消息。

Datas #

类型：CouponPickUpResponseData[] | undefined
领取结果的数据列表。

CouponPickUpResponseData #

类型：interface
卡券领取操作的具体响应数据。

ActivityCouponId #

类型：number | undefined
卡券 ID。可以通过企业直播控制台或服务端 OpenAPI 获取。

PickupStatus #

类型：CouponPickUpStatusValue | undefined
观众领取卡券的状态。取值如下：

• 1：领取成功。
• 2：当前用户已领取成功。
• 3：卡券已被领完。
• 4：其他异常状态。
• 6：卡券已结束。
• 7：已达领取上限，不可重复领取。

PlayerRawPayload #

类型：interface
播放器原始事件透传负载。包含了小程序原生组件的所有属性。

PlayerNetworkInfo #

类型：interface
播放器相关的实时网络及质量信息。包含了码率、帧率及网络状态。

videoBitrate #

类型：number | undefined
当前视频编码的码率。单位为 kbps。

audioBitrate #

类型：number | undefined
当前音频编码的码率。单位为 kbps。

videoFPS #

类型：number | undefined
当前视频播放的帧率。单位为 FPS。

videoGOP #

类型：number | undefined
当前视频的关键帧间隔（GOP）。单位为秒。

netSpeed #

类型：number | undefined
当前网络的实时下载速率。单位为 KB/s。

netJitter #

类型：number | undefined
当前网络连接的抖动程度。单位为毫秒。

videoWidth #

类型：number | undefined
当前播放视频画面的宽度。单位为像素（px）。

videoHeight #

类型：number | undefined
当前播放视频画面的高度。单位为像素（px）。

SdkSystemInfo #

类型：interface
小程序 SDK 运行环境的系统信息。包含了设备、平台及用户授权状态。

brand #

类型：string | undefined
设备的品牌信息。

model #

类型：string | undefined
设备的型号信息。

pixelRatio #

类型：number | undefined
设备的像素比。

screenWidth #

类型：number | undefined
设备的屏幕物理宽度。单位为像素（px）。

screenHeight #

类型：number | undefined
设备的屏幕物理高度。单位为像素（px）。

windowWidth #

类型：number | undefined
当前小程序可使用的窗口宽度。单位为像素（px）。

windowHeight #

类型：number | undefined
当前小程序可使用的窗口高度。单位为像素（px）。

statusBarHeight #

类型：number | undefined
设备状态栏的高度。单位为像素（px）。

language #

类型：string | undefined
微信客户端设置的语言。

version #

类型：string | undefined
微信客户端的版本号。

system #

类型：string | undefined
设备操作系统的名称及版本号。

platform #

类型：string | undefined
客户端平台类型。

fontSizeSetting #

类型：number | undefined
用户在微信中设置的字体大小。

SDKVersion #

类型：string | undefined
小程序运行的基础库版本号。

benchmarkLevel #

类型：number | undefined
设备的性能等级。数值越大性能越好。

albumAuthorized #

类型：boolean | undefined
观众是否已授权小程序访问系统相册。取值如下：

• true：已授权。
• false：未授权。

cameraAuthorized #

类型：boolean | undefined
观众是否已授权小程序使用摄像头。取值如下：

• true：已授权。
• false：未授权。

locationAuthorized #

类型：boolean | undefined
观众是否已授权小程序使用定位信息。取值如下：

• true：已授权。
• false：未授权。

microphoneAuthorized #

类型：boolean | undefined
观众是否已授权小程序使用麦克风。取值如下：

• true：已授权。
• false：未授权。

notificationAuthorized #

类型：boolean | undefined
观众是否已授权小程序发送系统通知。取值如下：

• true：已授权。
• false：未授权。

bluetoothEnabled #

类型：boolean | undefined
设备的蓝牙功能是否已开启。取值如下：

• true：已开启。
• false：未开启。

locationEnabled #

类型：boolean | undefined
设备的定位服务（GPS）是否已开启。取值如下：

• true：已开启。
• false：未开启。

wifiEnabled #

类型：boolean | undefined
设备的 Wi-Fi 功能是否已开启。取值如下：

• true：已开启。
• false：未开启。

safeArea #

类型：{ left?: number | undefined; right?: number | undefined; top?: number | undefined; bottom?: number | undefined; width?: number | undefined; height?: number | undefined; } | undefined
小程序页面的安全区域边界坐标。坐标系以屏幕左上角为原点，单位为像素（px）。
成员