WxMaLiveServiceImpl (WxJava - MiniApp Java SDK 4.0.2.B API)

java.lang.Object
- cn.binarywang.wx.miniapp.api.impl.WxMaLiveServiceImpl

所有已实现的接口:: WxMaLiveService

public class WxMaLiveServiceImpl
extends Object
implements WxMaLiveService

  Created by yjwang on 2020/4/5.

作者:: yjwang

字段概要
- 从接口继承的字段 cn.binarywang.wx.miniapp.api.WxMaLiveService
  ADD_ASSISTANT, ADD_GOODS, CREATE_ROOM, DELETE_ROOM, EDIT_ROOM, GET_ASSISTANT_LIST, GET_LIVE_INFO, GET_PUSH_URL, GET_SHARED_CODE, MODIFY_ASSISTANT, REMOVE_ASSISTANT

构造器概要

构造器
构造器和说明

WxMaLiveServiceImpl()

构造器
构造器和说明
`WxMaLiveServiceImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`addAssistant(Integer roomId, List<WxMaLiveAssistantInfo> users)` 添加管理直播间小助手调用接口往指定直播间添加管理直播间小助手调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addassistant?
`boolean`	`addGoodsToRoom(Integer roomId, List<Integer> goodsIds)` 直播间导入商品调用接口往指定直播间导入已入库的商品调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addgoods?
`WxMaCreateRoomResult`	`createRoom(WxMaLiveRoomInfo roomInfo)` 创建直播间调用此接口创建直播间，创建成功后将在直播间列表展示，调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#1 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/create?
`boolean`	`deleteRoom(Integer roomId)` 删除直播间调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#5 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/deleteroom?
`boolean`	`editRoom(WxMaLiveRoomInfo roomInfo)` 编辑直播间调用此接口编辑直播间，调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#6 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/editroom?
`List<WxMaAssistantResult.Assistant>`	`getAssistantList(Integer roomId)` 查询直播间小助手查询直播间小助手调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlist?
`WxMaLiveResult`	`getLiveInfo(Integer start, Integer limit)` 获取直播房间列表.
`List<WxMaLiveResult.RoomInfo>`	`getLiveInfos()` 获取所有直播间信息（没有分页直接获取全部）
`WxMaLiveResult`	`getLiveReplay(Integer roomId, Integer start, Integer limit)` 获取直播房间回放数据信息.
`WxMaLiveResult`	`getLiveReplay(String action, Integer roomId, Integer start, Integer limit)` 获取直播房间回放数据信息.
`String`	`getPushUrl(Integer roomId)` 获取直播间推流地址调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#7 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getpushurl?
`String`	`getSharedCode(Integer roomId, String params)` 获取直播间分享二维码调用额度：10000次/一天文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#8 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode?
`boolean`	`modifyAssistant(Integer roomId, String username, String nickname)` 修改直播间小助手昵称调用接口修改直播间小助手昵称调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?
`boolean`	`removeAssistant(Integer roomId, String username)` 删除直播间小助手删除直播间小助手调用频率调用额度：10000次/一天 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/removeassistant?

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - WxMaLiveServiceImpl
```
public WxMaLiveServiceImpl()
```
- 方法详细资料
  - createRoom
```
public WxMaCreateRoomResult createRoom(WxMaLiveRoomInfo roomInfo)
                                throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    创建直播间
```
 调用此接口创建直播间，创建成功后将在直播间列表展示，调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#1
 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/create?access_token=ACCESS_TOKEN
 
```
    指定者:
    
    createRoom 在接口中 WxMaLiveService
    
    参数:
    
    roomInfo - 直播间信息
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - deleteRoom
```
public boolean deleteRoom(Integer roomId)
                   throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    删除直播间
```
 调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#5
 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/deleteroom?access_token=ACCESS_TOKEN
 
```
    指定者:
    
    deleteRoom 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 直播间id
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - editRoom
```
public boolean editRoom(WxMaLiveRoomInfo roomInfo)
                 throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    编辑直播间
```
 调用此接口编辑直播间，调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#6
 http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/editroom?access_token=ACCESS_TOKEN
 
```
    指定者:
    
    editRoom 在接口中 WxMaLiveService
    
    参数:
    
    roomInfo - 直播间信息
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getPushUrl
```
public String getPushUrl(Integer roomId)
                  throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    获取直播间推流地址
```
 调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#7
 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getpushurl?access_token=ACCESS_TOKEN
 
```
    指定者:
    
    getPushUrl 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 直播间id
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getSharedCode
```
public String getSharedCode(Integer roomId,
                            String params)
                     throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    获取直播间分享二维码
