gallery

Gallery模块管理系统相册，支持从相册中选择图片或视频文件、保存图片或视频文件到相册等功能。通过plus.gallery获取相册管理对象。

方法：

• pick: 从系统相册选择文件（图片或视频）
• save: 保存文件到系统相册中

对象：

• GalleryOption: JSON对象，从相册中选择文件的参数
• GalleryFilter: 相册选择文件过滤类型
• PopPosition: JSON对象，弹出拍照或摄像界面指示位置

回调方法：

• GalleryPickSuccessCallback: 单选系统相册图片成功的回调
• GalleryMultiplePickSuccessCallback: 多选系统相册图片成功的回调
• GallerySuccessCallback: 操作系统相册成功的回调
• GalleryErrorCallback: 系统相册操作失败的回调

权限：

permissions

"Gallery": {
	"description": "访问系统相册"
}
			

GalleryOption

JSON对象，从相册中选择文件的参数

属性：

• filename: (DOMString 类型 )选择文件保存的路径
  

  从系统相册中选择文件的保存路径，如果路径中包括文件后缀名称，则表明指定文件路径及名称，否则仅指定文件保存目录，文件名称由程序自动生成。

• filter: (GalleryFilter 类型 )相册中选择文件类型过滤器
  

  可通过此参数设定相册选择器中可选择的文件类型，可设置仅可选择图片文件或视频文件，默认值为仅可选择图片文件。

• multiple: (Boolean 类型 )是否支持多选图片
  

  可从系统相册中选择多张图片，选择图片后通过GalleryMultiplePickSuccessCallback回调返回选择的图片。

• animation: (Boolean 类型 )是否显示系统相册文件选择界面的动画
  

  是否显示系统相册文件选择界面的动画，可取值true、false，默认值为true。

• popover: (PopPosition 类型 )相册选择界面弹出指示区域
  

  对于大屏幕设备如iPad，相册选择界面为弹出窗口，此时可通过此参数设置弹出窗口位置。 其为JSON对象，格式如{top:"10",left:10,width:200,height:200}，所有值为像素值，左上坐标相对于容器的位置，默认弹出位置为屏幕居中。

GalleryFilter

相册选择文件过滤类型

属性：

• "image": (DOMString 类型 )仅可选择图片文件
  
• "video": (DOMString 类型 )仅可选择视频文件
  
• "none": (DOMString 类型 )不过滤，可选择图片或视频文件
  

PopPosition

JSON对象，弹出拍照或摄像界面指示位置

属性：

• top: (DOMString 类型 )指示区域距离容器顶部的距离
  

  弹出拍照或摄像窗口指示区域距离容器顶部的距离，单位支持像素值（如100px）和百分比（如50%），如不写单位则为像素值值。

• left: (DOMString 类型 )指示区域距离容器左侧的距离
  

  弹出拍照或摄像窗口指示区域距离容器左侧的距离，单位支持像素值（如100px）和百分比（如50%），如不写单位则为像素值。

• width: (DOMString 类型 )指示区域的宽度
  

  弹出拍照或摄像窗口指示区域的宽度，单位支持像素值（如100px）和百分比（如50%），如不写单位则为像素值。

• height: (DOMString 类型 )指示区域的高度
  

  弹出拍照或摄像窗口指示区域的高度，单位支持像素值（如100px）和百分比（如50%），如不写单位则为像素值。

GalleryPickSuccessCallback

单选系统相册图片成功的回调

void onSuccess( file ) {
	// Success code
}
				

说明：

系统相册中单选图片或视频文件成功的回调函数，在选择文件操作成功时调用。

参数：

• file: ( DOMString ) 必选 选择的图片或视频文件路径
  

返回值：

GalleryMultiplePickSuccessCallback

多选系统相册图片成功的回调

void onSuccess( event ) {
	// event.files 保存多选的图片或视频文件路径
}
				

说明：

系统相册中多选图片或视频文件成功的回调函数，在多选择文件操作成功时调用。

参数：

• event: ( Event ) 必选 多选系统相册返回数据
  Event对象包含以下属性： files - 字符串数组，保存多选的图片或视频文件路径。

返回值：

GallerySuccessCallback

操作系统相册成功的回调

void onSuccess() {
	// Success code
}
				

说明：

系统相册操作成功的回调函数，在保存文件到系统相册操作成功时调用。

参数：

无

返回值：

GalleryErrorCallback

系统相册操作失败的回调

void onError( error ) {
	// Error code.
}
				

说明：

系统相册操作失败的回调函数，在选择或保存图片操作失败时调用。

参数：

• error: ( DOMException ) 必选 相册操作失败的错误信息
  

返回值：