activityId

number

是

不适用

直播间的活动 ID。您可通过调用 CreateActivityAPIV2 或 ListActivityAPI 接口获取活动 ID，也可以在企业直播控制台的直播间左上角获取活动 ID。一个直播间对应一个 activityId。

token

string

否

不适用

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

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

signToken

string

否

不适用

用户进入直播间或点播间的授权 Token。token 与 signToken 至少需传入其中一个参数；当两者同时传入时，以 signToken 为准。不同鉴权模式（mode）下，signToken 的获取方式不同。详情参考获取直播间登录密钥中使用说明一节。

说明：reSetLiveInfo 方法暂不支持该参数。在使用 reSetLiveInfo 方法时，请传入 token 参数。

mode

number

是

1

鉴权模式。取值如下：

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

chatFontSize

number

否

28

聊天基础字号。推荐取值范围：[20, 36]。该参数不用于开启或关闭微信大字版（关怀模式）。如需适配关怀模式，请在承载直播间的页面 wxml 顶部添加 <page-meta root-font-size="system" />。详情参考集成微信小程序观播 SDK。

disableOfflineModal

boolean

否

false

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

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

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

options

SdkExtraOptions

否

——

扩展配置。

origin

string

否

"https://live.byteoc.com"

业务请求域名。如无特殊需求，无需设置。

mediaComponentsAttr

MediaComponentsAttr

否

——

媒体组件属性透传配置。

accessibility

{ isCareModeEnabled?: boolean; careModeFontSizeOffset?: number; }

否

——

SDK 内置的关怀模式配置。若您已适配微信原生的关怀模式（详见集成文档中适配微信关怀模式部分），使用该参数可在原生关怀模式基础上进一步放大文字。

• isCareModeEnabled：初始化时是否开启内置的关怀模式。显式传入时优先使用该值；未传入时，SDK 使用用户上次的关怀模式选择。默认值为 false。取值如下：
  • true：开启关怀模式。开启后，直播间内文字会在原有字号基础上额外增加 careModeFontSizeOffset 配置的字号，并记住观众的选择。
  • false：关闭关怀模式。
• careModeFontSizeOffset：开启内置关怀模式后，设置直播间内文字在原有字号基础上增加的大小，单位为 rpx。请传入大于或等于 0 的有限数值；如果传入其他无效值，SDK 将使用默认值。默认值为 2。

showChatInputCloseButton

boolean

否

false

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

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

portraitTopSafeAreaHeight

number

否

0

竖屏直播间顶部安全区高度，单位为 px。未配置时，SDK 不额外添加顶部安全区高度。
当宿主小程序页面使用 navigationStyle: "custom" 开启自定义导航栏时，页面顶部可能被系统状态栏或顶部安全区遮挡。此时可传入宿主页计算得到的顶部安全区高度，SDK 会将该值作为 padding-top 应用到竖屏直播间顶部元素区域，包括直播描述、观看人数/状态、互动工具和页头图等，避免这些元素进入状态栏等不可点击区域。

portraitCommentAreaHeight

number

否

——

移动端竖屏直播间评论区域高度，单位是像素（px）。无取值范围限制，请按需设置。

bottomIconConfig

BottomIconConfig

否

——

观看页图标配置。用于控制横屏或竖屏直播间图标的展示、顺序和外层展示数量。

liveEngineMode

"live-player" | "video" | "auto"

否

'auto'

直播引擎模式。取值如下：

• live-player：使用 live-player 组件播放直播流。
• video：使用 video 组件播放直播流，使用该版本 SDK 的直播功能无需开通 live-player 权限。当缺少该权限时，可以设置为该模式。
• auto：自动选择。优先使用 live-player，当 live-player 失败时，会自动切换为 video。

disableFeatureProcess

boolean | string[]

否

false

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

• true：阻止所有当前小程序已支持互动功能的后续执行。
• false：不阻止任何互动功能的后续执行。
• String[]：仅阻止指定互动功能的后续执行。例如设置参数值为 ['Comment','Question']，阻止评论功能和互动问答功能的后续执行。

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

• Comment：评论功能。
• Question：互动问答功能。
• Questionnaire：问卷功能。
• CheckIn：签到功能。
• Lottery：抽奖功能。
• Thumb：点赞功能。
• Luckymoney：红包功能。
• Reservation：预约功能。
• Coupon：卡券功能。

floatingInteractionIcons

FloatingInteractionIconConf[]

否

——

互动工具浮窗图标的显示配置。

jumpConfig

JumpConfig

否

——

SDK 默认外链跳转配置。

• 配置此项后，当用户在直播间内点击支持跳转的外部链接（如商品卡片、广告等）时，SDK 会自动跳转到您指定的业务 Webview 页面。
• 若未配置此项，SDK 在点击外链时将仅触发对应的点击事件（如 card.click），不会执行任何默认跳转逻辑，此时需要您自行在事件监听回调中实现跳转逻辑。详情参考自定义跳转逻辑。

video

VideoComponentAttrs

否

——

点播间视频组件属性配置。

livePlayer

LivePlayerComponentAttrs

否

——

直播间组件属性配置。

key

string

是

——

互动工具浮窗图标的唯一标识。当前支持对以下图标设置显示或隐藏：

• SYS:QUESTION：系统默认的互动问答图标。
• SYS:QUESTIONNAIRE：系统默认的问卷图标。
• SYS:CHECKIN：系统默认的签到图标。
• SYS:LOTTERY：系统默认的抽奖图标。
• SYS:LUCKYMONEY：系统默认的红包图标。
• SYS:COUPON：系统默认的卡券图标。

visible

boolean

否

true

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

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