選擇器

2024-01-23 16:32 更新
說明

該模塊接口從API Version 9開始支持。后續(xù)版本如有新增內(nèi)容，則采用上角標(biāo)單獨(dú)標(biāo)記該內(nèi)容的起始版本。

選擇器(Picker)是一個(gè)封裝PhotoViewPicker、DocumentViewPicker、AudioViewPicker等系統(tǒng)應(yīng)用選擇與保存能力的模塊。應(yīng)用可以自行選擇使用哪種picker實(shí)現(xiàn)文件選擇和文件保存的功能。

導(dǎo)入模塊

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

PhotoViewPicker

圖庫(kù)選擇器對(duì)象，用來支撐選擇圖片/視頻和保存圖片/視頻等用戶場(chǎng)景。在使用前，需要先創(chuàng)建PhotoViewPicker實(shí)例。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

示例：

  1. let photoPicker = new picker.PhotoViewPicker();

select

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

通過選擇模式拉起photoPicker界面，用戶可以選擇一個(gè)或多個(gè)圖片/視頻。接口采用promise異步返回形式，傳入可選參數(shù)PhotoSelectOptions對(duì)象，返回PhotoSelectResult對(duì)象。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

PhotoSelectOptions

否

photoPicker選擇選項(xiàng)，若無(wú)此參數(shù)，則默認(rèn)選擇媒體文件類型為圖片和視頻類型，選擇媒體文件數(shù)量的最大值為50。

返回值：

類型

說明

Promise<PhotoSelectResult>

Promise對(duì)象。返回photoPicker選擇后的結(jié)果集

示例：

  1. async function example() {
  2.   try {  
  3.     let PhotoSelectOptions = new picker.PhotoSelectOptions();
  4.     PhotoSelectOptions.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
  5.     PhotoSelectOptions.maxSelectNumber = 5;
  6.     let photoPicker = new picker.PhotoViewPicker();
  7.     photoPicker.select(PhotoSelectOptions).then((PhotoSelectResult) => {
  8.       console.info('PhotoViewPicker.select successfully, PhotoSelectResult uri: ' + JSON.stringify(PhotoSelectResult));
  9.     }).catch((err) => {
  10.       console.error('PhotoViewPicker.select failed with err: ' + err);
  11.     });
  12.   } catch (err) {
  13.     console.error('PhotoViewPicker failed with err: ' + err);
  14.   }
  15. }

select

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

通過選擇模式拉起photoPicker界面，用戶可以選擇一個(gè)或多個(gè)圖片/視頻。接口采用callback異步返回形式，傳入?yún)?shù)PhotoSelectOptions對(duì)象，返回PhotoSelectResult對(duì)象。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

PhotoSelectOptions

是

photoPicker選擇選項(xiàng)

callback

AsyncCallback<PhotoSelectResult>

是

callback 返回photoPicker選擇后的結(jié)果集

示例：

  1. async function example() {
  2.   try {   
  3.     let PhotoSelectOptions = new picker.PhotoSelectOptions();
  4.     PhotoSelectOptions.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
  5.     PhotoSelectOptions.maxSelectNumber = 5;
  6.     let photoPicker = new picker.PhotoViewPicker();
  7.     photoPicker.select(PhotoSelectOptions, (err, PhotoSelectResult) => {
  8.       if (err) {
  9.         console.error('PhotoViewPicker.select failed with err: ' + err);
  10.         return;
  11.       }
  12.       console.info('PhotoViewPicker.select successfully, PhotoSelectResult uri: ' + JSON.stringify(PhotoSelectResult));
  13.     });
  14.   } catch (err) {
  15.     console.error('PhotoViewPicker failed with err: ' + err);
  16.   }
  17. }

select

select(callback: AsyncCallback<PhotoSelectResult>) : void

通過選擇模式拉起photoPicker界面，用戶可以選擇一個(gè)或多個(gè)圖片/視頻。接口采用callback異步返回形式，返回PhotoSelectResult對(duì)象。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<PhotoSelectResult>

是

callback 返回photoPicker選擇后的結(jié)果集

