小程序直播组件接入指引

已订阅

一、简介

小程序直播，是微信提供给小程序开发者的直播组件。通过调用该组件，商家可以在小程序中实现直播功能。

按下面的使用说明接入，在你的小程序中引入直播组件。

 

二、使用方法说明

1.  【直播组件】如何引入
版本限制：

微信客户端版本 7.0.7 及以上（基础库版本2.9.x 及以上支持同层渲染）可以观看直播及使用直播间的功能，低版本刚进入直播间时会提示用户升级微信客户端版本（低版本只能观看直播，无法使用直播间的功能）。

 

在分包内引入【直播组件】live-player-plugin代码包，项目根目录的 app.json 引用，示例代码如下：

{
 
  "subpackages": [
 
    {
 
      "root": "packageA",
 
      "pages": [
 
        "pages/home/home"
 
      ],
 
      "plugins": {
 
        "live-player-plugin": {         
 
"version": "1.0.0", // 填写该直播组件最新版本号，微信开发者工具调试时可获取最新版本号
 
          "provider": "wx2b03c6e691cd7370" // 必须填该直播组件appid，该示例值即为直播组件appid
 
        }
 
      }
 
    }
 
  ]
 
}

2.   【直播组件】如何使用
按第1步的方法把组件代码包配置引入后，即可直接通过链接地址跳转到直播组件页面（即为进直播间页面）链接地址需要带上直播房间id；房间id可通过下面【获取直播房间列表】API获取，示例代码如下：
 

<navigator url="plugin-private://wx2b03c6e691cd7370/pages/live-player-plugin?room_id=[直播房间id]">
 
  Go to Live Player page
 
</navigator>

 
通过该链接可跳转到直播组件页面（当前页面入口仅开放‘live-player-plugin’）。

示例效果图如下：

 

三、其他相关组件、接口和携带参数

●    订阅组件：subscribe

●    获取直播状态API：getLiveStatus

●    直播间到商详页面携带参数：room_id

●    从群分享卡片返回直播间时携带参数：shareTicket

●