送花功能
#调用域: SDK.plugins().flower
送花流程:
- 在确认开播后,调用接口 SDK.plugins().flower.getFlower() 开启送花功能
- 按需监听以下事件进行自定义业务操作
初始化获取鲜花 getFlower(flowerObj => {...})
@返回值说明: (Object:flowerObj) 初始化鲜花接口(需在直播过程中调用此接口)
参数 | 类型 | 描述 |
---|---|---|
code | Number | 状态码 |
amount | Number | 花朵数目 |
left_time | Number | 还剩多少时间获取一朵 |
pass_time | Number | 送过一朵后过去时间 |
time_interval | Number | 多少秒后获得一朵鲜花 |
调用示例:
HT.plugins().flower.getFlower(flowerObj => {
// amount: 0
// left_time: 130
// pass_time: 50
// time_interval: 180
})
发送鲜花 sendFlower()
@返回值说明:
参数 | 类型 | 描述 |
---|---|---|
code | Number | 状态码 |
amount | Number | 花朵数目 |
调用示例:
// 发送成功之后会触发flower:send事件
HT.plugins().flower.sendFlower()
初始化鲜花数事件: flower:get:init
- 调用sendFlower方法成功之后和页面初始化都会返回该事件
@返回值说明:
参数 | 类型 | 描述 |
---|---|---|
code | Number | 状态码 |
amount | Number | 花朵数目 |
调用示例:
HT.on('flower:get:init', (res) => {
console.log(res)
})
当前鲜花数事件: flower:total
- 调用sendFlower方法成功之后会根据flower:send 中返回的time_interval定时返回该事件,连续返回该事件的上限是3次
@返回值说明:
参数 | 类型 | 描述 |
---|---|---|
total | Number | 当前花朵数目 |
调用示例:
HT.on('flower:total', (res) => {
console.log(res)
})
得到下次送花时长事件: flower:time:left
- 当前鲜花朵数为0的时候调用sendFlower方法成功之后会返回该事件
@返回值说明:
参数 | 类型 | 描述 |
---|---|---|
code | Number | 状态码 |
leftTime | Number | 获取花朵的剩余时间 |
调用示例:
HT.on('flower:time:left', (res) => {
console.log(res)
})
接收鲜花事件: flower:send
- 调用sendFlower方法成功之后会返回该事件
@返回值说明
参数 | 类型 | 描述 |
---|---|---|
pid | Number | 合作方id |
xid | Number | 当前用户xid |
uid | String | 当前用户uid |
roomid | Number | 房间id |
nickname | String | 当前用户昵称 |
role | String | 当前用户角色 |
course_id | Number | 课程id |
gid | Number | 组id |
liveid | String | 直播id |
bid | Strign | 主播id |
amount | Number | 本次发送的花朵数 |
sendtime | Number | 发送鲜花的时间戳 |
time | String | 发送鲜花时间 |
left_amount | Number | 获取花朵的剩余时间 |
avatar | String | 当前用户头像地址 |
time_interval | Number | 观看多长时间(s)可获得一朵鲜花 |
pass_time | Number | |
left_time | Number |
调用示例:
HT.on('flower:send', (res) => {
console.log(res)
})