普通小游戏开发
API
开放能力
数据分析
视频拍摄器
多端支持

剪映模版

本文主要是介绍小游戏结合剪映模版能力的使用。具体接入可以参考 录屏添加剪映视频模板能力

最低支持版本

系统抖音版本基础库版本
Android12.21.74.0
IOS12.51.77.0

静默合成后分享

说明: 在传入 videoPath 的情况,可以直接对传入的视频进行处理后分享。调用后会直接合成应用了剪映模版的视频,用户可以直接发布,与现在录屏后分享视频流程一致。

主动调用

主动调用是指通过 tt.shareAppMessage 调起视频分享,传入该方法的参数为 ShareParam 类型。

tt.shareAppMessage({
    ......
    channel: "video",
    extra: {
        ......
        cutTemplateId: "123456...",    //剪映模版ID,在后台配置获取
        videoPath: "xxx.mp3",   //视频地址,可以是本地已有视频路径或者是通过录屏得到
        withVideoId: true,   //使用剪映时,需要传入true
        abortWhenCutTemplateUnavailable: true,  //控制当传入的剪映模板 ID 无效的时候的行为。若是true,则剪映模板 ID 无效时会回调失败,false否则会走普通的分享流程。
    },
},

被动调用

被动调用是指通过 tt.onShareAppMessage 监听用户点击分享的行为,然后在回调函数中返回一个ShareParam对象。

tt.onShareAppMessage((res) => {
    return {
        ......
        extra: {
            ......
            cutTemplateId: "123456...",    //剪映模版ID,在后台配置获取
            videoPath: "xxx.mp4",   //视频地址,可以是本地已有视频路径或者是通过录屏得到
            withVideoId: true,   //使用剪映时,需要传入true
            abortWhenCutTemplateUnavailable: true,  //控制当传入的剪映模板 ID 无效的时候的行为。若是true,则剪映模板 ID 无效时会回调失败,false否则会走普通的分享流程。
        },
    };
});

通过剪映模版分享

说明: 在不传入 videoPath ,但传入有效 cutTemplateId 值时,用户将直接跳转到 剪映模板详情页。在模版详情页,用户可以上传自己本地视频,或者通过拍抖音的方式分享视频内容。

调用方式

与 静默合成后分享 中的主动调用和被动调用两种方式一样,开发者可以只传入 cutTemplateId 来直接跳转剪映模板详情页,不需要传入 videoPath (其他参数保持一致)。

常见问题

  • Q1:在通过剪映模版分享的方式中,不添加 videoPath 使用剪映模板未进入模板详情页,但回调 success 是为什么?
  • A1:如下任一情况出现都出导致上述问题:

    • 剪映模板不可用/剪映模板 ID 无效。
    • 抖音版本低于 12.2。
    • 代码有问题,分享代码未在 extra 中设置 cutTemplateId。
  • Q2:剪映模板不可用指的什么?
  • A2:制作模板的剪映版本和抖音版本有映射关系,高版本剪映应用制作的剪映模板无法在低版本的抖音上使用,建议用剪映 3.5 3.4 3.3 这三个版本来制作模板,老的剪映版本,通过安卓市场:应用汇可以下载。如果一定要使用指定版本剪映 App 制作的模板建议失败后,请开发者自主提示用户再次触发分享不带剪映模板的分享。
  • Q3:剪映模板 ID 无效指的什么?
  • A3:如下任一情况对应的都是剪映模板 ID 无效:

    • 这个剪映模板 ID 没有对应的剪映模板。
    • 该小程序无指定剪映模板 ID 的权限,该模板未在后台审核通过 ,未绑定到当前小程序上,参考说明文档 说明文档

剪映专用包

为避免在小游戏中出现模板调用不成功的情况,请下载剪映模板制作专用版 apk 进行模板创作和提交

安卓版:

IOS 版:

TF 包版本 5.7.0.25

Bug&Tip

  • Tips: 设置 abortWhenCutTemplateUnavailable 为 true 时,如果是静默合成,那么即使剪映模板不可用,也会继续进行分享,不会触发回调 fail 回调。
点击纠错
评价此篇文档