配置参数--企业直播-火山引擎

文档中心

导航

配置参数

最近更新时间：2024.11.27 10:41:06首次发布时间：2024.11.27 10:41:06

您可在嵌入链接中，拼接以下参数，实现指定功能。
示例如下所示。

<iframe src="https://live.byteoc.com/5528/37****9?platform=pc"></iframe>

基础参数

配置项	类型	是否必选	默认值	说明
platform	string	否	无	展示嵌入页面的平台。如不传该参数，则根据观众的设备进行判断，PC 端进入嵌入页面则以 PC 端展示，移动端进入嵌入页面则以移动端展示。取值如下： `pc`：PC 端。 `mobile`：移动端。
mode	string	否	无	功能模块，适用于非整页嵌入的场景。取值如下： `player`：播放器。 `comment`：聊天互动菜单（包含热门评论列表）。 `imagetext`：互动工具菜单。 `bandcontent`：图文介绍菜单。 `cardlist`：商品卡片菜单。 `polylive`：聚合直播菜单。 `session`：互动问答菜单。 `menu`：多个菜单的组合，需配合 `menu` 参数使用。说明嵌入指定菜单时，请确保已在控制台或通过服务端 OpenAPI 启用对应菜单。其中，互动工具菜单还应确保已开启显示菜单栏开关。
menu	string	否	无	需要嵌入的菜单组合，仅在 `mode`取值为 `menu` 时生效。参数值之间使用下划线（_）分隔，例如 `menu=comment_imagetext`。取值如下： `comment`：聊天互动菜单（包含热门评论列表）。 `imagetext`：互动工具菜单。 `bandcontent`：图文介绍菜单。 `cardlist`：商品卡片菜单。 `polylive`：聚合直播菜单。 `session`：互动问答菜单。

配置项

类型

是否必选

默认值

说明

platform

string

否

无

展示嵌入页面的平台。如不传该参数，则根据观众的设备进行判断，PC 端进入嵌入页面则以 PC 端展示，移动端进入嵌入页面则以移动端展示。
取值如下：

pc：PC 端。
mobile：移动端。

mode

string

否

无

功能模块，适用于非整页嵌入的场景。取值如下：

player：播放器。
comment：聊天互动菜单（包含热门评论列表）。
imagetext：互动工具菜单。
bandcontent：图文介绍菜单。
cardlist：商品卡片菜单。
polylive：聚合直播菜单。
session：互动问答菜单。
menu：多个菜单的组合，需配合 menu 参数使用。

说明

嵌入指定菜单时，请确保已在控制台或通过服务端 OpenAPI 启用对应菜单。其中，互动工具菜单还应确保已开启显示菜单栏开关。

string

否

无

需要嵌入的菜单组合，仅在 mode取值为 menu 时生效。参数值之间使用下划线（_）分隔，例如 menu=comment_imagetext。
取值如下：

comment：聊天互动菜单（包含热门评论列表）。
imagetext：互动工具菜单。
bandcontent：图文介绍菜单。
cardlist：商品卡片菜单。
polylive：聚合直播菜单。
session：互动问答菜单。

非播放器相关参数

