token

string

是

不适用

用户进入直播间时的授权 Token。token 与 signToken 至少需传入其中一个参数；当两者同时传入时，以 signToken 为准。不同鉴权模式（mode）下，token 的获取方式不同：

• mode 取值为 1 时，您可通过调用 GetSDKTokenAPI 接口获取用户 Token，也可以在企业直播控制台直播间内的观看页管理 > 页面嵌入 > Web SDK嵌入中获取用户 Token。
• mode 取值为 2 时，您可通过调用 GetSDKTokenAPI 接口获取用户 Token。

mode

1 | 2

否

1

鉴权模式。取值如下：

• 1：公开模式。观众以游客身份进入直播间，在点击评论输入框或参与抽奖等需要用户信息的场景下，需要先完成游客注册（即输入昵称或通过手机号登录直播间）。
• 2：自定义模式。观众在进入直播间时使用的是在您 Web 应用内的用户信息，因此可以直接发送评论、参与抽奖等。

options

Partial<baseOptions> | Partial<playerOptions>

否

-

可选配置项。

mode

string

是

不适用

模块名称。取值如下：

• player：播放器模块。PC 端建议最小宽度为 640 px。
• menu ：菜单模块。支持聊天互动、图文介绍、商品卡片、互动工具、互动问答、内嵌链接、邀请榜单菜单。支持渲染多个菜单类型。PC 端建议最小宽度为 320 px。

• lines：多线路模块。高度自适应，您无需指定高度。
• mobile：移动端横屏模式整页模块。已组装播放器、多线路和菜单模块。仅支持移动端，不支持与其他模块共用。查看 Demo 效果。
• mobile-portrait：移动端竖屏模式整页模块。已组装播放器、多线路和菜单模块。仅支持移动端，类似于抖音直播的竖屏直播场景，不支持与其他模块共用。查看 Demo 效果。

menu

string[]

否

无

显示的菜单类型。例如设置参数值为 ["comment", "imagetext"]，显示聊天互动和互动工具菜单。默认显示所有菜单类型。仅在 modules.mode=menu 或移动端横屏整页 modules.mode=mobile 时生效。取值如下：

• comment：聊天互动菜单。
• imagetext：互动工具菜单。
• cardlist：商品卡片菜单。
• bandcontent：图文介绍菜单。
• session：互动问答菜单。
• embeddedurl：内嵌链接菜单。
• invitelist：邀请榜单菜单。

pcPlayerHeader

boolean

是

false

PC 端播放器上方是否展示直播名称、描述等信息。取值如下：

• true：展示。
• false：不展示。

disabledLogin

boolean

否

false

是否禁用企业直播自带的登录体系。通常配合 permission.need 事件使用，禁用后您需自行处理用户登录流程。取值如下：

• true：禁用。
• false：不禁用。

disableModifyNickname

boolean

否

false

是否禁用企业直播自带的昵称修改功能。通常配合 nickname.modify 事件使用，禁用后您需自定义昵称修改弹窗。取值如下：

• true：禁用。
• false：不禁用。

saveUserInfo

boolean

是

true

mode 取值为 1 时，是否缓存用户信息。取值如下：

• true：缓存。
• false：不缓存。

mobileBackgroundTransparent

boolean

否

false

移动端背景是否透明。取值如下：

• true：透明，展示自有页面的背景图或背景色。
• false：不透明。

enableMobileBackgroundImage

boolean

否

false

移动端是否展示背景图。只在整页模式下生效。取值如下：

• true：展示背景图。
• false：不展示背景图。

mobileGetUserId

boolean

是

true

是否开启快速获取移动端用户 ID 的入口。开启后在页面左上角快速点击 5 次即可获取用户 ID。取值如下：

• true：开启。
• false：不开启。

basicPolling

boolean

是

true

是否开启轮询 API 实时更新直播间信息。取值如下：

• true：开启。
• false：不开启。

useGetPolling

boolean

否

false

是否使用 GET 方式请求消息轮询接口（该接口用于短链轮询拉取评论、图文消息、热门评论等数据）。默认使用 POST 请求；仅在特殊情况需要兼容时设为 true。取值如下：

• true：使用 GET 请求。
• false：使用 POST 请求。

disableCardRedirect

boolean

否

false

