抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 基础
  • 渲染
  • 媒体
  • 图片
  • tt.chooseImage
  • tt.saveImageToPhotosAlbum
  • tt.previewImage
  • tt.getImageInfo
  • tt.compressImage
  • 音频
  • Canvas 录制
  • 数据缓存
  • TTML
  • 数据分析
  • 页面导航
  • 设备
  • 画布
  • 界面
  • 直播开放能力
  • tt.saveImageToPhotosAlbum
    收藏
    我的收藏

    基础库 3.41.0 开始支持本方法,这是一个异步方法。
    保存图片到系统相册。
    前提条件
    无
    业务背景
    无
    使用限制
    无
    注意事项
    手动取消也会触发失败回调,回调参数为 saveImageToPhotosAlbum:fail cancel,可以通过判断详细错误信息区分取消和其他错误。
    支持沙盒
    否
    相关教程
    无

    语法

    tt.saveImageToPhotosAlbum(options)

    参数说明

    options 为 object 类型,属性如下:
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    filePath
    string
    ​
    否
    图片文件路径,可以是临时文件路径,如调用 `tt.downloadFile` 或 `tt.compressImage` 等 API 返回的路径。也可以是永久文件路径,不支持网络路径
    3.41.0
    success
    function
    ​
    否
    接口调用成功的回调函数
    3.41.0
    fail
    function
    ​
    否
    接口调用失败的回调函数
    3.41.0
    complete
    function
    ​
    否
    接口调用结束的回调函数(调用成功、失败都会执行)
    3.41.0
    ​

    回调成功

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "saveImageToPhotosAlbum:ok"
    3.41.0
    ​

    回调失败

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "saveImageToPhotosAlbum:fail" + 详细错误信息
    3.41.0
    ​

    错误码

    errNo
    errMsg
    说明
    最低支持版本
    10201
    "saveImageToPhotosAlbum:fail privacy permission is not authorized"
    用户拒绝隐私协议授权,详见小程序隐私协议开发指南
    3.41.0
    10202
    "saveImageToPhotosAlbum:fail api scope is not declared in the privacy agreement"
    隐私协议中未定义相关隐私信息类型,详见配置隐私协议
    3.41.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    <!-- index.ttml --> <view class="card-area"> <image mode="widthFix" src="{{filePath}}" style="width: 300px"></image> <button type="primary" bindtap="saveImageToPhotosAlbum">保存</button> </view>
    // index.js Page({ data: { filePath: "https://s3.pstatp.com/toutiao/static/img/logo.201f80d.png", }, saveImageToPhotosAlbum() { tt.downloadFile({ url: this.data.filePath, header: { "content-type": "application/json", }, success: (res) => { let filePath = res.tempFilePath; tt.saveImageToPhotosAlbum({ filePath, // 暂不支持网络图片/本地图片地址,需与tt.downloadFile一起使用 success: (res) => { tt.showToast({ title: "成功保存到本地相册" }); }, fail: (err) => { let errType = err.errMsg.includes( "saveImageToPhotosAlbum:fail cancel" ) ? "取消保存" : "保存失败"; tt.showModal({ title: errType, content: err.errMsg, showCancel: false, }); }, }); }, fail: (err) => { tt.showModal({ title: "下载出错", content: err.errMsg, showCancel: false, }); }, }); }, });

    Bug & Tip

    Tip:手动取消也会触发失败回调,回调参数为 saveImageToPhotosAlbum:fail cancel,可以通过判断详细错误信息区分取消和其他错误。