小程序实时流媒体组件访问准则一、简介

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

按照以下说明访问直播节目并将其引入您的小程序。

二、有关如何使用1.[Live组件]如何使用

的说明

版本限制：微信客户端版本7.0.7和更高版本（基础库版本2.9.x和更高版本支持同一层渲染）可以观看直播并使用直播室功能，低时版本刚进入直播室时，将提示用户升级微信客户端版本（较低的版本只能观看直播，而不能使用直播室的功能）。

在项目根目录中的app.json引用的子包中引入[live-player-plugin]代码包，示例代码如下：

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

2.[Live组件]使用方法

按照步骤1的方法导入组件代码包配置后，您可以通过链接地址直接跳转到活动组件页面（即，活动室页面）。链接地址需要带客厅ID；可以传递房间ID获得以下API，示例代码如下：

Go to Live Player page

通过此链接，您可以跳至实时组件页面（当前页面入口仅是“ live-player-plugin”）。

示例效果图如下：

三、其他相关组件，接口和携带参数1.[Subscription]组件

功能说明：当用户进入直播室时，他们可以订阅尚未开始的直播。当广播开始时，实时广播组件将自动向用户发出广播提醒，而无需开发人员进行其他开发

组件用法：如果您需要在实时组件页面小程序之外的其他页面上具有相同的启动提醒功能，则可以引入[subscription]组件订阅；您需要在页面页面（例如主页）的home.json中引用订阅组件，示例代码如下：

{ "usingComponents": { "subscribe": "plugin-private://wx2b03c6e691cd7370/components/subscribe/subscribe" } }

然后，您可以在home.wxml中使用预订组件，可以在其中传递直播室ID；可以通过以下[Get Live Room List] API获取房间ID

2.获取直播状态界面

接口说明：首次获取实时广播状态后，立即获取实时广播状态，然后以1分钟或更慢的频率轮询实时广播状态。

直播状态描述：

调用方法：如果要调用[Get Live Status]界面getLiveStatus，则需要在小程序页面顶部引用[Live component] live-player-plugin。示例代码如下：

let livePlayer = requirePlugin('live-player-plugin') // 引入获取直播状态接口 // 首次获取立马返回直播状态，往后间隔1分钟或更慢的频率去轮询获取直播状态 const roomId = xxx // 房间id livePlayer.getLiveStatus({ room_id: roomId }) .then(res => { // 101: 直播中, 102: 未开始, 103: 已结束, 104: 禁播, 105: 暂停中, 106: 异常, 107：已过期 const liveStatus = res.liveStatus }) .catch(err => { console.log(err) })

3.携带参数

版本限制：活动组件版本1.0.1及更高版本支持以下参数

1)shareTicket：将客厅卡共享给微信组。单击此卡后，您可以在App onShow中获取参数

2)room_id：在活动组件页面上单击货架产品，跳到商家小程序的产品详细信息页面，然后将显示房间号参数。

4.[Get Live Room List]界面，仅用于后台通话

接口规则：此接口仅适用于商家后端呼叫。通话限制为每天500次。建议开发人员自己进行缓存（此接口与以下接口共享500次/天的限制，请合理分配调用频率）。

请求网址：

请求方法：POST

请求示例：

请求

{ "start": 0, // 起始拉取房间，start=0表示从第1个房间开始拉取 "limit": 10 // 每次拉取的个数上限，不要设置过大，建议100以内 }

响应

{ "errcode": 0, // errcode=0代表成功；errcode=1代表未创建直播房间 "errmsg": "ok", "room_info": [{ "name": "直播房间名", "roomid": 1, "cover_img": "http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\/Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bdicnxoVialDLCKKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ\/0?wx_fmt=jpeg", "live_satus": 101, "start_time": 1568128900, "end_time": 1568131200, "anchor_name": "李四", "anchor_img": "http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\/Rl1RuuhdstSfZa8EEljedAYcbtX3Ejpdlp0sf9YTorOzUbGF9Eib6ic54k9fX0xreAIt35HCeiakO04yCwymoKTjw\/0?wx_fmt=jpeg", "goods":[ { "cover_img":"http://mmbiz.qpic.cn/mmbiz_png/FVribAGdErI2PmyST9ZM0JLbNM48I7TH2FlrwYOlnYqGaej8qKubG1EvK0QIkkwqvicrYTzVtjKmSZSeY5ianc3mw/0?wx_fmt=png", "url":"pages/index/index.html", "price":1100, "name":"fdgfgf" } ] }

返回字段：

name 房间名roomid 房间id注：需先在小程序MP后台创建直播房间，否则会报错（错误码1）cover_img 封面图片urlstart_time 直播计划开始时间，列表按照 start_time 降序排列end_time 直播计划结束时间anchor_name 主播名goods 商品列表live_status 直播状态 101: 直播中, 102: 未开始, 103: 已结束, 104: 禁播, 105: 暂停中, 106: 异常，107:已过期（直播状态解释可参考【获取直播状态】接口）

5.[获取播放源视频]界面，仅用于后台通话

接口规则：此接口仅适用于商家后端呼叫，呼叫限制为每天500次。该接口与上述接口共有500次/天的限制。请合理分配通话频率。

接口说明：

后续官员将直接提供实时回放功能，而无需开发，敬请期待。

请求网址：

请求方法：POST

请求示例：

请求

{ "action": "get_replay", // 获取回放 "room_id": 354, // 直播间id "start": 0, // 起始拉取视频，start=0表示从第1个视频片段开始拉取 "limit": 10 // 每次拉取的个数上限，不要设置过大，建议100以内 }

响应

{ "live_replay": [ { "expire_time": "2020-11-11T03:49:55Z", // 回放视频 url 过期时间 "create_time": "2019-11-12T03:49:55Z", // 回放时间创建时间 "media_url": "http://xxxxx.vod2.myqcloud.com/xxxxx/xxxxx/f0.mp4" // 回放视频 } ], "errcode": 0, "total": 1, "errmsg": "ok" } // 一场直播可能会产生多个视频片段。

四、其他说明1、客厅小程序代码

说明：

在路径中添加type = 9以跳到直播室，以将场景条目标识为小程序代码：

plugin-private://wx2b03c6e691cd7370/pages/live-player-plugin?room_id=[直播房间id]&type=9

将小程序卡添加到2、商家官方帐户文章

注意：当商家在官方帐户文章中添加跳到直播室的小程序卡时，需要完成以下配置（否则，直播室左上角的返回按钮将无效）：

在路径中添加type = 10以跳到直播室，以将场景条目标识为小程序卡：

plugin-private://wx2b03c6e691cd7370/pages/live-player-plugin?room_id=[直播房间id]&type=10

3、产品详细信息页面需要添加一个后退按钮

在实时流式传输组件页面上单击货架产品后，跳至商家小程序的产品详细信息页面，为了防止用户无法返回直播室，商家需要添加小程序产品详细信息页面左上角的返回按钮。 Yu返回到实时组件页面。

4、如何快速更新实时组件版本

与商户小程序对应的管理员微信收到[平台安全助手]发布的实时组件版本更新的服务通知后，可以单击该通知快速发布，移动终端可以快速更新小程序实时组件的新版本，无需修改代码或重新提交进行审核。

服务通知如下所示：