是否禁用商品卡片点击跳转能力。禁用后，观众点击商品卡片时，SDK 仍会触发商品详情点击事件（productdetail.click）、商品购买点击事件（productpurchase.click）、商品卡片点击事件（card.click）和浮窗商品卡片点击事件（floatingCard.click），但不再执行默认打开，您需自行处理跳转。取值如下：

• true：禁用。
• false：不禁用。

disableProductDetailRedirect

boolean

否

false

是否禁用商品详情入口默认跳转能力。禁用后，观众点击商品图、商品名称、商品价格等商品信息区域时，SDK 仍会触发商品详情点击事件（productdetail.click），但不再执行默认打开，您需自行处理跳转。取值如下：

• true：禁用。
• false：不禁用。

disableProductPurchaseRedirect

boolean

否

false

是否禁用商品跳转图（RedirectImage）的默认跳转能力。禁用后，观众点击跳转图时，SDK 仍会触发商品购买点击事件（productpurchase.click），但不再执行默认打开，您需自行处理跳转。取值如下：

• true：禁用。
• false：不禁用。

disableProductAddCartRedirect

boolean

否

false

是否禁用加入购物车入口默认跳转能力。禁用后，观众点击商品的加购图标时，SDK 仍会触发加入购物车点击事件（productaddcart.click），但不再执行默认打开，您需自行处理跳转。取值如下：

• true：禁用。
• false：不禁用。

disableProductCartRedirect

boolean

否

false

是否禁用查看购物车入口默认跳转能力。禁用后，观众点击导航栏的购物车图标时，SDK 仍会触发查看购物车点击事件（productcart.click），但不再执行默认打开。取值如下：

• true：禁用。
• false：不禁用。

disableProductOrderRedirect

boolean

否

false

是否禁用查看订单入口默认跳转能力。禁用后，观众点击导航栏的订单图标时，SDK 仍会触发查看订单点击事件（productorder.click），但不再执行默认打开。取值如下：

• true：禁用。
• false：不禁用。

disableAdFloatingRedirect

boolean

否

false

是否禁用浮标广告点击跳转能力。通常配合 adFloating.click 事件使用，禁用后您需自行处理跳转功能。取值如下：

• true：禁用。
• false：不禁用。

disableAdMiddleRedirect

boolean

否

false

是否禁用页中广告点击跳转能力。通常配合 adMiddle.click 事件使用，禁用后您需自行处理跳转功能。取值如下：

• true：禁用。
• false：不禁用。

disableAdHeaderRedirect

boolean

否

false

是否禁用页头广告点击跳转能力。通常配合 adHeader.click 事件使用，禁用后您需自行处理跳转功能。取值如下：

• true：禁用。
• false：不禁用。

disableCoupon

boolean

否

false

是否禁用卡券领取弹窗。通常配合 coupon.click 事件使用，禁用后您需自行处理卡券弹窗及领取功能。取值如下：

• true：禁用。
• false：不禁用。

disableAdAccountRedirect

boolean

否

false

是否禁用主播账号点击跳转能力。通常配合 adAccount.click 事件使用，禁用后您需自行处理跳转功能。取值如下：

• true：禁用。
• false：不禁用。

moreActionExpandPc

boolean

否

false

是否在 PC 端聊天互动菜单下将更多图标内的选项作为图标展示。取值如下：

• true：作为图标展示。
• false：不作为图标展示。

disableReservationCell

boolean

否

false

是否禁用预约弹窗。通常配合 reservation.click 事件使用。禁用后您需自行处理用户预约功能，即通过 isReserved 参数设置用户是否已预约并调用 updateModulesConf 方法更新预约状态。取值如下：

• true：禁用。
• false：不禁用。

isReserved

boolean

否

无

用户是否已预约。取值如下：

• true：已预约。
• false：未预约。

riskWarning

boolean

是

true

是否开启风险提示。取值如下：

• true：开启。
• false：不开启。

disableLotteryTicketRedirect

boolean

否

false

是否禁用抽奖的奖券奖品点击跳转能力。通常配合 lotteryTicket.click 事件使用，禁用后您需自行处理跳转功能。取值如下：

• true：禁用。
• false：不禁用。

loginInToThumbUp

boolean

否

false

是否必须登录才能点赞直播间。取值如下：

• true：必须登录。如观众在未登录状态点赞直播间，会触发 permission.need 事件。
• false：无需登录。

