harmony 鸿蒙@ohos.file.picker (选择器)

  • 2023-06-24
  • 浏览 (1999)

@ohos.file.picker (选择器)

说明：

该模块接口从API version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

选择器(Picker)是一个封装PhotoViewPicker、DocumentViewPicker、AudioViewPicker等系统应用选择与保存能力的模块。应用可以自行选择使用哪种picker实现文件选择和文件保存的功能。该类接口，需要应用在界面UIAbility中调用，否则无法拉起photoPicker或FilePicker。

导入模块

import picker from '@ohos.file.picker';

PhotoViewPicker

图库选择器对象，用来支撑选择图片/视频和保存图片/视频等用户场景。选择文件推荐使用PhotoAccessHelper的PhotoViewPicker。在使用前，需要先创建PhotoViewPicker实例。

系统能力：SystemCapability.FileManagement.UserFileService

示例：

let photoPicker = new picker.PhotoViewPicker();

select

select(option?: PhotoSelectOptions) : Promise<PhotoSelectResult>

通过选择模式拉起photoPicker界面，用户可以选择一个或多个图片/视频。接口采用promise异步返回形式，传入可选参数PhotoSelectOptions对象，返回PhotoSelectResult对象。

注意：此接口返回的PhotoSelectResult对象中的photoUris只能通过临时授权的方式调用photoAccessHelper.getAssets接口去使用，具体使用方式参见用户文件uri介绍中的媒体文件uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option PhotoSelectOptions 否 photoPicker选择选项，若无此参数，则默认选择媒体文件类型为图片和视频类型，选择媒体文件数量的最大值为50

返回值：

