更新日期:     浏览次数:

1. 多媒体

1.1. 文件

本页绍了和文件相关的JS-API方法,开发者可以根据应用的需求进行相应的配置。本页方法会不定期更新以满足更多应用个性化的开发需求。如果您有什么需求,欢迎在云之家开发者交流社区留言反馈,我们会根据您的需求进行优化。

1.1.1. 选择文件

调用代码:

qing.call('selectFile', {
    success: function(result){}
});

参数说明:

回调说明:

{
    success: true or false 是否成功(String)
    error: 错误信息(String)
    errorCode: 错误码(int)
    data:{
      files:[{
          fileId:   文件Id,String
          fileName: 文件名称,String
          fileExt:  文件后缀,String
          fileTime: 时间,String
          fileSize: 文件大小,int,单位:字节
      },...]
    }
}

1.1.2. 查看文件详情

调用代码:

qing.call('showFile', {
    'fileId':'hde22fdej233',
    'fileName':'计划',
    'fileExt':'ppt',
    'fileTime':'2014-11-28 13:23:54',
    'fileSize':35500,
    'success': function(result){}
});

参数说明:

参数名称 数据类型 必选 说明
fileId string 文件ID,第三方文件不传。
fileName string 文件名称
fileExt string 文件后缀
fileTime string 时间
fileSize int 文件大小,单位:字节
fileDownloadUrl string 文件下载地址,非云之家的第三方文件传入此参数,可直接下载并打开文件

回调说明:

1.2. 图片

本页介绍了和图片相关的JS-API方法,开发者可以根据应用的需求进行相应的配置。本页方法会不定期更新以满足更多应用个性化的开发需求。如果您有什么需求,欢迎在云之家开发者交流社区留言反馈,我们会根据您的需求进行优化。

1.2.1. 获取图片

功能说明:获取图片说的是调起云之家app的”获取图片”页,目前有2种方式:选择图片文件,或直接拍照。

调用代码:

qing.call('selectPic', {
    'type':'camera', 
    'success': function(result){
        alert("结果:"+JSON.stringify(result));
    }
});

参数说明:

参数名称 数据类型 必选 说明
type string 类型,“camera”代表“相机”,“photo”代表“相册”,不传表示从相机、相册中选择(Qing/0.9.10及以上支持。)

回调说明:

{
    success: true or false 是否成功(string)
    error: 错误信息(string)
    errorCode: 错误码(int)
    data: {
        fileExt:文件后缀(string)
        fileData:文件数据的base64字符串(string)
   }
}

data中字段说明:

字段名称 数据类型 说明
fileExt string 文件后缀。
fileData string 用户头像地址。

1.2.2. 预览图片

调用代码:

//0.9.16及以上版本支持
qing.call('previewImage', {
    'current':'url',
    'urls':['url1','url2'],
    'success': function(result){}
});

参数说明:

参数名称 数据类型 必选 说明
current string 当前显示图片的http链接
urls array(string) 需要预览的图片http链接列表

回调说明:

1.2.3. 保存图片到相册

qing.call('savePic', {
    'url':'xxxx'
    'success': function(result){
        // success: true or false 是否成功(String)
        // error: 错误信息(String)}
        // errorCode:错误码(String)
    }
});

1.2.4. 拍照或从手机相册中选图接口

qing.call('chooseImage', {
    'type':'camera',
    'needCut': false,
    'isMulti': false,
    'maxSelectCount': 9,
    'showOrigin': false,
    'success': function (res){
        alert(JSON.stringify(res))
    }
});
参数名称 数据类型 默认值 说明
type string 类型,“camera”代表“相机”,“photo”代表“相册”,不传表示从相机、相册中选择;多选此参数无用,只能从相册选择
needCut boolean false 是否需要裁剪处理
isMulti boolean 是否多选,当为true时,needCut参数无效
maxSelectCount int 9 当isMulti为true时需要传的参数 最大选择图片数
showOrigin boolean true 是否显示原图

返回值

{
    "localId": "",   // string 返回选定照片的本地ID列表,localId可以作为img标签的src属性显示图片
    "localIds": []   // array 多选时,只会通过这个参数返回选定照片的本地ID列表
}

