VolcLiveMiniSdkInstance #

类型：class
小程序 SDK 实例。提供事件监听、实例方法等能力。

new VolcLiveMiniSdkInstance() #

初始化小程序 SDK 实例，用于开启直播间观播功能。
类型

constructor(config: SdkInitParams)

参数

请求示例

import VolcMiniSdk, { EVENTS } from './volc-mini-sdk/index';

const sdk = new VolcMiniSdk({
  'activityId': 17229****9941234,
  'token': 'ps****',
  'mode': 1,
  'options' : { // 在此处自定义配置参数
    origin: "https://live.byteoc.com",
    mediaComponentsAttr: {}
  }
});

on() #

监听事件。
类型

<EventKey extends keyof SDKEventsExternal>(action: EventKey, func: SDKEventsExternal[EventKey]) => void

参数

once() #

监听 SDK 对外抛出的事件，但该事件仅会触发一次。触发后，监听器会自动移除。
类型

<EventKey extends keyof SDKEventsExternal>(action: EventKey, func: SDKEventsExternal[EventKey]) => void

参数

off() #

移除已绑定的事件监听器。
类型

<EventKey extends keyof SDKEventsExternal>(action: EventKey, func: SDKEventsExternal[EventKey]) => void

参数

reSetLiveInfo() #

更新直播间初始化信息。通常用于处理用户登录态变更等场景，无需重新销毁并初始化 SDK。
类型

(params: SdkInitParams) => void

参数

exitPip() #

主动退出当前正在运行的视频画中画（小窗）模式。
类型

() => void

requestBackgroundPlayback() #

同步请求当前播放器进入微信后台播放模式。此方法用于实现小程序切换到后台后，继续播放音视频的能力。

• 调用此方法后，SDK 会尝试向微信小程序申请后台播放权限。
• 申请成功时，播放器会继续在后台播放音视频，同时 SDK 会触发 backgroundPlayback.success 事件。
• 申请失败时，播放器不会进入后台播放模式，同时 SDK 会触发 backgroundPlayback.fail 事件。

类型

() => { source: 'api'; playerType: 'video' | 'live-player' | string; errMsg: string; reason?: 'unsupported' | 'player_not_ready' | 'wechat_fail';}

返回值
{ source: 'api'; playerType: 'video' | 'live-player' | string; errMsg: string; reason?: 'unsupported' | 'player_not_ready' | 'wechat_fail'; } 请求结果对象，包含以下字段：

• source：固定值 'api'，表示请求来源。
• playerType：当前使用的播放器组件类型，包括 'video' 组件和 'live-player' 组件。
• errMsg：错误信息描述。
• reason：失败原因，仅在请求失败时有值。取值如下：
• unsupported：当前小程序环境或微信版本不支持后台播放能力。
• player_not_ready：播放器尚未完成初始化或已被销毁。
• wechat_fail：微信底层接口调用失败。

updateBottomIcon() #

更新观看页底部浮窗图标的配置。用于动态修改底部操作区指定图标是否展示、图标资源、文案、样式或业务透传数据。

• 适用场景：调整按钮的展示顺序、隐藏按钮、替换按钮的图标资源或文案、新增自定义按钮等。
• 注意事项：
  • 点赞按钮的固定 key 为 HEART。点赞图标不参与 bottomIconConfig.transformIconList 的重新排序和 maxVisibleCount 的数量限制，但你仍可通过本方法修改其显隐、图标 URL、样式等。
  • 本方法仅支持更新已经存在的图标。即目标图标必须已存在于 SDK 初始候选列表中，或已通过 transformIconList 返回并加入列表。如需新增自定义图标，请先在 transformIconList 回调中返回该图标，再调用本方法做后续动态更新。

类型

(key: string, patch: BottomIconPatch) => boolean

参数

返回值
boolean 是否成功写入配置覆盖层。取值如下：

• true：成功写入。
• false：写入失败。

destroy() #

销毁 SDK 实例并释放占用的资源。

类型

() => void

getDebugInfo() #

获取 SDK 的调试信息，可用于在线上环境或开发调试过程中排查问题。
类型

() => { debug: boolean; mini_uuid: string; device_id: string; user_unique_id: string; sdk_version: string; systemInfo: SdkSystemInfo;}

返回值
{ debug: boolean; mini_uuid: string; device_id: string; user_unique_id: string; sdk_version: string; systemInfo: SdkSystemInfo; }

• debug：是否开启调试模式。取值如下：
  • true：开启。
  • false：关闭。
• mini_uuid：SDK 实例在当前小程序生命周期内的唯一标识（UUID）。
• device_id：设备的唯一标识符。
• user_unique_id：用户的唯一标识符。
• sdk_version：当前集成的 SDK 版本号。
• systemInfo：小程序原生的系统信息。包含了设备型号、操作系统版本等。