示例：

  1. async function example() {
  2.   try {   
  3.     let photoPicker = new picker.PhotoViewPicker();
  4.     photoPicker.select((err, PhotoSelectResult) => {
  5.       if (err) {
  6.         console.error('PhotoViewPicker.select failed with err: ' + err);
  7.         return;
  8.       }
  9.       console.info('PhotoViewPicker.select successfully, PhotoSelectResult uri: ' + JSON.stringify(PhotoSelectResult));
  10.     });
  11.   } catch (err) {
  12.     console.error('PhotoViewPicker failed with err: ' + err);
  13.   }
  14. }

save

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

通過保存模式拉起photoPicker界面，用戶可以保存一個(gè)或多個(gè)圖片/視頻。接口采用promise異步返回形式，傳入可選參數(shù)PhotoSaveOptions對(duì)象，返回保存文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

PhotoSaveOptions

否

photoPicker保存圖片或視頻文件選項(xiàng)，若無(wú)此參數(shù)，則拉起photoPicker界面后需用戶自行輸入保存的文件名。

返回值：

類型

說明

Promise<Array<string>>

Promise對(duì)象。返回photoPicker保存圖片或視頻文件后的結(jié)果集

示例：

  1. async function example() {
  2.   try {   
  3.     let PhotoSaveOptions = new picker.PhotoSaveOptions();
  4.     PhotoSaveOptions.newFileNames = ['PhotoViewPicker01.jpg', 'PhotoViewPicker01.mp4'];
  5.     let photoPicker = new picker.PhotoViewPicker();
  6.     photoPicker.save(PhotoSaveOptions).then((PhotoSaveResult) => {
  7.       console.info('PhotoViewPicker.save successfully, PhotoSaveResult uri: ' + JSON.stringify(PhotoSaveResult));
  8.     }).catch((err) => {
  9.       console.error('PhotoViewPicker.save failed with err: ' + err);
  10.     });
  11.   } catch (err) {
  12.       console.error('PhotoViewPicker failed with err: ' + err);
  13.   }
  14. }

save

save(option: PhotoSaveOptions, callback: AsyncCallback<Array<string>>) : void

通過保存模式拉起photoPicker界面，用戶可以保存一個(gè)或多個(gè)圖片/視頻。接口采用callback異步返回形式，傳入?yún)?shù)PhotoSaveOptions對(duì)象，返回保存文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

PhotoSaveOptions

是

photoPicker保存圖片或視頻文件選項(xiàng)

callback

AsyncCallback<Array<string>>

是

callback 返回photoPicker保存圖片或視頻文件后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let PhotoSaveOptions = new picker.PhotoSaveOptions();
  4.     PhotoSaveOptions.newFileNames = ['PhotoViewPicker02.jpg','PhotoViewPicker02.mp4'];
  5.     let photoPicker = new picker.PhotoViewPicker();
  6.     photoPicker.save(PhotoSaveOptions, (err, PhotoSaveResult) => {
  7.       if (err) {
  8.         console.error('PhotoViewPicker.save failed with err: ' + err);
  9.         return;
  10.       }
  11.       console.info('PhotoViewPicker.save successfully, PhotoSaveResult uri: ' + JSON.stringify(PhotoSaveResult));
  12.     });
  13.   } catch (err) {
  14.     console.error('PhotoViewPicker failed with err: ' + err);
  15.   }
  16. }

save

save(callback: AsyncCallback<Array<string>>) : void

通過保存模式拉起photoPicker界面，用戶可以保存一個(gè)或多個(gè)圖片/視頻。接口采用callback異步返回形式，返回保存文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<string>>

是

callback 返回photoPicker保存圖片或視頻文件后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let photoPicker = new picker.PhotoViewPicker();
  4.     photoPicker.save((err, PhotoSaveResult) => {
  5.       if (err) {
  6.         console.error('PhotoViewPicker.save failed with err: ' + err);
  7.         return;
  8.       }
  9.       console.info('PhotoViewPicker.save successfully, PhotoSaveResult uri: ' + JSON.stringify(PhotoSaveResult));
  10.     });
  11.   } catch (err) {
  12.     console.error('PhotoViewPicker failed with err: ' + err);
  13.   }
  14. }

