• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 图片
  • tt.chooseImage
  • tt.saveImageToPhotosAlbum
  • tt.previewImage
  • tt.getImageInfo
  • tt.compressImage
  • 录音
  • 音频
  • 视频
  • 相机
  • 特效相机
  • Canvas 录制
  • rtc-room 实时通信
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • tt.saveImageToPhotosAlbum
    收藏
    我的收藏

    基础库 1.0.0 开始支持本方法,这是一个异步方法。

    保存图片到系统相册。

    前提条件
    业务背景
    使用限制
    注意事项
    手动取消也会触发失败回调,回调参数为 saveImageToPhotosAlbum:fail cancel,可以通过判断详细错误信息区分取消和其他错误。
    支持沙盒
    相关教程

    语法

    tt.saveImageToPhotosAlbum(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    filePathstring
    图片文件路径,可以是临时文件路径,如调用 `tt.downloadFile` 或 `tt.compressImage` 等 API 返回的路径。也可以是永久文件路径,不支持网络路径
    1.0.0
    successfunction
    接口调用成功的回调函数
    1.0.0
    failfunction
    接口调用失败的回调函数
    1.0.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.0.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "saveImageToPhotosAlbum:ok"
    1.0.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "saveImageToPhotosAlbum:fail" + 详细错误信息
    1.0.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    112090saveImageToPhotosAlbum:fail auth denyU
    拒绝授权

    用户未授予小程序授权,请引导用户按需授权,详情参考 用户授权

    1.0.0
    112089saveImageToPhotosAlbum:fail system auth denyU
    用户拒绝授权系统权限

    用户未授予系统权限,请引导用户按需授权

    1.0.0
    112002saveImageToPhotosAlbum:fail can't support this image formatD
    不支持的图片格式

    检查格式

    1.0.0
    112099saveImageToPhotosAlbum:fail filePath is invalidD
    filePath为空

    检查文件路径

    1.0.0
    112079saveImageToPhotosAlbum:fail api scope is not declared in the privacy agreementD
    隐私能力不在申请的 scope 内

    检查隐私协议

    1.0.0
    112001saveImageToPhotosAlbum:fail no such file or directory ${ttFilePath}D
    路径错误

    检查文件/文件夹路径

    1.0.0
    112080saveImageToPhotosAlbum:fail privacy permission is not authorizedU
    隐私协议未授权

    用户未授权隐私协议,请引导用户按需授权

    1.0.0
    112093saveImageToPhotosAlbum:fail unknown error xxxF
    小程序框架内部错误,有需要请创建工单咨询
    1.0.0
    112003saveImageToPhotosAlbum:fail permission denied, read xxxD
    无读权限

    检查文件/文件夹路径

    1.0.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, }); }, }); }, });