抖音小游戏录屏带配乐能力

我的收藏

一、能力概况

开发者可以使用此功能，在游戏的录屏分享中指定一首乐曲作为默认配乐：当玩家拉起分享录屏的发布器时，在背景音乐中自动配上开发者预设的乐曲。
建议开发者使用抖音近期热门的音乐，并经常更新配乐可显著提升录屏分享的视频播放量和锚点点击量

二、宿主支持

只支持抖音，抖音极速版安卓端，需要基础库版本 1.90 以上。

三、示例

游戏使用案例视频：(建议开发者使用抖音近期热门音乐)
https://v.douyin.com/JXXXTfq/
UGC 配乐发布后，可获得在音乐位置中的额外视频展示

四、接入方法

获取 PGC 音乐短链

1.为保证乐曲版权，请开发者使用抖音音乐库中的乐曲，抖音音乐库入口如下：

如何获取音乐短链？参考如下：

第一步：首先将 PGC 音乐带上视频直接发布

第二步：找到右下角的音乐，复制链接

注意：由于版权问题，非 PGC 音乐将不可用

代码接入

在 tt.shareAppMessage 接口的的 extra 对象中添加 defaultBgm 字段。

通过 extra 设置附加信息：

属性	类型	默认值	说明
defaultBgm	string	""	抖音 pgc 音乐的短链(仅抖音支持，需要基础库版本大于 1.90) 。形如https://v.douyin.com/JmcxWo8/

名称	数据类型	描述
shareWithShareBgmStatus	string	传入 defaultBgm 后的回调信息

shareWithShareBgmStatus 说明

shareWithShareBgmStatus 值	说明
success	bgm 解析成功
bgm not pgc music	bgm 是 ugc 音乐，不可用
fail to fetch bgm	bgm 获取失败/短链转长链失败
fail to download bgm	bgm 下载失败
fail to parse url link	bgm 解析失败，一般是 sdk 内部错误
user interrupt music download	bgm 下载被中断

示例

tt.shareAppMessage({
  channel: "video",
  title: "测试分享视频",
  desc: "测试描述",
  query: "",
  extra: {
    videoPath: "ttfile://temp/test.mp4", // 替换成录屏得到的视频地址
    videoTopics: ["话题1", "话题2"],
    withVideoId: true,
    defaultBgm: "https://v.douyin.com/JmcxWo8/", //这里传入你获取的 PGC 音乐地址
  },
  success(res) {
    console.log(res.videoId);
    console.log(JSON.stringify(res.shareWithShareBgmStatus)); //回调参数
    console.log("分享视频成功");
  },
  fail(e) {
    console.log("分享视频失败");
  },
});

下一篇：常见问题