类型 说明
Promise<PhotoSelectResult> Promise对象。返回photoPicker选择后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example01() {
  try {  
    let PhotoSelectOptions = new picker.PhotoSelectOptions();
    PhotoSelectOptions.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
    PhotoSelectOptions.maxSelectNumber = 5;
    let photoPicker = new picker.PhotoViewPicker();
    photoPicker.select(PhotoSelectOptions).then((PhotoSelectResult: picker.PhotoSelectResult) => {
      console.info('PhotoViewPicker.select successfully, PhotoSelectResult uri: ' + JSON.stringify(PhotoSelectResult));
    }).catch((err: BusinessError) => {
      console.error('PhotoViewPicker.select failed with err: ' + JSON.stringify(err));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('PhotoViewPicker failed with err: ' + JSON.stringify(err));
  }
}

select

select(option: PhotoSelectOptions, callback: AsyncCallback<PhotoSelectResult>) : void

通过选择模式拉起photoPicker界面，用户可以选择一个或多个图片/视频。接口采用callback异步返回形式，传入参数PhotoSelectOptions对象，返回PhotoSelectResult对象。

注意：此接口返回的PhotoSelectResult对象中的photoUris只能通过临时授权的方式调用photoAccessHelper.getAssets接口去使用，具体使用方式参见用户文件uri介绍中的媒体文件uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option PhotoSelectOptions 是 photoPicker选择选项
callback AsyncCallback<PhotoSelectResult> 是 callback 返回photoPicker选择后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example02() {
  try {
    let PhotoSelectOptions = new picker.PhotoSelectOptions();
    PhotoSelectOptions.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
    PhotoSelectOptions.maxSelectNumber = 5;
    let photoPicker = new picker.PhotoViewPicker();
    photoPicker.select(PhotoSelectOptions, (err: BusinessError, PhotoSelectResult: picker.PhotoSelectResult) => {
      if (err) {
        console.error('PhotoViewPicker.select failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('PhotoViewPicker.select successfully, PhotoSelectResult uri: ' + JSON.stringify(PhotoSelectResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('PhotoViewPicker failed with err: ' + JSON.stringify(err));
  }
}

select

select(callback: AsyncCallback<PhotoSelectResult>) : void

通过选择模式拉起photoPicker界面，用户可以选择一个或多个图片/视频。接口采用callback异步返回形式，返回PhotoSelectResult对象。

注意：此接口返回的PhotoSelectResult对象中的photoUris只能通过临时授权的方式调用photoAccessHelper.getAssets接口去使用，具体使用方式参见用户文件uri介绍中的媒体文件uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
callback AsyncCallback<PhotoSelectResult> 是 callback 返回photoPicker选择后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example03() {
  try {
    let photoPicker = new picker.PhotoViewPicker();
    photoPicker.select((err: BusinessError, PhotoSelectResult: picker.PhotoSelectResult) => {
      if (err) {
        console.error('PhotoViewPicker.select failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('PhotoViewPicker.select successfully, PhotoSelectResult uri: ' + JSON.stringify(PhotoSelectResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('PhotoViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(option?: PhotoSaveOptions) : Promise<Array<string>>

通过保存模式拉起photoPicker界面，用户可以保存一个或多个图片/视频。接口采用promise异步返回形式，传入可选参数PhotoSaveOptions对象，返回保存文件的uri数组。

注意：此接口会将文件保存在文件管理器，而不是图库。返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option PhotoSaveOptions 否 photoPicker保存图片或视频文件选项，若无此参数，则拉起photoPicker界面后需用户自行输入保存的文件名

返回值：

类型 说明
Promise<Array<string>> Promise对象。返回photoPicker保存图片或视频文件后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example04() {
  try {
    let PhotoSaveOptions = new picker.PhotoSaveOptions();
    PhotoSaveOptions.newFileNames = ['PhotoViewPicker01.jpg', 'PhotoViewPicker01.mp4'];
    let photoPicker = new picker.PhotoViewPicker();
    photoPicker.save(PhotoSaveOptions).then((PhotoSaveResult: Array<string>) => {
      console.info('PhotoViewPicker.save successfully, PhotoSaveResult uri: ' + JSON.stringify(PhotoSaveResult));
    }).catch((err: BusinessError) => {
      console.error('PhotoViewPicker.save failed with err: ' + JSON.stringify(err));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
      console.error('PhotoViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(option: PhotoSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过保存模式拉起photoPicker界面，用户可以保存一个或多个图片/视频。接口采用callback异步返回形式，传入参数PhotoSaveOptions对象，返回保存文件的uri数组。

注意：此接口会将文件保存在文件管理器，而不是图库。返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option PhotoSaveOptions 是 photoPicker保存图片或视频文件选项
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回photoPicker保存图片或视频文件后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example05() {
  try {
    let PhotoSaveOptions = new picker.PhotoSaveOptions();
    PhotoSaveOptions.newFileNames = ['PhotoViewPicker02.jpg','PhotoViewPicker02.mp4'];
    let photoPicker = new picker.PhotoViewPicker();
    photoPicker.save(PhotoSaveOptions, (err: BusinessError, PhotoSaveResult: Array<string>) => {
      if (err) {
        console.error('PhotoViewPicker.save failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('PhotoViewPicker.save successfully, PhotoSaveResult uri: ' + JSON.stringify(PhotoSaveResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('PhotoViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过保存模式拉起photoPicker界面，用户可以保存一个或多个图片/视频。接口采用callback异步返回形式，返回保存文件的uri数组。

注意：此接口会将文件保存在文件管理器，而不是图库。返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回photoPicker保存图片或视频文件后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example06() {
  try {
    let photoPicker = new picker.PhotoViewPicker();
    photoPicker.save((err: BusinessError, PhotoSaveResult: Array<string>) => {
      if (err) {
        console.error('PhotoViewPicker.save failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('PhotoViewPicker.save successfully, PhotoSaveResult uri: ' + JSON.stringify(PhotoSaveResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('PhotoViewPicker failed with err: ' + JSON.stringify(err));
  }
}

DocumentViewPicker

文件选择器对象，用来支撑选择和保存各种格式文档。在使用前，需要先创建DocumentViewPicker实例。

系统能力：SystemCapability.FileManagement.UserFileService

示例：

let documentPicker = new picker.DocumentViewPicker();

select

select(option?: DocumentSelectOptions) : Promise&lt;Array&lt;string&gt;&gt;

通过选择模式拉起documentPicker界面，用户可以选择一个或多个文件。接口采用promise异步返回形式，传入可选参数DocumentSelectOptions对象，返回选择文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option DocumentSelectOptions 否 documentPicker选择选项，若无此参数，则默认拉起documentPicker主界面

返回值：

类型 说明
Promise&lt;Array&lt;string&gt;&gt; Promise对象。返回documentPicker选择后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example07() {
  try {
    let DocumentSelectOptions = new picker.DocumentSelectOptions();
    let documentPicker = new picker.DocumentViewPicker();
    documentPicker.select(DocumentSelectOptions).then((DocumentSelectResult: Array<string>) => {
      console.info('DocumentViewPicker.select successfully, DocumentSelectResult uri: ' + JSON.stringify(DocumentSelectResult));
    }).catch((err: BusinessError) => {
      console.error('DocumentViewPicker.select failed with err: ' + JSON.stringify(err));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('DocumentViewPicker failed with err: ' + JSON.stringify(err));
  }
}

select

select(option: DocumentSelectOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过选择模式拉起documentPicker界面，用户可以选择一个或多个文件。接口采用callback异步返回形式，传入参数DocumentSelectOptions对象，返回选择文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option DocumentSelectOptions 是 documentPicker选择选项
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回documentPicker选择后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example08() {
  try {
    let DocumentSelectOptions = new picker.DocumentSelectOptions();
    let documentPicker = new picker.DocumentViewPicker();
    documentPicker.select(DocumentSelectOptions, (err: BusinessError, DocumentSelectResult: Array<string>) => {
      if (err) {
        console.error('DocumentViewPicker.select failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('DocumentViewPicker.select successfully, DocumentSelectResult uri: ' + JSON.stringify(DocumentSelectResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('DocumentViewPicker failed with err: ' + JSON.stringify(err));
  }
}

select

select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过选择模式拉起documentPicker界面，用户可以选择一个或多个文件。接口采用callback异步返回形式，返回选择文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回documentPicker选择后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example09() {
  try {
    let documentPicker = new picker.DocumentViewPicker();
    documentPicker.select((err: BusinessError, DocumentSelectResult: Array<string>) => {
      if (err) {
        console.error('DocumentViewPicker.select failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('DocumentViewPicker.select successfully, DocumentSelectResult uri: ' + JSON.stringify(DocumentSelectResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('DocumentViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(option?: DocumentSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;

通过保存模式拉起documentPicker界面，用户可以保存一个或多个文件。接口采用promise异步返回形式，传入可选参数DocumentSaveOptions对象，返回保存文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option DocumentSaveOptions 否 documentPicker保存选项，若无此参数，则拉起documentPicker界面后需用户自行输入保存的文件名

返回值：

类型 说明
Promise&lt;Array&lt;string&gt;&gt; Promise对象。返回documentPicker保存后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example10() {
  try {
    let DocumentSaveOptions = new picker.DocumentSaveOptions();
    DocumentSaveOptions.newFileNames = ['DocumentViewPicker01.txt'];
    let documentPicker = new picker.DocumentViewPicker();
    documentPicker.save(DocumentSaveOptions).then((DocumentSaveResult: Array<string>) => {
      console.info('DocumentViewPicker.save successfully, DocumentSaveResult uri: ' + JSON.stringify(DocumentSaveResult));
    }).catch((err: BusinessError) => {
      console.error('DocumentViewPicker.save failed with err: ' + JSON.stringify(err));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('DocumentViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(option: DocumentSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过保存模式拉起documentPicker界面，用户可以保存一个或多个文件。接口采用callback异步返回形式，传入参数DocumentSaveOptions对象，返回保存文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option DocumentSaveOptions 是 documentPicker保存选项
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回documentPicker保存后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example11() {
  try {
    let DocumentSaveOptions = new picker.DocumentSaveOptions();
    DocumentSaveOptions.newFileNames = ['DocumentViewPicker02.txt'];
    let documentPicker = new picker.DocumentViewPicker();
    documentPicker.save(DocumentSaveOptions, (err: BusinessError, DocumentSaveResult: Array<string>) => {
      if (err) {
        console.error('DocumentViewPicker.save failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('DocumentViewPicker.save successfully, DocumentSaveResult uri: ' + JSON.stringify(DocumentSaveResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('DocumentViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过保存模式拉起documentPicker界面，用户可以保存一个或多个文件。接口采用callback异步返回形式，返回保存文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回documentPicker保存后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example12() {
  try {
    let documentPicker = new picker.DocumentViewPicker();
    documentPicker.save((err: BusinessError, DocumentSaveResult: Array<string>) => {
      if (err) {
        console.error('DocumentViewPicker.save failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('DocumentViewPicker.save successfully, DocumentSaveResult uri: ' + JSON.stringify(DocumentSaveResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('DocumentViewPicker failed with err: ' + JSON.stringify(err));
  }
}

AudioViewPicker

音频选择器对象，用来支撑选择和保存音频类文件等用户场景。在使用前，需要先创建AudioViewPicker实例。

系统能力：SystemCapability.FileManagement.UserFileService

示例：

let audioPicker = new picker.AudioViewPicker();

select

select(option?: AudioSelectOptions) : Promise&lt;Array&lt;string&gt;&gt;

通过选择模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在规划中），用户可以选择一个或多个音频文件。接口采用promise异步返回形式，传入可选参数AudioSelectOptions对象，返回选择音频文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option AudioSelectOptions 否 audioPicker音频选择选项，若无此参数，则默认拉起audioPicker主界面

返回值：

类型 说明
Promise&lt;Array&lt;string&gt;&gt; Promise对象。返回audioPicker选择音频后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example13() {
  try {
    let AudioSelectOptions = new picker.AudioSelectOptions();
    let audioPicker = new picker.AudioViewPicker();
    audioPicker.select(AudioSelectOptions).then((AudioSelectResult: Array<string>) => {
      console.info('AudioViewPicker.select successfully, AudioSelectResult uri: ' + JSON.stringify(AudioSelectResult));
    }).catch((err: BusinessError) => {
      console.error('AudioViewPicker.select failed with err: ' + JSON.stringify(err));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('AudioViewPicker failed with err: ' + JSON.stringify(err));
  }
}

select

select(option: AudioSelectOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过选择模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在规划中），用户可以选择一个或多个音频文件。接口采用callback异步返回形式，传入参数AudioSelectOptions对象，返回选择音频文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option AudioSelectOptions 是 audioPicker音频选择选项
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回audioPicker选择音频后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example14() {
  try {
    let AudioSelectOptions = new picker.AudioSelectOptions();
    let audioPicker = new picker.AudioViewPicker();
    audioPicker.select(AudioSelectOptions, (err: BusinessError, AudioSelectResult: Array<string>) => {
      if (err) {
        console.error('AudioViewPicker.select failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('AudioViewPicker.select successfully, AudioSelectResult uri: ' + JSON.stringify(AudioSelectResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('AudioViewPicker failed with err: ' + JSON.stringify(err));
  }
}

select

select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过选择模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在规划中），用户可以选择一个或多个音频文件。接口采用callback异步返回形式，返回选择音频文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回audioPicker选择音频后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example15() {
  try {
    let audioPicker = new picker.AudioViewPicker();
    audioPicker.select((err: BusinessError, AudioSelectResult: Array<string>) => {
      if (err) {
        console.error('AudioViewPicker.select failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('AudioViewPicker.select successfully, AudioSelectResult uri: ' + JSON.stringify(AudioSelectResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('AudioViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(option?: AudioSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;

通过保存模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在规划中），用户可以保存一个或多个音频文件。接口采用promise异步返回形式，传入可选参数AudioSaveOptions对象，返回保存音频文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option AudioSaveOptions 否 audioPicker保存音频文件选项，若无此参数，则拉起audioPicker界面后需用户自行输入保存的文件名

返回值：

类型 说明
Promise&lt;Array&lt;string&gt;&gt; Promise对象。返回audioPicker保存音频文件后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example16() {
  try {
    let AudioSaveOptions = new picker.AudioSaveOptions();
    AudioSaveOptions.newFileNames = ['AudioViewPicker01.mp3'];
    let audioPicker = new picker.AudioViewPicker();
    audioPicker.save(AudioSaveOptions).then((AudioSaveResult: Array<string>) => {
      console.info('AudioViewPicker.save successfully, AudioSaveResult uri: ' + JSON.stringify(AudioSaveResult))
    }).catch((err: BusinessError) => {
      console.error('AudioViewPicker.save failed with err: ' + JSON.stringify(err));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('AudioViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(option: AudioSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过保存模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在规划中），用户可以保存一个或多个音频文件。接口采用callback异步返回形式，传入参数AudioSaveOptions对象，返回保存音频文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
option AudioSaveOptions 是 audioPicker保存音频文件选项
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回audioPicker保存音频文件后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example17() {
  try {
    let AudioSaveOptions = new picker.AudioSaveOptions();
    AudioSaveOptions.newFileNames = ['AudioViewPicker02.mp3'];
    let audioPicker = new picker.AudioViewPicker();
    audioPicker.save(AudioSaveOptions, (err: BusinessError, AudioSaveResult: Array<string>) => {
      if (err) {
        console.error('AudioViewPicker.save failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('AudioViewPicker.save successfully, AudioSaveResult uri: ' + JSON.stringify(AudioSaveResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('AudioViewPicker failed with err: ' + JSON.stringify(err));
  }
}

save

save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void

通过保存模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在规划中），用户可以保存一个或多个音频文件。接口采用callback异步返回形式，返回保存音频文件的uri数组。

注意：此接口返回的uri数组的具体使用方式参见用户文件uri介绍中的文档类uri的使用方式。

系统能力：SystemCapability.FileManagement.UserFileService

参数：

参数名 类型 必填 说明
callback AsyncCallback&lt;Array&lt;string&gt;&gt; 是 callback 返回audioPicker保存音频文件后的结果集

示例：

import { BusinessError } from '@ohos.base';
async function example18() {
  try {
    let audioPicker = new picker.AudioViewPicker();
    audioPicker.save((err: BusinessError, AudioSaveResult: Array<string>) => {
      if (err) {
        console.error('AudioViewPicker.save failed with err: ' + JSON.stringify(err));
        return;
      }
      console.info('AudioViewPicker.save successfully, AudioSaveResult uri: ' + JSON.stringify(AudioSaveResult));
    });
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error('AudioViewPicker failed with err: ' + JSON.stringify(err));
  }
}

PhotoViewMIMETypes

枚举，可选择的媒体文件类型。

系统能力： SystemCapability.FileManagement.UserFileService

名称 值 说明
IMAGE_TYPE ‘image/*’ 图片类型
VIDEO_TYPE ‘video/*’ 视频类型
IMAGE_VIDEO_TYPE ‘*/*’ 图片和视频类型

PhotoSelectOptions

图库选择选项。

系统能力： SystemCapability.FileManagement.UserFileService

名称 类型 必填 说明
MIMEType PhotoViewMIMETypes 否 可选择的媒体文件类型，若无此参数，则默认为图片和视频类型
maxSelectNumber number 否 选择媒体文件数量的最大值(默认值为50，最大值为500)

PhotoSelectResult

返回图库选择后的结果集。

系统能力： SystemCapability.FileManagement.UserFileService

名称 类型 可读 可写 说明
photoUris Array&lt;string&gt; 是 是 返回图库选择后的媒体文件的uri数组，此uri数组只能通过临时授权的方式调用photoAccessHelper.getAssets接口去使用，具体使用方式参见用户文件uri介绍中的媒体文件uri的使用方式。
isOriginalPhoto boolean 是 是 返回图库选择后的媒体文件是否为原图。

PhotoSaveOptions

图片或视频的保存选项。

系统能力： SystemCapability.FileManagement.UserFileService

名称 类型 必填 说明
newFileNames Array&lt;string&gt; 否 拉起photoPicker进行保存图片或视频资源的文件名，若无此参数，则默认需要用户自行输入

DocumentSelectOptions

文档选择选项。

系统能力： SystemCapability.FileManagement.UserFileService

名称 类型 必填 说明
maxSelectNumber10+ number 否 选择文件/目录最大个数，上限500，有效值范围1-500
defaultFilePathUri10+ string 否 指定选择的文件或者目录路径
fileSuffixFilters10+ Array&lt;string&gt; 否 选择文件的后缀类型

DocumentSaveOptions

文档保存选项。

系统能力： SystemCapability.FileManagement.UserFileService

名称 类型 必填 说明
newFileNames Array&lt;string&gt; 否 拉起documentPicker进行保存的文件名，若无此参数，则默认需要用户自行输入
defaultFilePathUri10+ string 否 指定保存的文件或者目录路径
fileSuffixChoices10+ Array&lt;string&gt; 否 保存文件的后缀类型

AudioSelectOptions

音频选择选项，目前不支持参数配置。

系统能力： SystemCapability.FileManagement.UserFileService

AudioSaveOptions

音频的保存选项。

系统能力： SystemCapability.FileManagement.UserFileService

名称 类型 必填 说明
newFileNames Array&lt;string&gt; 否 拉起audioPicker进行保存音频资源的文件名，若无此参数，则默认需要用户自行输入

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/d242e8a08ced4b8c8b10b5f2b19f25f7
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录