chooseMedia - 拍摄或从手机相册中选择图片或视频

chooseMedia(params: Object)

版本要求:

BaseKit≥2.5.0@ray-js/ray≥0.5.9

支持平台:

iOSAndroid

import { chooseMedia } from '@ray-js/ray';

// Promise 调用
try {
  const res = await chooseMedia({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

拍摄或从手机相册中选择图片或视频权限：[scope.camera, scope.writePhotosAlbum]

参数

属性	类型	必填	默认值	说明	BaseKit 最低版本
`count`	number	否	`9`	最多可以选择的文件数。注意：Android13以上的版本，使用的是系统图片选择器，该字段不生效	-
`mediaType`	string	否	`"image"`	选择类型, 默认图片 'image' 只能拍摄图片或从相册选择图片 'video' 只能拍摄视频或从相册选择视频	-
`sourceType`	string[]	否	`["album", "camera"]`	图片和视频选择的来源, 默认['album', 'camera'] 'album' 从相册选择 'camera' 使用相机拍摄	-
`maxDuration`	number	否	`10`	拍摄视频最长拍摄时间，单位秒。默认10s 时间范围为 3s 至 60s 之间。不限制相册。	-
`isFetchVideoFile`	boolean	否	`true`	该参数只对iOS有效是否拷贝视频：默认true，拷贝视频，返回视频拷贝地址，返回视频封面地址 false，不拷贝视频，返回视频相册中的地址，返回视频封面图地址	v3.14.2
`isClipVideo`	boolean	否	`false`	该参数只对iOS有效相册选择的视频是否需要裁剪默认为false, 不裁剪视频	v3.14.2
`maxClipDuration`	number	否	`60`	视频最长剪辑时间，单位秒。默认60s 需要设置isClipVideo为true才生效时间范围为 60s 至 600 之间。选择视频的时长小于15s不裁剪	v3.14.2
`isGetAlbumFileName`	boolean	否	`false`	该参数只对iOS有效选择导出的文件名称，和相册中文件的名称一致默认为false, 使用每次文件名称唯一	v3.14.2
`isClipVideoAndroid`	boolean	否	`true`	该参数只对Android有效芯图定制后续 isClipVideo合并相册选择的视频是否需要裁剪默认为true, 裁剪视频，与原业务表现一致	v3.32.13
`complete`	() => void	否	-	接口调用结束的回调函数（调用成功、失败都会执行）	-
`success`	(params: Object) => void	否	-	接口调用成功的回调函数	-
`fail`	(params: Object) => void	否	-	接口调用失败的回调函数	-

success 回调参数

属性	类型	说明	BaseKit 最低版本
`type`	string	文件类型 'image' 图片 'video' 视频	v3.2.6
		本地临时文件列表	v3.2.6

fail 回调参数

属性	类型	说明
`errorMsg`	string	错误信息
`errorCode`	string \| number	错误码
		错误扩展

返回值

无

示例代码

import { chooseMedia } from '@ray-js/ray'

// 拍摄或选择图片/视频（会拉起系统选择器，需手动选择）
chooseMedia({
  count: 1,
  mediaType: "image",
  sourceType: ["album", "camera"],
  maxDuration: 10,
  success: data => console.log("已选：", data.type, data.tempFiles),
  fail: error => console.error(error),
});