@dcloudio/uni-app-x 0.7.41 → 0.7.42

package/types/uni/uts-plugin-api/lib/uni-chooseMedia/utssdk/interface.d.ts

@@ -0,0 +1,405 @@
+/**
+ * 错误码
+ */
+export type ChooseMediaErrorCode =
+	/**
+	 * 用户取消
+	 */
+	1101001 |
+	/**
+	 * 未获取权限
+	 */
+	1101005 |
+	/**
+	 * 图片或视频保存失败
+	 */
+	1101006 |
+	/**
+	 * 拍照或录像失败
+	 */
+	1101008;
+
+/**
+ * 图片或视频操作失败的错误回调
+ */
+export interface IChooseMediaError extends IUniError {
+	errCode : ChooseMediaErrorCode
+};
+export type ChooseMediaFileType = 'image' | 'video'
+export type ChooseMediaTempFile = {
+	/**
+	 * 选定视频的临时文件路径
+	 */
+	tempFilePath : string,
+	/**
+	 * 文件类型
+	 */
+	fileType : ChooseMediaFileType
+	/**
+	 * 选定视频的数据量大小
+	 */
+	size : number,
+	/**
+	 * 选定视频的时间长度
+	 */
+	duration ?: number | null,
+	/**
+	 * 返回选定视频的长
+	 */
+	height ?: number | null,
+	/**
+	 * 返回选定视频的宽
+	 */
+	width ?: number | null,
+	/**
+	 * 视频缩略图临时文件路径
+	 */
+	thumbTempFilePath ?: string | null
+}
+export type ChooseMediaSuccess = {
+	tempFiles : ChooseMediaTempFile[],
+	type : 'image' | 'video' | 'mix'
+};
+
+export type ChooseMediaFail = IChooseMediaError;
+export type ChooseMediaSuccessCallback = (callback : ChooseMediaSuccess) => void
+export type ChooseMediaFailCallback = (callback : ChooseMediaFail) => void
+export type ChooseMediaCompleteCallback = (callback : any) => void
+export type ChooseMediaPageOrientation = /**
+     * 自动
+     */
+	"auto" |
+	/**
+	 * 竖屏显示
+	 */
+	"portrait" |
+	/**
+	 * 横屏显示
+	 */
+	"landscape"
+
+export type ChooseMediaOptions = {
+	/**
+	  * 屏幕方向。默认为page.json中的pageOrientation。
+	  * @uniPlatform {
+	  *	 "app": {
+	  *		"android": {
+	  *			"osVer": "5.0",
+	  *			"uniVer": "4.42",
+	  *			"unixVer": "4.42"
+	  *		},
+	  *		"ios": {
+	  *			"osVer": "12.0",
+	  *			"uniVer": "4.42",
+	  *			"unixVer": "4.42"
+	  *		},
+	*    "harmony": {
+	*      "osVer": "3.0",
+	*      "uniVer": "4.31",
+	*      "unixVer": "x"
+	*    }
+	  *	},
+	 *  "mp": {
+	 *    "weixin": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "4.41"
+	 *    },
+	 *    "alipay": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "baidu": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "toutiao": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "lark": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "qq": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "kuaishou": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "jd": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    }
+	 *  },
+	  *	"web": {
+	  *		"uniVer": "x",
+	  *		"unixVer": "x"
+	  *	}
+	  * }
+	  */
+	pageOrientation ?: ChooseMediaPageOrientation | null,
+
+	/**
+	 * 最多可以选择的文件个数
+	 * @defaultValue 9
+	 */
+	count ?: number | null
+	/**
+	 * album 从相册选视频，camera 使用相机拍摄，合法值：'image'、'video'、'mix'
+	 * @defaultValue 	['image', 'video']
+	 */
+	mediaType ?: (string[]) | null,
+	/**
+	 * album 从相册选视频，camera 使用相机拍摄
+	 * @defaultValue ['album', 'camera']
+	 */
+	sourceType ?: (string[]) | null,
+	/**
+	 * 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 30s 之间
+	 * @defaultValue 10
+	 * @uniPlatform {
+	 * "app": {
+		 *		"android": {
+		 *			"osVer": "5.0",
+		 *			"uniVer": "4.42",
+		 *			"unixVer": "4.42"
+		 *		},
+		 *		"ios": {
+		 *			"osVer": "10.0",
+		 *			"uniVer": "4.42",
+		 *			"unixVer": "4.42"
+		 *		},
+   *    "harmony": {
+   *      "osVer": "3.0",
+   *      "uniVer": "4.31",
+   *      "unixVer": "x"
+   *    }
+	 *	},
+	*  "mp": {
+	*    "weixin": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "4.41"
+	*    },
+	*    "alipay": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "baidu": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "toutiao": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "lark": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "qq": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "kuaishou": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "jd": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    }
+	*  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "x"
+   *  }
+	 * }
+	 */
+	maxDuration ?: number | null,
+	/**
+	 * 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头
+	 *
+	 * @uniPlatform {
+	 * "app": {
+		 *		"android": {
+		 *			"osVer": "5.0",
+		 *			"uniVer": "4.42",
+		 *			"unixVer": "4.42"
+		 *		},
+		 *		"ios": {
+		 *			"osVer": "10.0",
+		 *			"uniVer": "4.42",
+		 *			"unixVer": "4.42"
+		 *		},
+   *    "harmony": {
+   *      "osVer": "3.0",
+   *      "uniVer": "4.25",
+   *      "unixVer": "x"
+   *    }
+	 *	},
+	*  "mp": {
+	*    "weixin": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "4.41"
+	*    },
+	*    "alipay": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "baidu": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "toutiao": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "lark": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "qq": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "kuaishou": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    },
+	*    "jd": {
+	*        "hostVer": "√",
+	*        "uniVer": "√",
+	*        "unixVer": "x"
+	*    }
+	*  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	camera ?:
+	/**
+	 * 前置摄像头
+	 */
+	'front' |
+	/**
+	 * 后置摄像头
+	 */
+	'back' | null,
+	/**
+	 * 接口调用成功，返回视频文件的临时文件路径，详见返回参数说明
+	 */
+	success ?: (ChooseMediaSuccessCallback) | null,
+	/**
+	 * 接口调用失败的回调函数
+	 */
+	fail ?: (ChooseMediaFailCallback) | null,
+	/**
+	 * 接口调用结束的回调函数（调用成功、失败都会执行）
+	 */
+	complete ?: (ChooseMediaCompleteCallback) | null
+};
+
+export type ChooseMedia = (options : ChooseMediaOptions) => void;
+
+export interface Uni {
+	/**
+	  * 拍摄或从手机相册中选择图片或视频。
+	  *
+	  * @tutorial https://uniapp.dcloud.net.cn/api/media/video.html#choosemedia
+	  * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/media/video.html#choosemedia
+	  * @uniPlatform {
+	  *	 "app": {
+	  *		"android": {
+	  *			"osVer": "x",
+	  *			"uniVer": "x",
+	  *			"unixVer": "x"
+	  *		},
+	  *		"ios": {
+	  *			"osVer": "x",
+	  *			"uniVer": "x",
+	  *			"unixVer": "x"
+	  *		},
+	  *    "harmony": {
+	  *      "osVer": "3.0",
+	  *      "uniVer": "4.31",
+	  *      "unixVer": "x"
+	  *    }
+	  *	},
+	 *  "mp": {
+	 *    "weixin": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "4.41"
+	 *    },
+	 *    "alipay": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "baidu": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "toutiao": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "lark": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "qq": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "kuaishou": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    },
+	 *    "jd": {
+	 *        "hostVer": "√",
+	 *        "uniVer": "√",
+	 *        "unixVer": "x"
+	 *    }
+	 *  },
+	*  "web": {
+	*    "uniVer": "x",
+	*    "unixVer": "x"
+	*  }
+	  * }
+	  */
+	 chooseMedia: ChooseMedia;
+
+}