```
 调用额度：10000次/一天
 文档地址：https://developers.weixin.qq.com/miniprogram/dev/framework/liveplayer/studio-api.html#8
 http请求方式：GET https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode?access_token=ACCESS_TOKEN
 
```
    指定者:
    
    getSharedCode 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 直播间id
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveInfos
```
public List<WxMaLiveResult.RoomInfo> getLiveInfos()
                                           throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    
    获取所有直播间信息（没有分页直接获取全部）
    
    指定者:
    
    getLiveInfos 在接口中 WxMaLiveService
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveInfo
```
public WxMaLiveResult getLiveInfo(Integer start,
                                  Integer limit)
                           throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    
    获取直播房间列表.（分页）
    
    指定者:
    
    getLiveInfo 在接口中 WxMaLiveService
    
    参数:
    
    start - 起始拉取房间，start = 0 表示从第 1 个房间开始拉取
    
    limit - 每次拉取的个数上限，不要设置过大，建议 100 以内
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveReplay
```
public WxMaLiveResult getLiveReplay(String action,
                                    Integer roomId,
                                    Integer start,
                                    Integer limit)
                             throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    
    获取直播房间回放数据信息.
    
    指定者:
    
    getLiveReplay 在接口中 WxMaLiveService
    
    参数:
    
    action - 获取回放
    
    roomId - 直播间 id
    
    start - 起始拉取视频，start = 0 表示从第 1 个视频片段开始拉取
    
    limit - 每次拉取的个数上限，不要设置过大，建议 100 以内
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - getLiveReplay
```
public WxMaLiveResult getLiveReplay(Integer roomId,
                                    Integer start,
                                    Integer limit)
                             throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    
    获取直播房间回放数据信息.
    获取回放（默认：get_replay）
    
    指定者:
    
    getLiveReplay 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 直播间 id
    
    start - 起始拉取视频，start = 0 表示从第 1 个视频片段开始拉取
    
    limit - 每次拉取的个数上限，不要设置过大，建议 100 以内
    
    返回:
    
    .
    
    抛出:
    
    WxErrorException - .
  - addGoodsToRoom
```
public boolean addGoodsToRoom(Integer roomId,
                              List<Integer> goodsIds)
                       throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    直播间导入商品
    调用接口往指定直播间导入已入库的商品调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addgoods?access_token=ACCESS_TOKEN
    指定者:
    
    addGoodsToRoom 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 房间ID
    
    goodsIds - 数组列表，可传入多个，里面填写商品 ID
    
    返回:
    
    导入商品是否成功
    
    抛出:
    
    WxErrorException - .
  - addAssistant
```
public boolean addAssistant(Integer roomId,
                            List<WxMaLiveAssistantInfo> users)
                     throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    添加管理直播间小助手
    调用接口往指定直播间添加管理直播间小助手调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/addassistant?access_token=ACCESS_TOKEN
    指定者:
    
    addAssistant 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 房间ID
    
    users - 数组列表，可传入多个，"users": [{"username":"testwechat","nickname":"testnick"}]
    
    返回:
    
    添加管理直播间小助手是否成功
    
    抛出:
    
    WxErrorException - .
  - modifyAssistant
```
public boolean modifyAssistant(Integer roomId,
                               String username,
                               String nickname)
                        throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    修改直播间小助手昵称
    调用接口修改直播间小助手昵称调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistant?access_token=ACCESS_TOKEN
    指定者:
    
    modifyAssistant 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 房间ID
    
    username - 小助手微信号
    
    nickname - 小助手直播间昵称
    
    返回:
    
    修改小助手昵称是否成功
    
    抛出:
    
    WxErrorException - .
  - removeAssistant
```
public boolean removeAssistant(Integer roomId,
                               String username)
                        throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    删除直播间小助手
    删除直播间小助手调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/removeassistant?access_token=ACCESS_TOKEN
    指定者:
    
    removeAssistant 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 房间ID
    
    username - 小助手微信号
    
    返回:
    
    删除小助手昵称是否成功
    
    抛出:
    
    WxErrorException - .
  - getAssistantList
```
public List<WxMaAssistantResult.Assistant> getAssistantList(Integer roomId)
                                                     throws WxErrorException
```
    从接口复制的说明: WxMaLiveService
    查询直播间小助手
    查询直播间小助手调用频率调用额度：10000次/一天
    http请求方式：POST https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlist?access_token=ACCESS_TOKEN
    指定者:
    
    getAssistantList 在接口中 WxMaLiveService
    
    参数:
    
    roomId - 房间ID
    
    返回:
    
    小助手列表
    
    抛出:
    
    WxErrorException - .

类 WxMaLiveServiceImpl

字段概要

从接口继承的字段 cn.binarywang.wx.miniapp.api.WxMaLiveService

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

WxMaLiveServiceImpl

方法详细资料

createRoom

deleteRoom

editRoom

getPushUrl

getSharedCode

getLiveInfos

getLiveInfo

getLiveReplay

getLiveReplay

addGoodsToRoom

addAssistant

modifyAssistant

removeAssistant

getAssistantList