hyExt.context.onShareLiveNotice
- 监听分享直播间事件
- 开播状态下才有分享回调,且伴随频率限制:
- 单个用户对单个主播每小时只能有1次
- 单个主播每分钟最多10次
- 引入版本 1.7.0
- 适用终端
- 虎牙直播主站
- 虎牙直播APP-iOS:7.13.353
- 虎牙直播APP-安卓:7.13.6
- 虎牙直播助手-iOS:4.7.6
- 虎牙直播助手-安卓:4.7.6
- 虎牙直播PC客户端-主播侧:4.18.4.0
- 虎牙直播PC客户端-观众侧:未验证
接口签名
declare namespace hyExt {
module context {
/**
* 监听分享直播间事件
* @param params 输入参数
*/
function onShareLiveNotice(params: ShareLiveNoticeReq): Promise<void>
}
/**
* 监听分享直播间参数
*/
type ShareLiveNoticeReq = {
/**
* 分享直播间回调
*/
callback: ShareLiveNoticeCallback
}
/**
* 分享直播间回调
* @param notice 直播间分享消息
*/
type ShareLiveNoticeCallback = (notice: ShareLiveNotice) => void
/**
* 直播间分享消息
*/
type ShareLiveNotice = {
/**
* 直播间跳转链接
*/
actionUrl: string
/**
* 分享内容
*/
content: string
/**
* 分享图片的url
*/
imageUrl: string
/**
* 主播unionId
*/
presenterUnionId: string
/**
* 房间Id
*/
roomId: number
/**
* 分享类型,默认0
*/
shareType: number
/**
* 分享人的昵称
*/
sharerNick: string
/**
* 分享人的unionId
*/
sharerUnionId: string
/**
* 直播间副标题
*/
subtitle: string
/**
* 直播间标题
*/
title: string
}
}
示例代码
hyExt.context
.onShareLiveNotice({
callback: (notice) => {
const {
actionUrl,
content,
imageUrl,
presenterUnionId,
roomId,
shareType,
sharerNick,
sharerUnionId,
subtitle,
title,
} = notice
console.log("回调触发", notice)
},
})
.then(() => {
console.log("调用hyExt.context.onShareLiveNotice成功")
})
.catch((err) => {
console.log("调用hyExt.context.onShareLiveNotice失败", err)
})
相关链接
生命周期
直播间信息
环境信息
弹幕
礼物
文本秩序审核
小程序消息
终端事件监听
KV存储
主播端白板
网络库
文件处理
外部EXE能力
浮窗
小程序付费功能
订阅
直播间分享事件
守护事件
贵族事件
高级用户进场事件
小程序入口控制
本地小程序控制
语音识别事件
手势识别事件
视觉识别事件
人体轮廓点检测事件
肢体骨骼点检测事件
人脸特征点检测事件
播放视频
直播间视频
后台相关