企业直播
企业直播
- 文档首页
企业直播微信小程序观播 SDKSDK API 参考配置参数
文档反馈
问问助手SdkInitParams
SDK 初始化参数，用于在观看页展示直播间。
说明
SDK 的配置优先级高于企业直播控制台和服务端 OpenAPI 的配置。
| 配置项 | 类型 | 是否必选 | 默认值 | 说明 |
|---|---|---|---|---|
| activityId | number | 是 | 不适用 | 直播间的活动 ID。您可通过调用 CreateActivityAPIV2 或 ListActivityAPI 接口获取活动 ID，也可以在企业直播控制台的直播间左上角获取活动 ID。一个直播间对应一个 activityId。 |
token | string | 否 |
| 用户进入直播间时的授权 Token。
|
| signToken | string | 否 | 不适用 | 用户进入直播间或点播间的授权 Token。token 与 signToken 至少需传入其中一个参数；当两者同时传入时，以 signToken 为准。不同鉴权模式（mode）下，signToken 的获取方式不同。详情参考获取直播间登录秘钥中使用说明一节。说明： reSetLiveInfo 方法暂不支持该参数。在使用 reSetLiveInfo 方法时，请传入 token 参数。 |
mode | number | 是 |
| 鉴权模式。取值如下：
|
| chatFontSize | number | 否 | 28 | 聊天字号。推荐取值范围：[20, 36]。 |
disableOfflineModal | boolean | 否 |
| 是否禁止弹出多端登录踢出弹窗。取值如下：
多端登录踢出弹窗如下所示： |
| options | SdkExtraOptions | 否 | —— | 扩展配置。 |
SdkExtraOptions
在集成微信小程序观播 SDK 时，您还可以设置以下参数，实现更多自定义功能。
| 配置项 | 类型 | 是否必选 | 默认值 | 说明 |
|---|---|---|---|---|
| origin | string | 否 | "https://live.byteoc.com" | 业务请求域名。如无特殊需求，无需设置。 |
| mediaComponentsAttr | MediaComponentsAttr | 否 | —— | 媒体组件属性透传配置。 |
liveEngineMode | "live-player" | "video" | "auto" | 否 |
| 直播引擎模式。取值如下：
|
MediaComponentsAttr
媒体组件属性透传配置。您可以在初始化 SDK 时，通过 mediaComponentsAttr 配置项，将自定义属性透传给 video 和 live-player 组件。
| 配置项 | 类型 | 是否必选 | 默认值 | 说明 |
|---|---|---|---|---|
| video | VideoComponentAttrs | 否 | —— | 点播间视频组件属性配置。 |
| livePlayer | LivePlayerComponentAttrs | 否 | —— | 直播间组件属性配置。 |
VideoComponentAttrs
类型：interface
点播视频组件属性配置。
'picture-in-picture-mode'
类型：PictureInPictureMode[] | undefined
点播间的画中画模式。默认值为：{'picture-in-picture-mode': ['push', 'pop']}。
'object-fit'
类型：string | undefined
点播间视频画面的填充模式。默认值为 contain。可选值有：
contain: 画面长边填满屏幕，短边区域会被填充为⿊⾊。fillCrop: 画面铺满屏幕，超出显示区域的部分会被裁剪。
LivePlayerComponentAttrs
类型：interface
直播间组件属性配置。
'picture-in-picture-mode'
类型：PictureInPictureMode[] | undefined
直播间的画中画模式。默认值为：{'picture-in-picture-mode': ['push', 'pop']}。
'object-fit'
类型：string | undefined
直播间视频画面的填充模式。默认值为 contain。可选值有：
contain: 画面长边填满屏幕，短边区域会被填充为⿊⾊。fillCrop: 画面铺满屏幕，超出显示区域的部分会被裁剪。