宇信科技-新一代移动金融开发平台YUMP

# Gallery

# previewImage

预览图片 (全屏预览 左右滑动 同时支持在线地址的和本地地址)

  • 参数说明

    参数名 类型 必填 说明
    data Object 是 预览图片参数配置，详见下表
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • data参数说明

    参数名 类型 必填 说明
    current String 否 图片索引，默认显示第1张，current数值的范围[1, n], 其他值报53002「参数错误」
    urls Array 是 请求参数字符串或键值对，备注：urls至少一张图，否则报53002「参数错误」
    indicator String 否 图片指示器样式，可取值："default" - 底部圆点指示器； "number" - 顶部数字指示器； "none" - 不显示指示器。默认为"default"样式

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 失败请查看全局状态码
    message String 调用结果信息
    payload Object 详细结果，详见下表

  • payload返回参数说明

    参数名 类型 说明
    index Number 用户长按图片的索引值
    tapindex Number 用户点击按钮列表的索引值

  • 示例代码

var urls = [
    "https://goss.veer.com/creative/vcg/veer/800water/veer-150584093.jpg",
    "https://goss.veer.com/creative/vcg/veer/800water/veer-150594693.jpg",
    "https://goss.veer.com/creative/vcg/veer/800water/veer-148871099.jpg",
    "https://goss.veer.com/creative/vcg/veer/800water/veer-153787048.jpg"
];
foxsdk.gallery.previewImage({"current":"1","urls":urls,"indicator ":"default"}, ret => {
    console.log('gallery/previewImage===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# save

保存图片到相册 (支持网络地址与本地地址)

  • 参数说明

    参数名 类型 必填 说明
    url String 是 需要保存的图片相对地址，本地的URL地址必须是合法的路径,以_www,_documents,_doc,_downloads开头
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 失败请查看全局状态码
    message String 调用结果信息
    payload Object 回调结果

  • 返回payload参数说明

    参数名 类型 说明
    event Object 保存到相册后图片相关信息

  • 返回event参数说明

    参数名 类型 说明
    originalFilename String 保存图片文件名
    size String 保存图片大小，单位B
    url String 保存到相册后的路径

  • 状态描述

    • 65001：未找到本地或网络图资源
    • 65002：保存图片失败
    • 65003：必传参数为空

  • 示例代码

foxsdk.gallery.save('_doc/gallery/aa.png', ret => {
    console.log('gallery/save===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# pick

从系统相册选择文件（直接打开相册 支持选择图片或视频）

  • 参数说明

    参数名 类型 必填 说明
    data Object 是 请求参数键值对，详见下表
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • data参数说明

    参数名 类型 必填 说明
    pickType String 否 选则类型 1为单选，其他多项
    options GalleryOptions 否 从相册中选择文件的参数，详见下表

  • options参数说明

    参数名 类型 必填 说明
    filter String 否 册中选择文件类型过滤器 "image","video" , "none", 默认为image ,备注：仅支持image、video、none，其他报65004「参数错误」
    filename String 否 相册图片存放到沙盒中的路径,备注：filename默认_doc/gallery/（传空和不传都是默认），filename路径不合法：报53002「参数错误」
    maximum String 否 最多选择的图片数量,备注：只支持数字，其他字符、0、负数，报65004「参数错误」
    sizeType String 否 图片控制，0返回原图路径，1返回缩略图路径，2原图和缩率图路径都返。默认为2,备注：只支持0、1、2 其他参数报53002「参数错误」
    needCompressData String 否 是否返回压缩过后的base64,目前只有mpaas平台支持
    needOrignalData String 否 是否返回原图的base64,目前只有mpaas平台支持，原图base64过大会造成系统卡顿，慎重选择

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 失败请查看全局状态码
    message String 调用结果信息
    payload Object 回调结果

  • 返回payload参数说明

    参数名 类型 说明
    tempFiles Array[FileObject] 多选返回字段，为多路径的数组

  • 返回FileObject参数说明

    参数名 类型 说明
    size String 图片大小单位bite
    path String 图片本地相对路径
    name String 图片名字
    compressPath String 缩略图相对路径
    compressName String 缩略图名字
    width String 视频宽度（视频文件返回）
    height String 视频高度（视频文件返回)
    duration String 时长（视频文件返回）

  • 示例代码

var data = {
    "pickType": "1",
    "options":{
        filter:"image",
        maximum:"6",
        sizeType: '1',
        filename: '_doc/yuapp_temp_0002/gallery/'
    }
};
foxsdk.gallery.pick(data, ret => {
    console.log('gallery/pick===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# imageBase64

图片转Base64字符串 (本地图片)

  • 参数说明

    参数名 类型 必填 说明
    url String 是 需要转Base64图片的相对地址
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 失败请查看全局状态码
    message String 调用结果信息
    payload Object 回调结果

  • 返回payload参数说明

    参数名 类型 说明
    imageBase64 String 图片转换Base64后的字符串

  • 状态描述

    • 65003：必传参数为空

  • 示例代码

foxsdk.gallery.imageBase64("_doc/目录3/目录4/目录5/compress_IMG_7251.JPG", ret=>{
          foxsdk.logger.info('gallery/imageBase64===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));      
});

# pickSingleImageWithEdit

裁剪图片 （支持拍照裁剪和相册选图裁剪）

  • 参数说明

    参数名 类型 必填 说明
    type String 否 选图类型(0相机，1 相册)，默认：相册选图
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 失败请查看全局状态码
    message String 调用结果信息
    payload Object 回调结果

  • 返回payload参数说明

    参数名 类型 说明
    path String 裁剪后图片相对路径
    size String 文件大小

  • 状态描述

    • 65004：参数错误

  • 示例代码

var data = {"type":"0"}
foxsdk.gallery.pickSingleImageWithEdit(data, ret => {
    foxsdk.logger.info('gallery/cropImage===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});
Last Updated: 6/24/2024, 3:52:40 PM

← 音频录制/播放 →