备注:支持在webview内预览本地图片<img src="yzjLocalResource://img?id=xxxxxxx">

1.2.5. 上传图片接口

qing.call('uploadImage', {
    localId: '',
    isShowProgressTips: 1,
    success: function(result){
        alert(JSON.stringify(result))
    }
});
参数名称 数据类型 必选 说明
localId 需要上传的图片的本地ID,由chooseImage接口获得
isShowProgressTips 默认为1,显示进度提示

返回值

{
    success: true or false 是否成功(String)
    error: 错误信息(String)}
    data:{
        serverId:xxxx  //服务端文件id
        localId:xxx //需要上传的图片的本地ID
    }
}

备注:上传图片有效期3天,可用多媒体接口下载图片到自己的服务器,https://yunzhijia.com//openfile/download/media/{serverId} {serverId} 为服务端文件id

1.2.6. 下载图片接口

qing.call('downloadImage', {
    serverId: xxxx,
    isShowProgressTips: 1,
    success: function(result){
        alert(JSON.stringify(result))
    }
});
参数名称 数据类型 必选 说明
serverId 需要下载的图片的服务器端ID,由uploadImage接口获得
isShowProgressTips 默认为1,显示进度提示

返回值

{
    success: true or false 是否成功(String)
    error: 错误信息(String)}
    data:{
        localId: xxxx
    }
}

1.2.7. 获取本地图片接口(仅iOS)

qing.call('getLocalImgData', {
    localId: '',
    success: function(result){
        alert(JSON.stringify(result))
    }
});
参数名称 数据类型 必选 说明
localId 需要上传的图片的本地ID,由chooseImage接口获得

返回值

{
    success: true or false 是否成功(String)
    error: 错误信息(String)}
    data:{
        localData:"" // localData是图片的base64数据,可以用img标签显示
    }
}

备注:此接口仅在 iOS WKWebview 下提供,用于兼容 iOS WKWebview 不支持 localId 直接显示图片的问题。

1.3. 视频

1.3.1. 从手机相册中选择视频

qing.call('video.select', {
    "miniDuration": 10000,
    "maxDuration": 30000,
    "maxCount": 1,
    "success": function (result) {
        console.info(result.data)
    } 
})
参数名称 数据类型 必选 说明
miniDuration int 最小时长(毫秒)
maxDuration int 最大时长(毫秒)
maxCount int 默认1,最大取值 1 到 9

返回值

{
    "success": true,
    "data": {
        "videos": [
            {
                "localId":"\/storage\/emulated\/0\/DCIM\/Camera\/VID_20180706_143315.mp4",//视频本地id
                "duration":6014,//视频时长(毫秒)
                "size":8433001,//视频大小(字节)
                "thumbnailId":"\/storage\/emulated\/0\/DCIM\/.thumbnails\/1530858796054.jpg"//缩略图id
            }
        ]
    }
}

1.3.2. 录制视频

qing.call('video.startRecord', {
    "success": function (result) {
        console.info(result.data)
    } 
})

返回值

{
    "success": true,
    "data": {
        "videos": [
            {
                "localId":"\/storage\/emulated\/0\/DCIM\/Camera\/VID_20180706_143315.mp4",//视频本地id
                "duration":6014,//视频时长(毫秒)
                "size":8433001,//视频大小(字节)
                "thumbnailId":"\/storage\/emulated\/0\/DCIM\/.thumbnails\/1530858796054.jpg"//缩略图id
            }
        ]
    }
}

1.3.3. 上传视频

qing.call('video.upload', {
    "localId": "VID_20180706_143315.mp4",
    "compress": false,
    "success": function (result) {
        console.info(result.data)
    } 
})
参数名称 数据类型 必选 说明
localId
compress 0.9.75新增

返回值

{
    "success": true,
    "data": {
        "videos": [
            {
                "fileName":"VID_20180706_143315.mp4",//文件名
                "serverId":"VID_20180706_143315.mp4",//服务端文件id
            }
        ]
    }
}

备注:有效期3天,可用多媒体接口下载到自己的服务器,https://yunzhijia.com//openfile/download/media/{serverId} {serverId} 为服务端文件id

1.3.4. 下载视频