disableFeatureProcess

boolean | string[]

否

false

在观众点击互动功能按钮后，是否阻止功能的后续执行。取值如下：

• true：阻止所有互动功能的后续执行。
• false：不阻止任何互动功能的后续执行。
• String[]：阻止指定互动功能的后续执行。例如设置参数值为 ['Comment','Gift']，阻止评论功能和礼物打赏功能的后续执行。

支持阻止以下互动功能的后续执行：

• Comment：评论功能。
• Gift：礼物打赏功能。
• Lottery：实时抽奖功能。
• Thumb：评论点赞功能。
• Luckymoney：红包功能。
• Reservation：直播预约功能。
• Question：互动问答功能。
• CheckIn：签到功能。
• Vote：投票功能。
• Questionnaire：问卷功能。
• TaskAward：累计观看抽奖功能。
• Coupon：卡券功能。
• LiveBonus：福利任务功能。
• Share：直播分享功能。

useUserConnect

boolean

否

false

是否强制展示移动端连麦入口。取值如下：

• true：强制展示。
• false：不强制展示。

hideUserConnect

boolean

否

false

是否强制隐藏移动端连麦入口。取值如下：

• true：强制隐藏。
• false：不强制隐藏。

preloadQuestionnaireAttended

boolean

否

无

是否禁止弹出发送时机为进入直播时的问卷。取值如下：

• true：禁止。
• false：不禁止。

disableOfflineModal

boolean

否

无

是否禁止弹出多端登录踢出弹窗。取值如下：

• true：禁止。
• false：不禁止。

多端登录踢出弹窗如下所示：

disabledCommentConfig

{ disabled: boolean; placeholder?: string; }

否

无

设置是否禁用评论输入框，以及禁用后的评论输入框提示文字。

• disabled：是否禁用评论输入框。取值如下：
  • true：禁用。禁用后，观众点击评论输入框，无法输入内容。
  • false：不禁用。
• placeholder：禁用后的评论输入框提示文字。

alwaysShowFloatingIcons

boolean

否

false

当移动端横屏直播间内无聊天互动菜单时，是否展示浮窗商品卡片以及互动工具浮窗。取值如下：

• true：在左侧第一个菜单下展示。
• false：不展示。

disableCommentPopup

boolean

否

false

是否禁用聊天互动菜单下的聊天回复弹窗。取值如下:

• true：禁用。PC端观众右键单击聊天或移动端观众点击昵称时,不再弹出聊天回复弹窗。观众无法回复、举报聊天等。
• false：不禁用。

disabledShopCartClick

boolean

否

false

设置是否禁用购物车点击。取值如下：

• true：禁用购物车点击。禁用后，观众单击购物车图标时，不再弹出商品列表。
• false：不禁用。

disabledShowExplainCard

boolean

否

false

设置是否禁止标记了商品讲解的商品卡片以浮窗形式展示在观看页。取值如下：

• true：禁止。禁止后，即使商品卡片标记了商品讲解，也不会展示在观看页。
• false：不禁止。

disabledShowOrderMsg

boolean

否

false

设置是否禁用默认展示的下单消息，包括查看商品消息和下单购买消息。取值如下：

• true：禁用。禁用后，观看页将不再展示直播间的下单消息。
• false：不禁用。

disableOrderMessageClick

boolean

否

false

设置是否禁用默认下单消息（包括查看商品消息和下单购买消息）的点击跳转行为。取值如下：

• true：禁用。禁用后，用户点击下单消息（包括查看商品消息和下单购买消息）不会触发默认跳转逻辑，而是会触发 orderMsg.click 事件。您需配合 orderMsg.click 事件自定义跳转链接。
• false：不禁用。

disableCheckInUI

boolean

否

false

是否禁用签到弹窗。取值如下：

• true：禁用。禁用后将不会弹出签到弹窗。
• false：不禁用。

disableLotteryUI

boolean

否

false

是否禁用抽奖弹窗。取值如下：

• true：禁用。禁用后观看页将不会弹出抽奖弹窗、抽奖结果弹窗以及开奖动画，您需配合award.receive事件自定义抽奖相关弹窗和动画。
• false：不禁用。

independentConnectRenderDomId

string

否

无

