feat(taro): 增加对 chooseMedia API 的支持

NervJS · Apr 3, 2020 · 524c760 · 524c760
1 parent df60196
commit 524c760
Show file tree

Hide file tree

Showing 3 changed files with 175 additions and 0 deletions.
diff --git a/docs/apis/media/image/chooseMedia.md b/docs/apis/media/image/chooseMedia.md
@@ -0,0 +1,94 @@
+---
+title: Taro.chooseMedia(option)
+sidebar_label: chooseMedia
+---
+
+> 最低 Taro 版本: 2.10.0
+
+拍摄或从手机相册中选择图片或视频。
+
+> [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html)
+
+## 类型
+
+```tsx
+(option: Option) => Promise<SuccessCallbackResult>
+```
+
+## 参数
+
+### Option
+
+| 参数 | 类型 | 必填 | 说明 |
+| --- | --- | :---: | --- |
+| count | `number` | 否 | 最多可以选择的文件个数 |
+| mediaType | ("video" or "image")[] | 否 | 文件类型 |
+| sourceType | ("album" or "camera")[] | 否 | 图片和视频选择的来源 |
+| maxDuration | `number` | 否 | 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 30s 之间 |
+| sizeType | ("original" or "compressed")[] | 否 | 仅对 mediaType 为 image 时有效，是否压缩所选文件 |
+| camera | `string` | 否 | 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头 |
+| fail | `(res: CallbackResult) => void` | 否 | 接口调用失败的回调函数 |
+| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 |
+
+### SuccessCallbackResult
+
+| 参数 | 类型 | 说明 |
+| --- | --- | --- |
+| tempFiles | `ChooseMedia[]` | 本地临时文件列表 |
+| type | `string` | 文件类型，有效值有 image 、video |
+
+### ChooseMedia
+
+本地临时文件列表
+
+| 参数 | 类型 | 说明 |
+| --- | --- | --- |
+| tempFilePath | `string` | 本地临时文件路径 (本地路径) |
+| size | `number` | 本地临时文件大小，单位 B |
+| duration | `number` | 视频的时间长度 |
+| height | `number` | 视频的高度 |
+| width | `number` | 视频的宽度 |
+| thumbTempFilePath | `string` | 视频缩略图临时文件路径 |
+
+### mediaType
+
+| 参数 | 说明 |
+| --- | --- |
+| video | 只能拍摄视频或从相册选择视频 |
+| image | 只能拍摄图片或从相册选择图片 |
+
+### sourceType
+
+| 参数 | 说明 |
+| --- | --- |
+| album | 从相册选择 |
+| camera | 使用相机拍摄 |
+
+### camera
+
+| 参数 | 说明 |
+| --- | --- |
+| back | 使用后置摄像头 |
+| front | 使用前置摄像头 |
+
+## 示例代码
+
+```tsx
+wx.chooseMedia({
+  count: 9,
+  mediaType: ['image','video'],
+  sourceType: ['album', 'camera'],
+  maxDuration: 30,
+  camera: 'back',
+  success(res) {
+    console.log(res.tempFiles)
+    console.log(res.type)
+  }
+})
+```
+
+## API 支持度
+
+| API | 微信小程序 | H5 | React Native |
+| :---: | :---: | :---: | :---: |
+| Taro.chooseMedia | ✔️ |  |  |
diff --git a/packages/taro/src/native-apis.js b/packages/taro/src/native-apis.js
@@ -126,6 +126,7 @@ const otherApis = {
   // 媒体
   chooseImage: true,
   chooseMessageFile: true,
+  chooseMedia: true,
   previewImage: true,
   getImageInfo: true,
   compressImage: true,

diff --git a/packages/taro/types/api/media/image.d.ts b/packages/taro/types/api/media/image.d.ts
@@ -303,4 +303,84 @@ declare namespace Taro {
    * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.chooseMessageFile.html
    */
   function chooseMessageFile(option: chooseMessageFile.Option): Promise<chooseMessageFile.SuccessCallbackResult>
+
+  namespace chooseMedia {
+    interface Option {
+      /** 最多可以选择的文件个数 */
+      count?: number
+      /** 文件类型 */
+      mediaType?: Array<keyof mediaType>
+      /** 图片和视频选择的来源 */
+      sourceType?: Array<keyof sourceType>
+      /** 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 30s 之间 */
+      maxDuration?: number
+      /** 仅对 mediaType 为 image 时有效，是否压缩所选文件 */
+      sizeType?: Array<'original' | 'compressed'>
+      /** 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头 */
+      camera?: string
+      /** 接口调用失败的回调函数 */
+      fail?: (res: General.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends General.CallbackResult {
+      /** 本地临时文件列表 */
+      tempFiles: ChooseMedia[]
+      /** 文件类型，有效值有 image 、video */
+      type: string
+    }
+    /** 本地临时文件列表 */
+    interface ChooseMedia {
+      /** 本地临时文件路径 (本地路径) */
+      tempFilePath: string
+      /** 本地临时文件大小，单位 B */
+      size: number
+      /** 视频的时间长度 */
+      duration: number
+      /** 视频的高度 */
+      height: number
+      /** 视频的宽度 */
+      width: number
+      /** 视频缩略图临时文件路径 */
+      thumbTempFilePath: string
+    }
+    interface mediaType {
+      /** 只能拍摄视频或从相册选择视频 */
+      video
+      /** 只能拍摄图片或从相册选择图片 */
+      image
+    }
+    interface sourceType {
+      /** 从相册选择 */
+      album
+      /** 使用相机拍摄 */
+      camera
+    }
+    interface camera {
+      /** 使用后置摄像头 */
+      back
+      /** 使用前置摄像头 */
+      front
+    }
+  }
+  /** 拍摄或从手机相册中选择图片或视频。
+   * @supported weapp
+   * @since 2.10.0
+   * @example
+   * ```tsx
+   * wx.chooseMedia({
+   *   count: 9,
+   *   mediaType: ['image','video'],
+   *   sourceType: ['album', 'camera'],
+   *   maxDuration: 30,
+   *   camera: 'back',
+   *   success(res) {
+   *     console.log(res.tempFiles)
+   *     console.log(res.type)
+   *   }
+   * })
+   * ```
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html
+   */
+  function chooseMedia(option: chooseMedia.Option): Promise<chooseMedia.SuccessCallbackResult>
 }