GameRecorderShareButton

基础库 2.8.0 开始支持,低版本需做兼容处理

游戏对局回放分享按钮。按钮在被用户点击后会发起对最近一次录制完成的游戏对局回放的分享。

属性

Object style

按钮的样式

属性 类型 说明
left number 左上角横坐标,单位 逻辑像素
top number 左上角纵坐标,单位 逻辑像素
height number 按钮的高度,最小 40 逻辑像素
iconMarginRight number 图标和文本之间的距离,最小 8 逻辑像素
fontSize number 文本的字体大小。最小 17,最大 22。
color string 文本的颜色。
paddingLeft number 按钮的左内边距,最小 16 逻辑像素。
paddingRight number 按钮的右内边距,最小 16 逻辑像素。

string icon

图标的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。

string image

按钮的背景图片的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。

string text

按钮的文本。

Object share

对局回放的分享参数。

属性 类型 说明
query string 分享的对局回放打开后跳转小游戏的 query。
title Object 对局回放的标题的配置。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。
button Object 对局回放的按钮的配置。对局回放按钮的文案不能随意设置,只能选择预设的文案模版。
bgm string 对局回放背景音乐的地址。必须是一个代码包文件路径或者 wxfile:// 文件路径,不支持 http/https 开头的 url。
timeRange Array.<number> 对局回放的剪辑区间,是一个二维数组,单位 ms(毫秒)。[[1000, 3000], [4000, 5000]] 表示剪辑已录制对局回放的 1-3 秒和 4-5 秒最终合成为一个 3 秒的对局回放。对局回放剪辑后的总时长最多 60 秒,即 1 分钟。

share.title 的结构

属性 类型 说明
template string 对局回放的标题的模版。不传则为:${用户昵称} 在 ${游戏名称} 的游戏时刻
data Object 对局回放的标题的模版参数。

share.title.template 的合法值

说明 最低版本
defautl.score 模版格式为,《小游戏名称》,本局得分:${score},对应的 data 应该如 { score: 4500 }
default.level 模版格式为,《小游戏名称》,当前关卡:第42关,对应的 data 应该如 { level: 23 }
default.opponent 模版格式为,《小游戏名称》,本局对手:${opponent},对应的 data 应该如 { opponent_openid: 'oC6J75Sh1_4K8Mf5b1mlgDkMPhoI' }
default.cost 模版格式为,《小游戏名称》,本局耗时:${cost}秒,对应的 data 应该如 { cost_seconds: 123 }

share.button 的结构

属性 类型 说明
template string 对局回放的按钮的模版。

share.button.template 的合法值

说明 最低版本
enter 马上玩
challenge 去挑战
play 去挑战

方法

GameRecorderShareButton.show()

显示游戏对局回放分享按钮

GameRecorderShareButton.hide()

隐藏游戏对局回放分享按钮

GameRecorderShareButton.onTap(function callback)

监听游戏对局回放分享按钮的点击事件。只有当分享由于非用户取消的原因失败时,该事件的回调函数才会执行。

GameRecorderShareButton.offTap(function callback)

取消监听游戏对局回放分享按钮的点击事件