DocumentViewPicker

文件選擇器對(duì)象，用來支撐選擇和保存非媒體文件等用戶場(chǎng)景，比如各種格式文檔。在使用前，需要先創(chuàng)建DocumentViewPicker實(shí)例。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

示例：

  1. let documentPicker = new picker.DocumentViewPicker();

select

select(option?: DocumentSelectOptions) : Promise<Array<string>>

通過選擇模式拉起documentPicker界面，用戶可以選擇一個(gè)或多個(gè)文件。接口采用promise異步返回形式，傳入可選參數(shù)DocumentSelectOptions對(duì)象，返回選擇文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

DocumentSelectOptions

否

documentPicker選擇選項(xiàng)，若無(wú)此參數(shù)，則默認(rèn)拉起documentPicker主界面。

返回值：

類型

說明

Promise<Array<string>>

Promise對(duì)象。返回documentPicker選擇后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let DocumentSelectOptions = new picker.DocumentSelectOptions();
  4.     let documentPicker = new picker.DocumentViewPicker();
  5.     documentPicker.select(DocumentSelectOptions).then((DocumentSelectResult) => {
  6.       console.info('DocumentViewPicker.select successfully, DocumentSelectResult uri: ' + JSON.stringify(DocumentSelectResult));
  7.     }).catch((err) => {
  8.       console.error('DocumentViewPicker.select failed with err: ' + err);
  9.     });
  10.   } catch (err) {
  11.     console.error('DocumentViewPicker failed with err: ' + err);
  12.   }
  13. }

select

select(option: DocumentSelectOptions, callback: AsyncCallback<Array<string>>) : void

通過選擇模式拉起documentPicker界面，用戶可以選擇一個(gè)或多個(gè)文件。接口采用callback異步返回形式，傳入?yún)?shù)DocumentSelectOptions對(duì)象，返回選擇文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

DocumentSelectOptions

是

documentPicker選擇選項(xiàng)

callback

AsyncCallback<Array<string>>

是

callback 返回documentPicker選擇后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let DocumentSelectOptions = new picker.DocumentSelectOptions();
  4.     let documentPicker = new picker.DocumentViewPicker();
  5.     documentPicker.select(DocumentSelectOptions, (err, DocumentSelectResult) => {
  6.       if (err) {
  7.         console.error('DocumentViewPicker.select failed with err: ' + err);
  8.         return;
  9.       }
  10.       console.info('DocumentViewPicker.select successfully, DocumentSelectResult uri: ' + JSON.stringify(DocumentSelectResult));
  11.     });
  12.   } catch (err) {
  13.     console.error('DocumentViewPicker failed with err: ' + err);
  14.   }
  15. }

select

select(callback: AsyncCallback<Array<string>>) : void

通過選擇模式拉起documentPicker界面，用戶可以選擇一個(gè)或多個(gè)文件。接口采用callback異步返回形式，返回選擇文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<string>>

是

callback 返回documentPicker選擇后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let documentPicker = new picker.DocumentViewPicker();
  4.     documentPicker.select((err, DocumentSelectResult) => {
  5.       if (err) {
  6.         console.error('DocumentViewPicker.select failed with err: ' + err);
  7.         return;
  8.       }
  9.       console.info('DocumentViewPicker.select successfully, DocumentSelectResult uri: ' + JSON.stringify(DocumentSelectResult));
  10.     });
  11.   } catch (err) {
  12.     console.error('DocumentViewPicker failed with err: ' + err);
  13.   }
  14. }

save

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

通過保存模式拉起documentPicker界面，用戶可以保存一個(gè)或多個(gè)文件。接口采用promise異步返回形式，傳入可選參數(shù)DocumentSaveOptions對(duì)象，返回保存文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

DocumentSaveOptions

否

documentPicker保存選項(xiàng)，若無(wú)此參數(shù)，則拉起documentPicker界面后需用戶自行輸入保存的文件名。

返回值：

類型

說明

Promise<Array<string>>