独立挂载连麦功能的 DOM 标识符。若您在进行模块配置时，仅引入了播放器模块，您可使用该参数引入连麦功能。

mainWindowContainerClassName

string

否

无

连麦主画面容器附加的 className。用于通过 CSS 自定义背景等样式覆盖。

使用示例：

• （可选）若您在初始化进行模块配置时，仅引入了播放器模块，您需在 HTML 中指定承载连麦功能的 DOM 容器：

<div id="player"></div>
<div id="connect"></div>

• 初始化 SDK：

const webSDK = new window.ByteLiveWebSDK({
token: 'YOUR_TOKEN',
activityId: 123456,
mode: 1,
modules: [
{
id: "player",
mode: "player",
},
],
options: {
// （可选）若您仅引入了播放器模块，您需使用该参数引入连麦功能
independentConnectRenderDomId: 'connect',
userConnectConfig: {
// 自定义连麦图标
buttonIcon: 'https://example.com/connect-icon.svg',
// 自定义连麦主画面样式类名
mainWindowContainerClassName: 'custom-connect-container',
},
},
});

• 自定义 CSS 样式，样式类名与 mainWindowContainerClassName 参数值保持一致：

.custom-connect-container {
background-image: url('https://example.com/connect-bg.png');
}

key

string

是

无

在移动端横屏直播间，右下方的互动工具浮窗的唯一标识。不带 SYS: 前缀时，表示新增一个外部自定义图标；使用 SYS: 前缀时，表示控制系统预设的内置图标。支持以下两类取值：

• 'SYS:LOTTERY'：系统抽奖图标。
• 'SYS:LUCKMONEY'：系统红包图标。
• 'SYS:QUESTION'：系统问答图标。
• 'SYS:IMAGE'：系统互动图片图标。
• 'SYS:VOTE'：系统投票图标。
• 'SYS:DOCUMENT'：系统文档图标。
• 'SYS:QUESTIONNAIRE'：系统问卷图标。
• 'SYS:CHECKIN'：系统签到图标。
• 'SYS:ANNOUNCEMENT'：系统公告图标。
• 'SYS:COUPON'：系统卡券图标。
• 'SYS:LIVEBONUS'：系统福利任务图标。

visible

boolean

否

true

互动工具浮窗是否展示。取值如下：

• true：展示互动工具浮窗。
• false：隐藏互动工具浮窗，且不占据 HTML 空间。

key

string

是

无

在移动端竖屏直播间上方，互动工具浮窗图标的唯一标识。当前支持对以下浮窗图标设置显示或隐藏：

• SYS:COUPON：系统卡券图标。
• SYS:LIVEBONUS：系统福利任务图标。

visible

boolean

否

true

是否显示该图标。取值如下：

• true：显示。
• false：隐藏，不占据 HTML 空间。

disableProgressSeek

boolean

否

false

是否禁用用户通过进度条调整点播播放位置。取值如下：

• true：禁用。仅保留进度条展示，禁止用户在 PC 或移动端点击、拖拽进度条。
• false：不禁用。用户可以点击或拖拽进度条进行跳转播放。

disablePlaybackRate

boolean

否

false

是否禁用用户调整点播播放倍速。取值如下：

• true：禁用。隐藏调整倍速的入口，用户无法通过播放器 UI 调整播放倍速。
• false：不禁用。用户可以通过播放器 UI 调整播放倍速。

videoFillMode

string

否

auto

播放器内视频的填充方式。取值如下：

• cover：保持视频原有宽高比例填充播放器，视频的宽高会填满播放器的宽高。如果视频宽高比与播放器宽高比不同，会有部分视频内容被裁剪掉。
• auto：保持视频原有宽高比例填充播放器，视频的宽高会填满播放器的宽高。如果视频宽高比与播放器宽高比不同，视频会缩放显示。
• fill：视频内容完全填充播放器，但视频宽高比可能发生变化。
• fillWidth：拉伸视频宽度填满播放器宽度，视频高度不变。
• fillHeight：拉伸视频高度填满播放器高度，视频宽度不变。

该参数仅对 PC 端和移动端横屏模式生效。
移动端竖屏模式视频的填充方式根据源流画面宽高比的不同而有所不同。效果详见竖屏直播间。

purePlayer

boolean

否

false

是否展示纯净播放器。纯净播放器指播放器内无进度条等互动按钮。取值如下：

