token

string

是

不适用

用户 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 时生效。取值如下：

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

pcPlayerHeader

boolean

是

false

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

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

disabledLogin

boolean

否

false

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

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

saveUserInfo

boolean

是

true

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

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

mobileBackgroundTransparent

boolean

否

false

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

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

mobileGetUserId

boolean

是

true

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

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

basicPolling

boolean

是

true

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

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

disableCardRedirect

boolean

否

false

是否禁用商品卡片点击跳转能力。通常配合 card.click 或 floatingcard.click 事件使用，禁用后您需自行处理跳转功能。取值如下：

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

disableAdFloatingRedirect

boolean

否

false

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

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

disableAdMiddleRedirect

boolean

否

false

是否禁用页中广告点击跳转能力。通常配合 adMiddle.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：累计观看抽奖功能。

useUserConnect

boolean

否

false

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

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

hideUserConnect

boolean

否

false

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

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

preloadQuestionnaireAttended

boolean

否

无

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

• true：禁止
• false：不禁止

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：分享。

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：视频根据设备朝向横屏或竖屏播放。

watermarkConfig

WatermarkConfig

否

-

点播播放器的全屏水印。

tickerConfig

TickerConfig

否

-

点播播放器的跑马灯。

softSolution

boolean

否

无

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

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

autoplayFailedIcon

boolean

否

true

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

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

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：不禁用。单击播放器，暂停或播放直播或点播内容。

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。