Promise對(duì)象。返回documentPicker保存后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let DocumentSaveOptions = new picker.DocumentSaveOptions();
  4.     DocumentSaveOptions.newFileNames = ['DocumentViewPicker01.txt'];
  5.     let documentPicker = new picker.DocumentViewPicker();
  6.     documentPicker.save(DocumentSaveOptions).then((DocumentSaveResult) => {
  7.       console.info('DocumentViewPicker.save successfully, DocumentSaveResult uri: ' + JSON.stringify(DocumentSaveResult));
  8.     }).catch((err) => {
  9.       console.error('DocumentViewPicker.save failed with err: ' + err);
  10.     });
  11.   } catch (err) {
  12.     console.error('DocumentViewPicker failed with err: ' + err);
  13.   }
  14. }

save

save(option: DocumentSaveOptions, callback: AsyncCallback<Array<string>>) : void

通過保存模式拉起documentPicker界面，用戶可以保存一個(gè)或多個(gè)文件。接口采用callback異步返回形式，傳入?yún)?shù)DocumentSaveOptions對(duì)象，返回保存文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

DocumentSaveOptions

是

documentPicker保存選項(xiàng)

callback

AsyncCallback<Array<string>>

是

callback 返回documentPicker保存后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let DocumentSaveOptions = new picker.DocumentSaveOptions();
  4.     DocumentSaveOptions.newFileNames = ['DocumentViewPicker02.txt'];
  5.     let documentPicker = new picker.DocumentViewPicker();
  6.     documentPicker.save(DocumentSaveOptions, (err, DocumentSaveResult) => {
  7.       if (err) {
  8.         console.error('DocumentViewPicker.save failed with err: ' + err);
  9.         return;
  10.       }
  11.       console.info('DocumentViewPicker.save successfully, DocumentSaveResult uri: ' + JSON.stringify(DocumentSaveResult));
  12.     });
  13.   } catch (err) {
  14.     console.error('DocumentViewPicker failed with err: ' + err);
  15.   }
  16. }

save

save(callback: AsyncCallback<Array<string>>) : void

通過保存模式拉起documentPicker界面，用戶可以保存一個(gè)或多個(gè)文件。接口采用callback異步返回形式，返回保存文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<string>>

是

callback 返回documentPicker保存后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let documentPicker = new picker.DocumentViewPicker();
  4.     documentPicker.save((err, DocumentSaveResult) => {
  5.       if (err) {
  6.         console.error('DocumentViewPicker.save failed with err: ' + err);
  7.         return;
  8.       }
  9.       console.info('DocumentViewPicker.save successfully, DocumentSaveResult uri: ' + JSON.stringify(DocumentSaveResult));
  10.     });
  11.   } catch (err) {
  12.     console.error('DocumentViewPicker failed with err: ' + err);
  13.   }
  14. }

AudioViewPicker

音頻選擇器對(duì)象，用來支撐選擇和保存音頻類文件等用戶場(chǎng)景。在使用前，需要先創(chuàng)建AudioViewPicker實(shí)例。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

示例：

  1. let audioPicker = new picker.AudioViewPicker();

select

select(option?: AudioSelectOptions) : Promise<Array<string>>

通過選擇模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在規(guī)劃中），用戶可以選擇一個(gè)或多個(gè)音頻文件。接口采用promise異步返回形式，傳入可選參數(shù)AudioSelectOptions對(duì)象，返回選擇音頻文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

AudioSelectOptions

否

audioPicker音頻選擇選項(xiàng)，若無(wú)此參數(shù)，則默認(rèn)拉起audioPicker主界面。

返回值：

類型

說明

Promise<Array<string>>

Promise對(duì)象。返回audioPicker選擇音頻后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let AudioSelectOptions = new picker.AudioSelectOptions();
  4.     let audioPicker = new picker.AudioViewPicker();
  5.     audioPicker.select(AudioSelectOptions).then((AudioSelectResult) => {
  6.       console.info('AudioViewPicker.select successfully, AudioSelectResult uri: ' + JSON.stringify(AudioSelectResult));
  7.     }).catch((err) => {
  8.       console.error('AudioViewPicker.select failed with err: ' + err);
  9.     });
  10.   } catch (err) {
  11.     console.error('AudioViewPicker failed with err: ' + err);
  12.   }
  13. }