• true：展示纯净播放器（播放器内无进度条等互动按钮）。
• false：展示常规播放器。

playerBackgroundTransparent

boolean

是

false

播放器内未被画面填充部分的颜色是否为透明。取值如下：

• true：透明，显示为直播封面。
• false：不透明，显示为黑色。

disablePlayerCover

boolean

是

false

是否禁用直播封面。取值如下：

• true：禁用直播封面，即显示为观看页面的背景图或背景色。
• false：不禁用直播封面。

mobilePlayerIconIgnoreList

string[]

是

无

在移动端观看页的播放器上隐藏的功能入口。例如设置参数值为 ["language", "share"]，隐藏切换语言和分享功能的入口。取值如下：

• editNickname：修改昵称。
• notification：开启或关闭互动特效。
• language：切换语言。
• share：分享。

landscapePlayerIcons

LandscapePlayerIconConf[]

否

-

移动端横屏播放器中系统功能入口的展示配置。可按系统入口配置其展示位置、显隐和同一位置内的顺序；未配置的入口继续使用默认展示规则，并兼容 mobilePlayerIconIgnoreList、playerConf.definitionV2 和 playerConf.playbackrateV2 等旧配置。

使用示例：

const webSDK = new window.ByteLiveWebSDK({
// activityId、token、service、modules 等省略
options: {
landscapePlayerIcons: [
{
// 将清晰度切换入口展示在顶部控制区，排序值为 10。
key: 'SYS:DEFINITION_SWITCH',
visible: true,
placement: 'top',
index: 10,
},
{
// 将倍速切换入口展示在底部控制区，排序值为 20。
key: 'SYS:PLAYBACKRATE_SWITCH',
visible: true,
placement: 'bottom',
index: 20,
},
{
// 隐藏分享入口。
key: 'SYS:SHARE',
visible: false,
},
],
},
});

showChatInputCloseButton

boolean

否

false

在移动端横屏直播间中，是否在聊天互动输入框的输入状态下，展示关闭按钮。取值如下：

• true：展示关闭按钮，用户可点击按钮退出输入态。
• false：不展示关闭按钮。

mobileGesture

MobileGesture

是

-

移动端播放器手势相关配置。

showLikeInPlayer

boolean

否

false

是否将直播间点赞图标显示在播放器内。取值如下：

• true：显示在播放器内。默认显示在播放器右下角，您可以通过覆盖 class 属性 bytelive-player-like-button 的样式调整图标位置。
• false：显示在评论区输入框右侧。

disableRotateFullscreen

boolean

否

false

是否禁用移动端旋转至横屏时会自动进入全屏模式。取值如下：

• true：禁用，旋转至横屏时不会自动进入全屏模式且不会有提示。
• false：不禁用。

disableLivePauseButton

boolean

否

false

是否在直播期间隐藏播放器上的暂停按钮。取值如下：

• true：隐藏。
• false：不隐藏。

rotateFullscreen

boolean

否

false

移动端 iOS 进入全屏模式后，视频是否自动切换为横屏播放。取值如下：

• true：视频自动切换为横屏播放。
• false：视频根据设备朝向横屏或竖屏播放。

rotateFullscreenForAndroid

boolean

否

false

移动端 Android 进入全屏模式后，视频是否自动切换为横屏播放。取值如下：

• true：视频自动切换为横屏播放。
• false：视频根据设备朝向横屏或竖屏播放。

fullscreenTarget

HTMLElement | "video"

否

无

播放器全屏模式的容器元素。默认不传时，使用播放器 root 元素。取值如下：

• 自定义 HTMLElement：传入一个自定义的 DOM 元素作为全屏容器。
• 'video'：仅使视频画面区域进入全屏。

watermarkConfig

WatermarkConfig

否

-

点播播放器的全屏水印。

tickerConfig

TickerConfig

否

-

点播播放器的跑马灯。

keepPlayWhenPageHide

boolean

否

false

页面隐藏时是否保持视频播放。取值如下：

• true：页面隐藏时保持视频播放，不注册页面隐藏时的暂停插件。
• false：页面隐藏时暂停视频播放。

softSolution

boolean

否

无

是否在移动端强制开启或关闭播放器软解解码直播视频。开启软解后可解决移动端部分浏览器或 App 下播放器被劫持的问题。取值如下：

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

