本文档适用于通过 NPM 方式接入火山引擎微信小程序拉流 SDK，帮助您快速完成初始化配置、组件集成与播放调试。

环境要求

• 小程序基础库 2.12.3 及以上版本，推荐使用最新稳定版。
• 微信开发者工具 1.06.2209040 及以上版本，推荐使用最新稳定版。

前提条件

视频直播配置

• 已在视频直播控制台域名添加，并配置 CNAME。
• 已生成 FLV/RTMP 协议拉流地址，如需使用 HTTPS 拉流，请添加证书并开启 HTTPS 配置。
• 已通过创建工单联系技术支持，申请并获取用于微信小程序集成的 AppID。该 AppID 由火山引擎分配，用于标识您的小程序接入身份。

微信小程序配置

• 已注册并认证微信小程序，主体类型为中国大陆地区的非个人主体。
• 小程序已配置支持 live-player 组件的服务类目，并在接口设置中启用组件权限。
• 已在微信小程序后台 > 开发与服务 > 开发管理 > 开发设置 > 服务器域名中：
  • 将日志上报域名 https://mcs.zijieapi.com 添加至 request 合法域名列表。
  • 配置拉流地址等其他必要的业务域名。

操作步骤

步骤一：安装 SDK

1. 在小程序 package.json 所在的目录中执行以下命令安装 npm 包。

   npm i veplayer-live-mp-wx
   

2. 在微信开发者工具的菜单栏选择工具 > 构建 npm，构建完成后即可使用 npm 包。

步骤二：引入组件

在小程序项目的 index.json 中声明组件引用路径。

// index.json
{
  "usingComponents": {
    "ve-live-player": "veplayer-live-mp-wx/ve-live-player/ve-live-player"
  }
}

步骤三：使用组件

在页面的 index.wxml 文件中使用组件，以下示例演示通过配置 src 拉流地址实现自动播放。src 参数请填写您在火山引擎控制台中生成的 FLV/RTMP 拉流地址。

<!-- index.wxml -->
<ve-live-player autoplay src="{{src}}" />

接入其他功能

视频直播微信小程序拉流 SDK 支持封面图设置、事件监听、报错监听、自适应容器、日志上报等功能，接入方法请参考功能接入或 API 参考。