qing.call('video.download', {
    "serverId": "1",
    "success": function (result) {
        console.info(result.data)
    } 
})
参数名称 数据类型 必选 说明
serverId int

返回值

{
    "success": true,
    "data": {
        "videos": [
            {
                "localId":"\/storage\/emulated\/0\/DCIM\/Camera\/VID_20180706_143315.mp4",//视频本地id
                "duration":6014,//视频时长(毫秒)
                "size":8433001,//视频大小(字节)
                "thumbnailId":"\/storage\/emulated\/0\/DCIM\/.thumbnails\/1530858796054.jpg"//缩略图id
            }
        ]
    }
}

1.3.5. 播放视频

qing.call('video.play', {
    "localId": "1",
    "success": function (result) {
    } 
})
参数名称 数据类型 必选 说明
localId int

1.4. 音频

1.4.1. 开始录音接口

qing.call('startRecord', {
    success: function(res){
        alert(JSON.stringify(res))
    }
});

返回结果

{
    success: true or false 是否成功(String)
    error: 错误信息(String)//100权限错误;101无法录音;200 录音失败,请重试;0 默认正常
    data:{ //超时返回,满60s后自动停止录音返回
        localId:'xxx',  //本地id
        len:xxx      //时长
        format:amr   //格式
        size:xxx     //文件大小
        fileId:xxx     //文件id
    }
}

1.4.2. 停止录音接口

qing.call('stopRecord', {
    success: function(res){
        alert(JSON.stringify(res))
    }
});

返回结果

{
    success: true or false 是否成功(String)
    error: 错误信息(String)
    data:{
        localId:xxx
        len:xxx
        format:amr
        size:xxx
        fileId: xxx
    }
}

1.4.3. 播放语音接口

qing.call('playVoice', {
    localId: 'xxx',
    success: function(res){
        alert(JSON.stringify(res))
    }
});
参数名称 数据类型 必选 说明
localId

返回结果

{
    success: true or false 是否成功(String)
    error: 错误信息(String)
    errorCode:错误码(String//1.本地文件不存在,需要下载
    data:{
        playStatus: 0, // 0:开始播放  1:播放结束
    }
}

1.4.4. 暂停播放接口

qing.call('pauseVoice', {
    'localId':'xxx',
    success: function(res){
        alert(JSON.stringify(res))
    }
});
参数名称 数据类型 必选 说明
localId

返回结果

{
    success: true or false 是否成功(String)
    error: 错误信息(String)
    errorCode:错误码(String//1.本地文件不存在,需要下载
}

1.4.5. 停止播放接口

qing.call('stopVoice', {
    'localId':'xxx',
    success: function(res){
        alert(JSON.stringify(res))
    }
});
参数名称 数据类型 必选 说明
localId

返回结果

{
    success: true or false 是否成功(String)
    error: 错误信息(String)
    errorCode:错误码(String//1.本地文件不存在,需要下载
}

1.4.6. 上传语音接口

qing.call('uploadVoice', {
    'localId': 'xxxx',
    'isShowProgressTips': 1,
    success: function(res){
        alert(JSON.stringify(res))
    }
});
参数名称 数据类型 必选 说明
localId 需要上传的音频的本地ID,由stopRecord接口获得
isShowProgressTips int 默认为1,显示进度提示

返回结果

{
    success: true or false 是否成功(String)
    error: 错误信息(String)
    data:{
    serverId: 'xxxx'  //服务端文件id
}

备注:(0.9.51 新增)上传音频有效期3天,可用多媒体接口下载语音到自己的服务器,https://yunzhijia.com/openfile/download/media/{serverId} {serverId} 为服务端文件id

1.4.7. 下载语音接口

qing.call('downloadVoice', {
    'serverId':'xxxx',
    'isShowProgressTips': 1,
    'success': function(res){
        alert(JSON.stringify(res))
    }
});
参数名称 数据类型 必选 说明
serverId 需要下载的音频的服务器端ID,由uploadVoice接口获得
isShowProgressTips int 默认为1,显示进度提示

返回结果

{
    success: true or false 是否成功(String)
    error: 错误信息(String)
    data:{
        localId: xxxx
    }
}

results matching ""

    No results matching ""