autoplayFailedIcon

boolean

否

true

自动播放失败后，是否展示点击播放按钮。取值如下：

• true：展示点击播放按钮。
  
• false：展示播放图标。
  

disablePlayer

boolean

否

false

是否禁用播放器。取值如下：

• true：禁用播放器。
• false：初始化播放器。

isVodMsgOpen

boolean

否

false

是否开启回放中弹幕消息的透传，同时禁用播放器的弹幕渲染功能。取值如下：

• true：开启。开启后，SDK 将通过 im.playback.message 事件发送回放视频中的弹幕数据，而不在播放器画面上渲染弹幕。
• false：关闭。SDK 将在播放器页面上直接渲染弹幕。

key

string

是

无

图标或按钮的唯一标识。支持以下两类取值：

• 任意字符串：表示自定义图标或按钮的 key。
• SYS:*：表示系统预设的图标或按钮 key。具体枚举如下：
  • SYS:HEART：点赞图标。默认 index：5
  • SYS:GIFT：礼物图标。默认 index：15
  • SYS:CART：购物车图标。默认 index：10
  • SYS:IMAGE_MENU：图文介绍图标。默认 index：35
  • SYS:IMAGETEXT_LIVE：互动工具图标。默认 index：25
  • SYS:SHARE：分享图标。默认 index：45
  • SYS:NOTIFICATION_SWITCH：通知开关图标。默认 index：70
  • SYS:NICKNAME_MODIFY：昵称修改图标。默认 index：80
  • SYS:LANGUAGE_SWITCH：语言切换图标。默认 index：90
  • SYS:SCREEN_CLEAN：清屏图标。默认 index：100
  • SYS:CANCEL_SCREEN_CLEAN：取消清屏图标。默认 index：100
  • SYS:DEFINITION_SWITCH：清晰度图标。默认 index：95
  • SYS:PLAYBACKRATE_SWITCH：播放速度切换图标。默认 index：95
  • SYS:GIFT_SWITCH：礼物开关图标。默认 index：71
  • SYS:EMBEDDED_URL：内嵌链接图标。默认 index：40
  • SYS:CONNECT：申请连麦图标。
  • SYS:PRIVATE_CHAT：私聊互动图标。默认 index：30
  • SYS:USERCREDIT：表扬点赞图标。默认 index：50
  • SYS:REPORT_ACTIVITY：举报图标。默认 index：100
  • SYS:VIDEO_UNDERSTANDING：AI 总结图标。默认 index：75

visible

boolean

否

true

是否显示该图标或按钮。取值如下：

• true：显示。
• false：隐藏，不占据 HTML 空间。

onFailed

(reason: string) => void

否

无

当创建失败时触发的回调。
参数 reason 为失败原因。当前预设值如下：

• unsupported_mode：当前不是移动端横屏直播间，无法插入动态菜单页签。
• invalid_name：name 为空或不是有效字符串。
• invalid_key：key 为空或不是有效字符串。
• invalid_index：index 不是有效数字。
• invalid_tab_pane_root_element：tabPaneRootElement 非法，仅支持 #id 格式。
• duplicate_key：key 与已有动态菜单页签重复。
• duplicate_tab_pane_root_element：tabPaneRootElement 或对应根节点已存在。
• create_tab_pane_root_element_failed：创建或挂载 TabPane 根节点失败。

key

string

是

无

系统功能入口的唯一标识。同一 key 重复配置时，后面的配置生效。取值如下：

• SYS:SUBTITLE_SWITCH：字幕切换入口。
• SYS:SHARE：分享入口。
• SYS:LINE_SWITCH：频道切换入口。
• SYS:LANGUAGE_SWITCH：语言切换入口。
• SYS:DEFINITION_SWITCH：清晰度切换入口。
• SYS:PLAYBACKRATE_SWITCH：倍速切换入口。
• SYS:NICKNAME_MODIFY：昵称修改入口。
• SYS:GIFT_SWITCH：礼物特效开关入口。
• SYS:NOTIFICATION_SWITCH：互动特效开关入口。
• SYS:FEEDBACK：帮助反馈入口。
• SYS:REPORT_ACTIVITY：举报直播间入口。

visible

boolean

否

true