select

select(option: AudioSelectOptions, callback: AsyncCallback<Array<string>>) : void

通過選擇模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在規(guī)劃中），用戶可以選擇一個(gè)或多個(gè)音頻文件。接口采用callback異步返回形式，傳入?yún)?shù)AudioSelectOptions對(duì)象，返回選擇音頻文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

AudioSelectOptions

是

audioPicker音頻選擇選項(xiàng)

callback

AsyncCallback<Array<string>>

是

callback 返回audioPicker選擇音頻后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let AudioSelectOptions = new picker.AudioSelectOptions();
  4.     let audioPicker = new picker.AudioViewPicker();
  5.     audioPicker.select(AudioSelectOptions, (err, AudioSelectResult) => {
  6.       if (err) {
  7.         console.error('AudioViewPicker.select failed with err: ' + err);
  8.         return;
  9.       }
  10.       console.info('AudioViewPicker.select successfully, AudioSelectResult uri: ' + JSON.stringify(AudioSelectResult));
  11.     });
  12.   } catch (err) {
  13.     console.error('AudioViewPicker failed with err: ' + err);
  14.   }
  15. }

select

select(callback: AsyncCallback<Array<string>>) : void

通過選擇模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在規(guī)劃中），用戶可以選擇一個(gè)或多個(gè)音頻文件。接口采用callback異步返回形式，返回選擇音頻文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<string>>

是

callback 返回audioPicker選擇音頻后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let audioPicker = new picker.AudioViewPicker();
  4.     audioPicker.select((err, AudioSelectResult) => {
  5.       if (err) {
  6.         console.error('AudioViewPicker.select failed with err: ' + err);
  7.         return;
  8.       }
  9.       console.info('AudioViewPicker.select successfully, AudioSelectResult uri: ' + JSON.stringify(AudioSelectResult));
  10.     });
  11.   } catch (err) {
  12.     console.error('AudioViewPicker failed with err: ' + err);
  13.   }
  14. }

save

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

通過保存模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在規(guī)劃中），用戶可以保存一個(gè)或多個(gè)音頻文件。接口采用promise異步返回形式，傳入可選參數(shù)AudioSaveOptions對(duì)象，返回保存音頻文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

AudioSaveOptions

否

audioPicker保存音頻文件選項(xiàng)，若無(wú)此參數(shù)，則拉起audioPicker界面后需用戶自行輸入保存的文件名。

返回值：

類型

說明

Promise<Array<string>>

Promise對(duì)象。返回audioPicker保存音頻文件后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let AudioSaveOptions = new picker.AudioSaveOptions();
  4.     AudioSaveOptions.newFileNames = ['AudioViewPicker01.mp3'];
  5.     let audioPicker = new picker.AudioViewPicker();
  6.     audioPicker.save(AudioSaveOptions).then((AudioSaveResult) => {
  7.       console.info('AudioViewPicker.save successfully, AudioSaveResult uri: ' + JSON.stringify(AudioSaveResult))
  8.     }).catch((err) => {
  9.       console.error('AudioViewPicker.save failed with err: ' + err);
  10.     });
  11.   } catch (err) {
  12.     console.error('AudioViewPicker failed with err: ' + err);
  13.   }
  14. }

save

save(option: AudioSaveOptions, callback: AsyncCallback<Array<string>>) : void

通過保存模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在規(guī)劃中），用戶可以保存一個(gè)或多個(gè)音頻文件。接口采用callback異步返回形式，傳入?yún)?shù)AudioSaveOptions對(duì)象，返回保存音頻文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

option

AudioSaveOptions

是

audioPicker保存音頻文件選項(xiàng)

callback

AsyncCallback<Array<string>>

是