配置项	类型	是否必选	默认值	说明
tabTitle	boolean	否	`true`	是否展示菜单栏。取值如下： `true`：展示。 `false`：不展示，仅展示菜单下的具体内容。建议在嵌入页面仅展示一个菜单时，再将参数值设置为 `false`，以免影响菜单内容的展示。
portrait	integer	否	不适用	仅在以移动端竖屏模式展示嵌入页面时，传入该参数。参数取值固定为 `1`。该参数仅在 `platform` 取值为 `mobile`，且整页嵌入时生效。
background	string	否	不适用	仅在需要将背景色设置为透明时，传入该参数。参数取值固定为 `transparent`。
language	string	否	`all`	嵌入页面的默认语言。取值如下： `all`：与 PC 端浏览器默认语言或移动端系统语言一致。 `cn`：简体中文。 `en`：英文。 `jp`：日文。说明确保在控制台设置了多种对应的观看页语言。取值为 `all` 时：如果控制台未设置简体中文为观看页语言，但浏览器默认语言或系统语言为简体中文，则嵌入页面默认语言为简体中文。如果浏览器默认语言或系统语言不是控制台设置或支持的语言，则嵌入页面默认语言为英文。
customAuthRedirect	boolean	否	`true`	是否允许观众跳转到您的自有账号系统登录页面。该参数仅在评论限制设置为自定义时生效。取值如下： `true`：允许。 `false`：不允许。您需自行处理跳转功能。
pcPlayerHeader	boolean	否	`false`	PC 端播放器上方是否展示直播名称、描述等信息。取值如下： `true`：展示。 `false`：不展示。
mobileBackgroundTransparent	boolean	否	`false`	移动端背景是否透明。取值如下： `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 事件使用。禁用后您需自行处理用户预约功能。取值如下： `true`：禁用。 `false`：不禁用。
disableLotteryTicketRedirect	boolean	否	`false`	是否禁用抽奖的奖券奖品点击跳转能力。通常配合 lotteryTicket.click 事件使用，禁用后您需自行处理跳转功能。取值如下： `true`：禁用。 `false`：不禁用。
loginInToThumbUp	boolean	否	`false`	是否必须登录才能点赞直播间。取值如下： `true`：必须登录。如观众在未登录状态点赞直播间，会触发登录流程。 `false`：无需登录。
useUserConnect	boolean	否	`false`	是否强制展示移动端连麦入口。取值如下： `true`：强制展示。 `false`：不强制展示。说明连麦功能使用了 WebRTC 技术，由于该技术的兼容性限制，仅在观众使用以下操作系统和浏览器时，默认展示移动端连麦入口。如需强制展示移动端连麦入口，可将参数值设置为 `true`。操作系统：Android 10 以上或 iOS 14.3 以上。浏览器：Google Chrome（Android 版本 78.0 以上、iOS 版本 86.0.4240 以上）、Safari 14 以上或微信内嵌浏览器。为保证连麦质量，如果观众使用的操作系统和浏览器不符合以上要求，推荐您在强制展示移动端连麦入口前，测试连麦功能在不同操作系统和浏览器下的表现。
hideUserConnect	boolean	否	`false`	是否强制隐藏移动端连麦入口。取值如下： `true`：强制隐藏。 `false`：不强制隐藏。说明连麦功能使用了 WebRTC 技术，由于该技术的兼容性限制，仅在观众使用以下操作系统和浏览器时，默认展示移动端连麦入口。如需强制隐藏移动端连麦入口，可将参数值设置为 `true`。操作系统：Android 10 以上或 iOS 14.3 以上。浏览器：Google Chrome（Android 版本 78.0 以上、iOS 版本 86.0.4240 以上）、Safari 14 以上或微信内嵌浏览器。
customInteractionIcons	CustomInteractionIcons[]	否	-	互动工具浮窗。
portraitMenuExtends	PortraitMenuConf[]	否	-	移动端竖屏直播间的图标或按钮。

CustomInteractionIcons

互动工具浮窗相关参数。

配置项	类型	是否必选	默认值	说明
key	string	是	无	互动工具浮窗的唯一标识。
img	string	是	无	互动工具浮窗的图片链接。支持的图片格式与 `img` 标签支持的图片格式相同。
text	string	是	无	互动工具浮窗底部的文字。

PortraitMenuConf

移动端竖屏直播间的图标或按钮相关参数。

配置项	类型	是否必选	默认值	说明
name	string	是	无	图标或按钮的名称。该名称仅在图标或按钮收纳在更多图标中时显示在图标或按钮下方。
icon	PortraitMenuIcon	否	-	竖屏直播间显示的图标。
render	string	否	无	竖屏直播间显示的图标或按钮。例如：`<div style="color: #fff">赞</div>`。
key	string	是	无	图标或按钮的唯一标识。
onClick	Function	否	无	点击事件回调。
index	number	是	`0`	图标或按钮的显示顺序。数值越大，越靠左显示。值大于 70 会收纳在更多图标内。如果图标和按钮总数超过 4 个（包括直播间内的默认图标），超过部分的图标或按钮会收纳在更多图标内。

播放器相关参数

配置项	类型	是否必选	默认值	说明
autoplayFailedIcon	boolean	否	`true`	自动播放失败后，是否展示点击播放按钮。取值如下： `true`：展示点击播放按钮。 `false`：展示播放图标。
systemFullScreen	boolean	否	不适用	仅在需要 iOS 移动端支持系统全屏时，传入该参数。参数取值固定为 `true`。
cssFullScreen	boolean	否	不适用	仅在需要 iOS 移动端支持样式全屏时，传入该参数。参数取值固定为 `true`。

配置项

类型

是否必选

默认值

说明

autoplayFailedIcon

boolean

否

true

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

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

systemFullScreen

boolean

否

不适用

仅在需要 iOS 移动端支持系统全屏时，传入该参数。参数取值固定为 true。

cssFullScreen

boolean

否

不适用

仅在需要 iOS 移动端支持样式全屏时，传入该参数。参数取值固定为 true。