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

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：小程序原生的系统信息。包含了设备型号、操作系统版本等。