callback 返回audioPicker保存音頻文件后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let AudioSaveOptions = new picker.AudioSaveOptions();
  4.     AudioSaveOptions.newFileNames = ['AudioViewPicker02.mp3'];
  5.     let audioPicker = new picker.AudioViewPicker();
  6.     audioPicker.save(AudioSaveOptions, (err, AudioSaveResult) => {
  7.       if (err) {
  8.         console.error('AudioViewPicker.save failed with err: ' + err);
  9.         return;
  10.       }
  11.       console.info('AudioViewPicker.save successfully, AudioSaveResult uri: ' + JSON.stringify(AudioSaveResult));
  12.     });
  13.   } catch (err) {
  14.     console.error('AudioViewPicker failed with err: ' + err);
  15.   }
  16. }

save

save(callback: AsyncCallback<Array<string>>) : void

通過保存模式拉起audioPicker界面（目前拉起的是documentPicker，audioPicker在規(guī)劃中），用戶可以保存一個(gè)或多個(gè)音頻文件。接口采用callback異步返回形式，返回保存音頻文件的uri數(shù)組。

系統(tǒng)能力：SystemCapability.FileManagement.UserFileService

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<string>>

是

callback 返回audioPicker保存音頻文件后的結(jié)果集

示例：

  1. async function example() {
  2.   try {
  3.     let audioPicker = new picker.AudioViewPicker();
  4.     audioPicker.save((err, AudioSaveResult) => {
  5.       if (err) {
  6.         console.error('AudioViewPicker.save failed with err: ' + err);
  7.         return;
  8.       }
  9.       console.info('AudioViewPicker.save successfully, AudioSaveResult uri: ' + JSON.stringify(AudioSaveResult));
  10.     });
  11.   } catch (err) {
  12.     console.error('AudioViewPicker failed with err: ' + err);
  13.   }
  14. }

PhotoViewMIMETypes

枚舉，可選擇的媒體文件類型。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.FileManagement.UserFileService

名稱

值

說明

IMAGE_TYPE

'image/*'

圖片類型

VIDEO_TYPE

'video/*'

視頻類型

IMAGE_VIDEO_TYPE

'*/*'

圖片和視頻類型

PhotoSelectOptions

圖庫(kù)選擇選項(xiàng)。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.FileManagement.UserFileService

名稱

類型

必填

說明

MIMEType?

PhotoViewMIMETypes

否

可選擇的媒體文件類型，若無(wú)此參數(shù)，則默認(rèn)為圖片和視頻類型。

maxSelectNumber?

number

否

選擇媒體文件數(shù)量的最大值(默認(rèn)值為50，最大值為500)

PhotoSelectResult

返回圖庫(kù)選擇后的結(jié)果集。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.FileManagement.UserFileService

名稱

類型

可讀

可寫

說明

photoUris

Array<string>

是

是

返回圖庫(kù)選擇后的媒體文件的uri數(shù)組

isOriginalPhoto

boolean

是

是

返回圖庫(kù)選擇后的媒體文件是否為原圖

PhotoSaveOptions

圖片或視頻的保存選項(xiàng)。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.FileManagement.UserFileService

名稱

類型

必填

說明

newFileNames?

Array<string>

否

拉起photoPicker進(jìn)行保存圖片或視頻資源的文件名，若無(wú)此參數(shù)，則默認(rèn)需要用戶自行輸入。

DocumentSelectOptions

文檔選擇選項(xiàng)，目前不支持參數(shù)配置。

系統(tǒng)能力： SystemCapability.FileManagement.UserFileService

DocumentSaveOptions

文檔保存選項(xiàng)。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.FileManagement.UserFileService

名稱

類型

必填

說明

newFileNames?

Array<string>

否

拉起documentPicker進(jìn)行保存的文件名，若無(wú)此參數(shù)，則默認(rèn)需要用戶自行輸入。

AudioSelectOptions

音頻選擇選項(xiàng)，目前不支持參數(shù)配置。

系統(tǒng)能力： SystemCapability.FileManagement.UserFileService

AudioSaveOptions

音頻的保存選項(xiàng)。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.FileManagement.UserFileService

名稱

類型

必填

說明

newFileNames?

Array<string>

否

拉起audioPicker進(jìn)行保存音頻資源的文件名，若無(wú)此參數(shù)，則默認(rèn)需要用戶自行輸入。

以上內(nèi)容是否對(duì)您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)