Skip to content

chooseMedia

描述

用于拍摄,或从系统相册中选择图片或视频。

网页应用需要完成鉴权后调用该接口。

支持说明

客户端平台WPS协作版本要求
iOS>=2.15.0
Android>=2.15.0
PC>=2.15.0

输入

名称数据类型是否必填描述
paramsobject
∟ cameraDevicestring使用相机拍摄时,默认使用的摄像头。可选值:
front:前置摄像头。
back:后置摄像头。
默认值:back
∟ countnumber最多可以选择的文件数量。
支持选择多个图片或多个视频,最多支持 9 个文件。
使用相机拍照或拍视频时,该字段失效。
PC 端文件选择器无法限制选择数量,若设置了该值,会默认截取前 N 个。
默认值:9
∟ isSaveToAlbumstring使用相机拍摄后图片是否保存到相册。仅 iOS 和 Android 支持,且在 sourceType为 camera时生效。可选值:
"0":不保存。
"1":保存。
默认值:"0"
∟ maxDurationnumber拍摄视频时支持的最长拍摄时间。单位为秒,时间范围为 3s 至 60s 之间。不限制相册。示例值:30
默认值:60
∟ mediaTypearray<string>文件类型。可选值:
["image"]:图片。
["video"]:视频。
["video", "image"]:视频或图片,不分顺序。
默认值:["image", "video"]
∟ sizeTypearray<string>选择原图或进行压缩。可选值:
["original"]:选择原图。
["compressed"]:强制对图片质量进行压缩。
["original","compressed"]:默认开启压缩,通过相册选取时可手动选择原图。
默认值:["original","compressed"]
注意:目前压缩仅图片生效,视频暂不支持压缩。
∟ sourceTypearray<string>指定视频来源。可选值:
["album"]:相册。
["camera"]:相机。
["album", "camera"]:相册或相机,不分顺序。
默认值:["album", "camera"]
注意:PC 端暂不支持设置该字段,默认为本地文件系统。

输出

名称类型描述
tempFilesarray<object>临时文件数组
∟ durationnumber视频时长,单位:秒(s)。选取文件类型为 video 时返回该字段。
PC 端暂不支持返回该字段。
∟ heightnumber图片/视频高度,单位 px。
PC 端暂不支持返回该字段。
∟ sizenumber图片/视频文件大小。单位:字节(Bytes)
∟ tempFilePathstring文件地址
∟ typeunion文件类型。可能值有:
image:图片
video:视频
∟ widthnumber图片/视频宽度,单位 px。
PC 端暂不支持返回该字段。

示例代码

ts
window.ksoxz_sdk.chooseMedia({ params, onSuccess, onError });

错误码

errnomsg含义
1041001user canceled用户取消操作
1021003Camera permission not obtained用户未授予 App 系统相机权限
1021004Album permission not obtained用户未授予 App 系统相册权限

除以上错误外,还可能存在公共错误,参考:公共错误码