# 小程序直播
小程序直播是微信官方提供的商家經(jīng)營工具。通過調(diào)用該組件，商家可以在小程序中實現(xiàn)直播互動與商品銷售閉環(huán)。
按照下面的使用說明接入，在你的小程序中引入直播組件即可實現(xiàn)直播功能。使用過程中如遇到問題，可在小程序直播社區(qū)發(fā)帖交流。
# 使用方法說明
# 1. 【直播組件】如何引入
版本限制：微信客戶端版本 7.0.7 及以上（基礎(chǔ)庫版本2.9.x及以上支持同層渲染）可以觀看直播及使用直播間的功能，低版本剛進入直播間時會提示用戶升級微信客戶端版本（低版本只能觀看直播，無法使用直播間的功能）。
支持在主包或分包內(nèi)引入【直播組件】 live-player-plugin 代碼包（注：直播組件不計入代碼包體積），項目根目錄的 app.json 引用，示例代碼如下：
(1) 主包引入
"plugins": {
"live-player-plugin": {
"version": "1.3.0", // 注意填寫該直播組件最新版本號，微信開發(fā)者工具調(diào)試時可獲取最新版本號（復(fù)制時請去掉注釋）
"provider": "wx2b03c6e691cd7370" // 必須填該直播組件appid，該示例值即為直播組件appid（復(fù)制時請去掉注釋）
}
}
(2) 分包引入
"subpackages": [
{
"plugins": {
"live-player-plugin": {
"version": "1.3.0", // 注意該直播組件最新版本號，微信開發(fā)者工具調(diào)試時可獲取最新版本號（復(fù)制時請去掉注釋）
"provider": "wx2b03c6e691cd7370" // 必須填該直播組件appid，該示例值即為直播組件appid（復(fù)制時請去掉注釋）
}
}
}
]
# 2. 【直播組件】如何使用
按第1步的方法把組件代碼包配置引入后，即可直接通過鏈接地址跳轉(zhuǎn)到直播組件頁面（即為進直播間頁面）鏈接地址需要帶上直播房間 id；房間 id 可通過下面 獲取直播房間列表 API 獲取。
# 示例代碼如下：
(1) 使用 navigator 組件跳轉(zhuǎn)進入直播間
# index.js
let roomId = [直播房間id] // 填寫具體的房間號，可通過下面【獲取直播房間列表】 API 獲取
let customParams = encodeURIComponent(JSON.stringify({ path: 'pages/index/index', pid: 1 })) // 開發(fā)者在直播間頁面路徑上攜帶自定義參數(shù)（如示例中的path和pid參數(shù)），后續(xù)可以在分享卡片鏈接和跳轉(zhuǎn)至商詳頁時獲取，詳見【獲取自定義參數(shù)】、【直播間到商詳頁面攜帶參數(shù)】章節(jié)（上限600個字符，超過部分會被截斷）
this.setData({
roomId,
customParams
})
# index.wxml
<navigator url="plugin-private://wx2b03c6e691cd7370/pages/live-player-plugin?room_id={{roomId}}&custom_params={{customParams}}"></navigator>
// 其中wx2b03c6e691cd7370是直播組件appid不能修改
(2) 使用 navigateTo 方法跳轉(zhuǎn)進入直播間
# index.js
let roomId = [直播房間id] // 填寫具體的房間號，可通過下面【獲取直播房間列表】 API 獲取
let customParams = encodeURIComponent(JSON.stringify({ path: 'pages/index/index', pid: 1 })) // 開發(fā)者在直播間頁面路徑上攜帶自定義參數(shù)（如示例中的path和pid參數(shù)），后續(xù)可以在分享卡片鏈接和跳轉(zhuǎn)至商詳頁時獲取，詳見【獲取自定義參數(shù)】、【直播間到商詳頁面攜帶參數(shù)】章節(jié)（上限600個字符，超過部分會被截斷）
wx.navigateTo({
url: `plugin-private://wx2b03c6e691cd7370/pages/live-player-plugin?room_id=${roomId}&custom_params=${customParams}`
})
// 其中wx2b03c6e691cd7370是直播組件appid不能修改
通過該鏈接可跳轉(zhuǎn)到直播組件頁面（當前頁面入口僅開放‘live-player-plugin’）。
# 示例效果圖如下：
# 直播組件和接口
# 【組件接口】
通過在主包/分包中引入直播組件，開發(fā)者可以很方便的實現(xiàn)訂閱、獲取直播狀態(tài)、獲取用戶openid以及獲取分享卡片鏈接參數(shù)等功能。
# 【服務(wù)端接口】
服務(wù)端接口包含直播間接口和商品管理接口。
- 直播間管理接口是小程序直播提供給開發(fā)者對直播間進行批量操作的接口能力。開發(fā)者可以批量創(chuàng)建直播間，獲取回放源視頻，獲取直播間列表等。
- 商品管理接口是小程序直播提供給開發(fā)者對直播商品進行批量操作的接口能力。開發(fā)者可以對商品批量進行添加、提審、刪除以及更新等操作。
| 類別 | 名稱 | 功能說明 |
|---|---|---|
| 組件接口 | 訂閱組件?subscribe | 用戶進入直播間內(nèi)，可對一場未開播的直播進行單次訂閱，開播時直播組件會自動下發(fā)開播提醒給用戶 |
| 獲取直播狀態(tài) getLiveStatus | 首次獲取立馬返回直播狀態(tài)，往后間隔1分鐘或更慢的頻率去輪詢獲取直播狀態(tài) | |
| 獲取用戶openid參數(shù)getOpenid | 在直播組件版本 1.3.0 及以上版本通過該接口獲取用戶openid參數(shù) | |
| 獲取分享卡片鏈接參數(shù)getShareParams | 在直播組件版本 1.3.0 及以上版本通過該接口獲取以下參數(shù)，開發(fā)者可以根據(jù)這些參數(shù)建立用戶、直播間、商品之間的映射關(guān)系 | |
| 直播小窗控制參數(shù)?close_picture_in_picture_mode | 通過參數(shù)設(shè)置是否關(guān)閉小窗 | |
| 攜帶參數(shù)（?直播間到商詳頁面，?從群分享卡片返回直播間 | 直播組件版本 1.3.0 及以上支持攜帶以下參數(shù)，可用這些參數(shù)建立用戶、直播間、商品之間的映射關(guān)系。 | |
| 服務(wù)端接口 | 創(chuàng)建直播間 | 該接口可直接創(chuàng)建直播間，創(chuàng)建成功后直播間將在直播間列表展示 |
| 后臺獲取直播房間列表 | 該接口可獲取直播房間列表 | |
| 后臺獲取回放源視頻 | 該接口可在直播結(jié)束后拿到回放源視頻 | |
| 往指定直播間導(dǎo)入已入庫商品 | 調(diào)用此接口往指定直播間導(dǎo)入已入庫的商品 | |
| 商品添加并提審 | 調(diào)用此接口上傳并提審需要直播的商品信息，審核通過后商品錄入【小程序直播】商品庫 | |
| 撤回商品審核 | 調(diào)用此接口，可撤回直播商品的提審申請，消耗的提審次數(shù)不返還 | |
| 重新提交商品審核 | 調(diào)用此接口可以對已撤回提審的商品再次發(fā)起提審申請 | |
| 刪除商品 | 調(diào)用此接口，可刪除【小程序直播】商品庫中的商品，刪除后直播間上架的該商品也將被同步刪除，不可恢復(fù) | |
| 更新商品 | 調(diào)用此接口可以更新商品信息，審核通過的商品僅允許更新價格類型與價格，審核中的商品不允許更新，未審核的商品允許更新所有字段， 只傳入需要更新的字段 | |
| 獲取商品狀態(tài) | 調(diào)用此接口可獲取商品的信息與審核狀態(tài) | |
| 獲取商品列表 | 調(diào)用此接口可獲取商品列表 |