是否允许展示该系统功能入口。设置为 true 时仍需确保直播间能力、状态、权限、纯播放器模式和播放器就绪等条件。取值如下：

• true：允许在满足上述条件时展示该入口。
• false：不展示该入口。

placement

string

否

无

展示位置。未配置时使用系统默认展示位置。取值如下：

• bottom：底部控制区。底部控制区按 index 排序后最多展示前 2 个入口，超出的入口收入顶部更多面板。
• top：顶部控制区。顶部控制区按 index 排序后最多展示前 2 个入口，超出的入口收入顶部更多面板。
• topMore：顶部更多面板。

key

string

是

无

图标的唯一标识。支持以下两类取值：

• 任意字符串：表示自定义图标 key。
• SYS:*：表示预设系统图标 key。系统图标枚举如下：
  • SYS:GIFT：礼物图标。
  • SYS:USERCREDIT：表扬图标。
  • SYS:CART：购物车图标。
  • SYS:THUMBS：点赞图标。

visible

boolean

否

true

是否显示该图标。取值如下：

• true：显示。
• false：隐藏，不占用 HTML 空间。

disableGesture

boolean

否

false

是否禁用移动端手势。禁用后，观众无法通过左右滑动预告或回放画面来拖动进度条。取值如下：

• true：禁用
• false：不禁用

closeVideoDblclick

boolean

否

false

• PC 端：是否禁用在双击播放器时，进入全屏模式。取值如下：
  • true：禁用。双击播放器，不会进入全屏模式。
  • false：不禁用。双击播放器，进入全屏模式。
• 移动端：是否禁用在双击播放器时，暂停或播放直播或点播内容。取值如下：
  • true：禁用。双击播放器，不会暂停或播放直播或点播内容。
  • false：不禁用。双击播放器，暂停或播放直播或点播内容。

ignores

string[]

否

无

在观看页的播放器上隐藏的内置插件。取值如下：

• play：播放和暂停按钮。
• replay：重播按钮。
• refresh：刷新按钮。
• pip：进入和退出画中画模式按钮。
• sdkerrorplugin：错误页面。
• controls：播放器控制栏。
• loading：loading 动画。
• playnext：播放下一个按钮。
• fullscreen：进入和退出全屏按钮。
• volume：音量按钮。

例如设置参数值为['play','pip','replay'] ，则观看页的播放器上不显示播放和暂停按钮、进入和退出画中画模式按钮和重播按钮。

closeVideoClick

boolean

否

false

是否禁用在 PC 端单击播放器时，暂停或播放直播或点播内容。取值如下：

• true：禁用。单击播放器，不会暂停或播放直播或点播内容。
• false：不禁用。单击播放器，暂停或播放直播或点播内容。

showCursorOverPlayer

boolean

否

false

是否在播放器进入非活跃（inactive 状态）后，仍显示鼠标光标。取值如下：

• true：显示。播放器进入非活跃状态后，鼠标光标仍显示在播放器区域内。
• false：不显示。保持播放器默认行为，进入非活跃状态后隐藏鼠标光标。

controls

{ autoHide?: boolean; mode?: 'normal' | 'flex' | 'bottom'; initShow?: boolean; }

否

autoHide：true；mode：flex；initShow：false

播放器控制栏相关配置。例如播放和暂停按钮、进入和退出全屏按钮和音量按钮等。

• autoHide：是否自动隐藏播放器控制栏。取值如下：
  • true：隐藏。
  • false：不隐藏。
• mode：播放器控制栏的布局方式。取值如下：
  • normal：播放按钮分布于左右两边，进度条位于顶部。
  • flex：两侧播放按钮和进度条呈三排布局。
  • bottom：播放按钮分布于左右两边，进度条位于底部。
• initShow：是否在播放器初始化时，显示播放器控制栏。取值如下：
  • true：显示。在播放器初始化时，显示播放器控制栏。
  • false：不显示。在播放器开始播放直播或点播内容后，显示播放器控制栏。

modules

Module[]

否

[{mode: 'player', id: 'bytelive-default-player'}]

模块配置。不配置，则默认创建一个页面元素 ID 为 bytelive-default-player 的播放器模块。
支持以下参数：

• id：页面元素 ID，指定模块需要渲染的位置和大小。
• mode：模块名称。取值固定为 player，即播放器模块。PC 端建议最小宽度为 640 px。