js-apis-medialibrary.md 82.9 KB
Newer Older
W
wusongqing 已提交
1
# MediaLibrary
W
wusongqing 已提交
2

W
wusongqing 已提交
3 4
> **NOTE**
>
W
wusongqing 已提交
5 6 7 8
> This component is supported since API version 6. Updates will be marked with a superscript to indicate their earliest API version.

## Modules to Import
```
W
wusongqing 已提交
9
import mediaLibrary from '@ohos.multimedia.mediaLibrary';
W
wusongqing 已提交
10 11
```

W
wusongqing 已提交
12
## mediaLibrary.getMediaLibrary<sup>8+</sup>
W
wusongqing 已提交
13 14 15

getMediaLibrary(context: Context): MediaLibrary

W
wusongqing 已提交
16
Obtains a **MediaLibrary** instance, which is used to access and modify personal media data such as audios, videos, images, and documents.
W
wusongqing 已提交
17

18 19
This API can be used only in the stage model.

W
wusongqing 已提交
20 21 22 23
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
24 25 26
| Name | Type   | Mandatory| Description                      |
| ------- | ------- | ---- | -------------------------- |
| context | Context | Yes  | Context of the ability.|
W
wusongqing 已提交
27 28 29

**Return value**

W
wusongqing 已提交
30 31
| Type                           | Description   |
| ----------------------------- | :---- |
W
wusongqing 已提交
32 33
| [MediaLibrary](#medialibrary) | **MediaLibrary** instance.|

W
wusongqing 已提交
34 35 36 37 38 39 40
**Example (from API version 9)**

```
var media = mediaLibrary.getMediaLibrary(this.context);
```

**Example (API version 8)**
W
wusongqing 已提交
41 42 43 44 45 46 47

```
import featureAbility from '@ohos.ability.featureAbility';

var context = featureAbility.getContext()
var media = mediaLibrary.getMediaLibrary(context);
```
W
wusongqing 已提交
48 49 50 51 52 53
## mediaLibrary.getMediaLibrary

getMediaLibrary(): MediaLibrary

Obtains a **MediaLibrary** instance, which is used to access and modify personal media data such as audios, videos, images, and documents.

54 55
This API can be used only in the FA model.

W
wusongqing 已提交
56 57 58
> **NOTE**
>
> This API is no longer maintained since API version 8. You are advised to use [mediaLibrary.getMediaLibrary<sup>8+</sup>](#medialibrarygetmedialibrary8) instead.
W
wusongqing 已提交
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

| Type                         | Description      |
| ----------------------------- | :--------- |
| [MediaLibrary](#medialibrary) | **MediaLibrary** instance.|

**Example**

```js
var media = mediaLibrary.getMediaLibrary();
```

W
wusongqing 已提交
74 75
## MediaLibrary

W
wusongqing 已提交
76
### getFileAssets<sup>7+</sup>
W
wusongqing 已提交
77 78 79 80 81 82 83 84 85 86 87 88


getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileResult&gt;): void 

Obtains file assets (also called files). This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
89 90 91 92
| Name  | Type                                               | Mandatory| Description                             |
| -------- | --------------------------------------------------- | ---- | --------------------------------- |
| options  | [MediaFetchOptions](#mediafetchoptions7)            | Yes  | Options for fetching the files.                     |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | Yes  | Asynchronous callback of **FetchFileResult**.|
W
wusongqing 已提交
93 94 95 96 97 98 99 100 101 102

**Example**

```
let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = {
    selections: fileKeyObj.MEDIA_TYPE + '= ?',
    selectionArgs: [imageType.toString()],
};
W
wusongqing 已提交
103
media.getFileAssets(imagesfetchOp, (error, fetchFileResult) => {
W
wusongqing 已提交
104 105 106 107
    if (fetchFileResult != undefined) {
        console.info('mediaLibraryTest : ASSET_CALLBACK fetchFileResult success');
        fetchFileResult.getAllObject((err, fileAssetList) => {
            if (fileAssetList != undefined) {
W
wusongqing 已提交
108 109 110
                fileAssetList.forEach(function(getAllObjectInfo){
                    console.info("getAllObjectInfo.displayName :" + getAllObjectInfo.displayName);
                });
W
wusongqing 已提交
111 112 113 114 115
            }
    	});
    }
});
```
W
wusongqing 已提交
116
### getFileAssets<sup>7+</sup>
W
wusongqing 已提交
117 118 119 120 121 122 123 124 125 126 127

getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt;

Obtains file assets. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
128 129 130
| Name | Type                                    | Mandatory| Description        |
| ------- | ---------------------------------------- | ---- | ------------ |
| options | [MediaFetchOptions](#mediafetchoptions7) | Yes  | Options for fetching the files.|
W
wusongqing 已提交
131 132 133

**Return value**

W
wusongqing 已提交
134 135 136
| Type                                | Description          |
| ------------------------------------ | -------------- |
| [FetchFileResult](#fetchfileresult7) | Result set of the file retrieval operation.|
W
wusongqing 已提交
137 138 139 140 141 142 143 144 145 146

**Example**

```
let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = {
    selections: fileKeyObj.MEDIA_TYPE + '= ?',
    selectionArgs: [imageType.toString()],
};
W
wusongqing 已提交
147
media.getFileAssets(imagesfetchOp).then(function(fetchFileResult){
W
wusongqing 已提交
148
    console.info("getFileAssets successfully: image number is "+ fetchFileResult.getCount());
W
wusongqing 已提交
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
}).catch(function(err){
    console.info("getFileAssets failed with error:"+ err);
});
```

### on<sup>8+</sup>

on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback&lt;void&gt;): void

Subscribes to the media library changes. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
164 165 166 167
| Name     | Type                  | Mandatory  | Description                                      |
| -------- | -------------------- | ---- | ---------------------------------------- |
| type     | string               | Yes   | Media type.<br>'deviceChange': registered device change<br>'albumChange': album change<br>'imageChange': image file change<br>'audioChange': audio file change<br>'videoChange': video file change<br>'fileChange': file change<br>'remoteFileChange': file change on the registered device|
| callback | callback&lt;void&gt; | Yes   | Void callback.                                   |
W
wusongqing 已提交
168 169 170 171

**Example**

```
W
wusongqing 已提交
172
media.on('imageChange', () => {
W
wusongqing 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185
    // image file had changed, do something
})
```
### off<sup>8+</sup>

off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback&lt;void&gt;): void

Unsubscribes from the media library changes. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
186 187 188 189
| Name     | Type                  | Mandatory  | Description                                      |
| -------- | -------------------- | ---- | ---------------------------------------- |
| type     | string               | Yes   | Media type.<br>'deviceChange': registered device change<br>'albumChange': album change<br>'imageChange': image file change<br>'audioChange': audio file change<br>'videoChange': video file change<br>'fileChange': file change<br>'remoteFileChange': file change on the registered device|
| callback | callback&lt;void&gt; | No   | Void callback.                                   |
W
wusongqing 已提交
190 191 192 193

**Example**

```
W
wusongqing 已提交
194
media.off('imageChange', () => {
W
wusongqing 已提交
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
    // stop listening success
})
```

### createAsset <sup>8+</sup>

createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback&lt;FileAsset&gt;): void

Creates a media asset. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
211 212 213 214 215 216
| Name      | Type                                   | Mandatory| Description                                                        |
| ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ |
| mediaType    | [MediaType](#mediatype8)                | Yes  | Media type.                                                    |
| displayName  | string                                  | Yes  | Display file name.                                                  |
| relativePath | string                                  | Yes  | Path for storing the file. You can use [getPublicDirectory](#getpublicdirectory8) to obtain the paths for storing different types of files.|
| callback     | AsyncCallback<[FileAsset](#fileasset7)> | Yes  | Asynchronous callback for **FileAsset**.                         |
W
wusongqing 已提交
217 218 219 220 221 222 223 224 225

**Example**

```
async function example() {
    // Create an image file in callback mode.
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
W
wusongqing 已提交
226
    media.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (err, fileAsset) => {
W
wusongqing 已提交
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
        if (fileAsset != undefined) {
            console.info('createAsset successfully, message = ' + err);
        } else {
            console.info('createAsset failed, message = ' + err);
        }
    });
}
```

### createAsset<sup>8+</sup>

createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise&lt;FileAsset&gt;

Creates a media asset. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
248 249 250 251 252
| Name      | Type                    | Mandatory| Description                                                        |
| ------------ | ------------------------ | ---- | ------------------------------------------------------------ |
| mediaType    | [MediaType](#mediatype8) | Yes  | Media type.                                                    |
| displayName  | string                   | Yes  | Display file name.                                                  |
| relativePath | string                   | Yes  | Relative path. You can use [getPublicDirectory](#getpublicdirectory8) to obtain the relative path of the level-1 directory of different types of media files.|
W
wusongqing 已提交
253 254 255

**Return value**

W
wusongqing 已提交
256 257 258
| Type                    | Description             |
| ------------------------ | ----------------- |
| [FileAsset](#fileasset7) | Media data (FileAsset).|
W
wusongqing 已提交
259 260 261 262

**Example**

```
263 264 265 266 267 268
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
media.getPublicDirectory(DIR_CAMERA).then(function(dicResult){
    console.info("getPublicDirectory successfully:"+ JSON.stringify(dicResult));
}).catch(function(err){
    console.info("getPublicDirectory failed with error:"+ err);
});
W
wusongqing 已提交
269 270 271 272 273 274 275 276 277 278 279 280
```

### getPublicDirectory<sup>8+</sup>

getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;): void

Obtains a public directory. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
281 282 283 284
| Name  | Type                            | Mandatory| Description                     |
| -------- | -------------------------------- | ---- | ------------------------- |
| type     | [DirectoryType](#directorytype8) | Yes  | Type of the public directory.             |
| callback | AsyncCallback&lt;string&gt;      | Yes  | Callback used to return the public directory.|
W
wusongqing 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308

**Example**

```
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => {
    if (dicResult == 'Camera/') {
        console.info('mediaLibraryTest : getPublicDirectory passed');
    } else {
        console.info('mediaLibraryTest : getPublicDirectory failed');
    }
});
```

### getPublicDirectory<sup>8+</sup>

getPublicDirectory(type: DirectoryType): Promise&lt;string&gt;

Obtains a public directory. This API uses a promise to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
309 310 311
| Name| Type                            | Mandatory| Description        |
| ------ | -------------------------------- | ---- | ------------ |
| type   | [DirectoryType](#directorytype8) | Yes  | Type of the public directory.|
W
wusongqing 已提交
312 313 314

**Return value**

W
wusongqing 已提交
315 316 317
| Type            | Description            |
| ---------------- | ---------------- |
| Promise\<string> | Promise used to return the public directory.|
W
wusongqing 已提交
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332

**Example**

```
async function example() {
    let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
    const dicResult = await media.getPublicDirectory(DIR_CAMERA);
    if (dicResult == 'Camera/') {
        console.info('MediaLibraryTest : getPublicDirectory');
    } else {
        console.info('MediaLibraryTest : getPublicDirectory failed');
    }
}
```

W
wusongqing 已提交
333
### getAlbums<sup>7+</sup>
W
wusongqing 已提交
334 335 336 337 338 339 340 341 342 343 344

getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array&lt;Album&gt;>): void

Obtains the albums. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
345 346 347 348
| Name  | Type                                        | Mandatory| Description                       |
| -------- | -------------------------------------------- | ---- | --------------------------- |
| options  | [MediaFetchOptions](#mediafetchoptions7)     | Yes  | Options for fetching the albums.               |
| callback | AsyncCallback&lt;Array<[Album](#album7)>&gt; | Yes  | Callback used to return the albums.|
W
wusongqing 已提交
349 350 351 352 353 354 355 356

**Example**

```
let AlbumNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
};
W
wusongqing 已提交
357
media.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => {
W
wusongqing 已提交
358 359 360 361 362 363 364 365 366 367
    if (albumList != undefined) {
        const album = albumList[0];
        console.info('album.albumName = ' + album.albumName);
        console.info('album.count = ' + album.count);
     } else {
        console.info('getAlbum fail, message = ' + err);
     }
})
```

W
wusongqing 已提交
368
### getAlbums<sup>7+</sup>
W
wusongqing 已提交
369 370 371 372 373 374 375 376 377 378 379

getAlbums(options: MediaFetchOptions): Promise<Array&lt;Album&gt;>

Obtains the albums. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
380 381 382
| Name | Type                                    | Mandatory| Description        |
| ------- | ---------------------------------------- | ---- | ------------ |
| options | [MediaFetchOptions](#mediafetchoptions7) | Yes  | Options for fetching the albums.|
W
wusongqing 已提交
383 384 385

**Return value**

W
wusongqing 已提交
386 387 388
| Type                            | Description         |
| -------------------------------- | ------------- |
| Promise<Array<[Album](#album7)>> | Promise used to return the albums.|
W
wusongqing 已提交
389 390 391 392 393 394 395 396

**Example**

```
let AlbumNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
};
W
wusongqing 已提交
397
media.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){
W
wusongqing 已提交
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
    console.info("getAlbums successfully:"+ JSON.stringify(albumList));
}).catch(function(err){
    console.info("getAlbums failed with error:"+ err);
});
```

### release<sup>8+</sup>

release(callback: AsyncCallback&lt;void&gt;): void

Releases this **MediaLibrary** instance.
Call this API when you no longer need to use the APIs in the **MediaLibrary** instance.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
415 416 417
| Name     | Type                       | Mandatory  | Description        |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | Yes   | Callback used to return the execution result.|
W
wusongqing 已提交
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438

**Example**

```
var media = mediaLibrary.getMediaLibrary(context);
media.release((err) => {
    // do something
});
```

### release<sup>8+</sup>

release(): Promise&lt;void&gt;

Releases this **MediaLibrary** instance.
Call this API when you no longer need to use the APIs in the **MediaLibrary** instance.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
439 440
| Type                 | Description                  |
| ------------------- | -------------------- |
W
wusongqing 已提交
441 442 443 444 445 446 447 448
| Promise&lt;void&gt; | Promise used to return the execution result.|

**Example**

```
media.release()
```

W
wusongqing 已提交
449
### storeMediaAsset<sup>(deprecated)</sup>
W
wusongqing 已提交
450 451 452 453 454

storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;): void

Stores a media asset. This API uses an asynchronous callback to return the URI that stores the media asset.

W
wusongqing 已提交
455 456 457
> **NOTE**
>
> This API is deprecated since API version 9.
W
wusongqing 已提交
458 459 460 461 462

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
463 464 465 466
| Name     | Type                                   | Mandatory  | Description                     |
| -------- | ------------------------------------- | ---- | ----------------------- |
| option   | [MediaAssetOption](#mediaassetoption) | Yes   | Media asset option.                |
| callback | AsyncCallback&lt;string&gt;           | Yes   | Callback used to return the URI that stores the media asset.|
W
wusongqing 已提交
467 468 469 470 471

**Example**

  ```
let option = {
W
wusongqing 已提交
472 473 474
    src : "/data/storage/el2/base/haps/entry/image.png",
    mimeType : "image/*",
    relativePath : "Pictures/"
W
wusongqing 已提交
475 476 477 478 479 480
};
mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => {
    if (err) {
        console.log("An error occurred when storing the media asset.");
        return;
    }
W
wusongqing 已提交
481
    console.log("Media asset stored.");
W
wusongqing 已提交
482 483 484 485 486
    // Obtain the URI that stores the media asset.
});
  ```


W
wusongqing 已提交
487
### storeMediaAsset<sup>(deprecated)</sup>
W
wusongqing 已提交
488 489 490 491 492

storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt;

Stores a media asset. This API uses a promise to return the URI that stores the media asset.

W
wusongqing 已提交
493 494 495
> **NOTE**
>
> This API is deprecated since API version 9.
W
wusongqing 已提交
496 497 498 499 500

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
501 502 503
| Name   | Type                                   | Mandatory  | Description     |
| ------ | ------------------------------------- | ---- | ------- |
| option | [MediaAssetOption](#mediaassetoption) | Yes   | Media asset option.|
W
wusongqing 已提交
504 505 506

**Return value**

W
wusongqing 已提交
507 508
| Type                   | Description                          |
| --------------------- | ---------------------------- |
W
wusongqing 已提交
509 510 511 512 513 514
| Promise&lt;string&gt; | Promise used to return the URI that stores the media asset.|

**Example**

  ```
let option = {
W
wusongqing 已提交
515 516 517
    src : "/data/storage/el2/base/haps/entry/image.png",
    mimeType : "image/*",
    relativePath : "Pictures/"
W
wusongqing 已提交
518 519 520 521 522 523 524 525 526 527
};
mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => {
    console.log("Media asset stored.");
    // Obtain the URI that stores the media asset.
}).catch((err) => {
    console.log("An error occurred when storing the media assets.");
});
  ```


W
wusongqing 已提交
528
### startImagePreview<sup>(deprecated)</sup>
W
wusongqing 已提交
529 530 531 532 533

startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCallback&lt;void&gt;): void

Starts image preview, with the first image to preview specified. This API can be used to preview local images whose URIs start with **dataability://** or online images whose URIs start with **https://**. It uses an asynchronous callback to return the execution result.

W
wusongqing 已提交
534 535 536
> **NOTE**
>
> This API is deprecated since API version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. The **\<Image>** component can be used to render and display local and online images.
W
wusongqing 已提交
537 538 539 540 541

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
542 543
| Name     | Type                       | Mandatory  | Description                                      |
| -------- | ------------------------- | ---- | ---------------------------------------- |
W
wusongqing 已提交
544
| images   | Array&lt;string&gt;       | Yes   | URIs of the images to preview. The value can start with either **dataability://** or **https://**.|
W
wusongqing 已提交
545 546
| index    | number                    | Yes   | Index of the first image to preview.                              |
| callback | AsyncCallback&lt;void&gt; | Yes   | Callback used to return the image preview result. If the preview fails, an error message is returned.                       |
W
wusongqing 已提交
547 548 549 550 551

**Example**

  ```
let images = [
W
wusongqing 已提交
552 553
    "dataability:///media/xxxx/2",
    "dataability:///media/xxxx/3"
W
wusongqing 已提交
554
];
W
wusongqing 已提交
555
/* Preview online images.
W
wusongqing 已提交
556 557 558 559
let images = [
    "https://media.xxxx.com/image1.jpg",
    "https://media.xxxx.com/image2.jpg"
];
W
wusongqing 已提交
560
*/
W
wusongqing 已提交
561 562 563 564 565 566 567 568 569 570 571
let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => {
    if (err) {
        console.log("An error occurred when previewing the images.");
        return;
    }
    console.log("Succeeded in previewing the images.");
});
  ```


W
wusongqing 已提交
572
### startImagePreview<sup>(deprecated)</sup>
W
wusongqing 已提交
573 574 575 576 577

startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void

Starts image preview. This API can be used to preview local images whose URIs start with **dataability://** or online images whose URIs start with **https://**. It uses an asynchronous callback to return the execution result.

W
wusongqing 已提交
578 579
> **NOTE**
>
580
> This API is deprecated since API version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. The **\<Image>** component can be used to render and display local and online images.
W
wusongqing 已提交
581 582 583 584 585

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
586 587 588 589
| Name     | Type                       | Mandatory  | Description                                      |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| images   | Array&lt;string&gt;       | Yes   | URIs of the images to preview. The value can start with either **https://** or **dataability://**.|
| callback | AsyncCallback&lt;void&gt; | Yes   | Callback used to return the image preview result. If the preview fails, an error message is returned.                       |
W
wusongqing 已提交
590 591 592 593 594

**Example**

  ```
let images = [
W
wusongqing 已提交
595 596
    "dataability:///media/xxxx/2",
    "dataability:///media/xxxx/3"
W
wusongqing 已提交
597
];
W
wusongqing 已提交
598
/* Preview online images.
W
wusongqing 已提交
599 600 601 602
let images = [
    "https://media.xxxx.com/image1.jpg",
    "https://media.xxxx.com/image2.jpg"
];
W
wusongqing 已提交
603
*/
W
wusongqing 已提交
604 605 606 607 608 609 610 611 612 613
mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => {
    if (err) {
        console.log("An error occurred when previewing the images.");
        return;
    }
    console.log("Succeeded in previewing the images.");
});
  ```


W
wusongqing 已提交
614
### startImagePreview<sup>(deprecated)</sup>
W
wusongqing 已提交
615 616 617 618 619

startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&gt;

Starts image preview, with the first image to preview specified. This API can be used to preview local images whose URIs start with dataability:// or online images whose URIs start with https://. It uses a promise to return the execution result.

W
wusongqing 已提交
620 621
> **NOTE**
>
622
> This API is deprecated since API version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. The **\<Image>** component can be used to render and display local and online images.
W
wusongqing 已提交
623 624 625 626 627

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
628 629
| Name   | Type                 | Mandatory  | Description                                      |
| ------ | ------------------- | ---- | ---------------------------------------- |
W
wusongqing 已提交
630
| images | Array&lt;string&gt; | Yes   | URIs of the images to preview. The value can start with either **dataability://** or **https://**.|
W
wusongqing 已提交
631
| index  | number              | No   | Index of the first image to preview. If this parameter is not specified, the default value **0** is used.                     |
W
wusongqing 已提交
632 633 634

**Return value**

W
wusongqing 已提交
635 636
| Type                 | Description                             |
| ------------------- | ------------------------------- |
W
wusongqing 已提交
637 638 639 640 641 642
| Promise&lt;void&gt; | Promise used to return the image preview result. If the preview fails, an error message is returned.|

**Example**

  ```
let images = [
W
wusongqing 已提交
643 644
    "dataability:///media/xxxx/2",
    "dataability:///media/xxxx/3"
W
wusongqing 已提交
645
];
W
wusongqing 已提交
646
/* Preview online images.
W
wusongqing 已提交
647 648 649 650
let images = [
    "https://media.xxxx.com/image1.jpg",
    "https://media.xxxx.com/image2.jpg"
];
W
wusongqing 已提交
651
*/
W
wusongqing 已提交
652 653 654 655 656 657 658 659 660
let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => {
    console.log("Succeeded in previewing the images.");
}).catch((err) => {
    console.log("An error occurred when previewing the images.");
});
  ```


W
wusongqing 已提交
661
### startMediaSelect<sup>(deprecated)</sup>
W
wusongqing 已提交
662 663 664 665 666

startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void

Starts media selection. This API uses an asynchronous callback to return the list of URIs that store the selected media assets.

W
wusongqing 已提交
667 668 669
> **NOTE**
>
> This API is deprecated since API version 9. You are advised to use the system app Gallery instead. Gallery is a built-in visual resource access application that provides features such as image and video management and browsing. For details about how to use Gallery, visit [OpenHarmony/applications_photos](https://gitee.com/openharmony/applications_photos).
W
wusongqing 已提交
670 671 672 673 674

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
675 676 677 678
| Name     | Type                                      | Mandatory  | Description                                  |
| -------- | ---------------------------------------- | ---- | ------------------------------------ |
| option   | [MediaSelectOption](#mediaselectoption)  | Yes   | Media selection option.                             |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | Yes   | Callback used to return the list of URIs (starting with **dataability://**) that store the selected media assets.|
W
wusongqing 已提交
679 680 681 682 683

**Example**

  ```
let option = {
W
wusongqing 已提交
684
    type : "media",
W
wusongqing 已提交
685 686 687 688 689 690 691 692 693 694 695 696 697
    count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => {
    if (err) {
        console.log("An error occurred when selecting the media asset.");
        return;
    }
    console.log("Media asset selected.");
    // Obtain the media selection value.
});
  ```


W
wusongqing 已提交
698
### startMediaSelect<sup>(deprecated)</sup>
W
wusongqing 已提交
699 700 701 702 703

startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt;

Starts media selection. This API uses a promise to return the list of URIs that store the selected media assets.

W
wusongqing 已提交
704 705 706
> **NOTE**
>
> This API is deprecated since API version 9. You are advised to use the system app Gallery instead. Gallery is a built-in visual resource access application that provides features such as image and video management and browsing. For details about how to use Gallery, visit [OpenHarmony/applications_photos](https://gitee.com/openharmony/applications_photos).
W
wusongqing 已提交
707 708 709 710 711

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
712 713 714
| Name   | Type                                     | Mandatory  | Description     |
| ------ | --------------------------------------- | ---- | ------- |
| option | [MediaSelectOption](#mediaselectoption) | Yes   | Media selection option.|
W
wusongqing 已提交
715 716 717

**Return value**

W
wusongqing 已提交
718 719
| Type                                | Description                                      |
| ---------------------------------- | ---------------------------------------- |
W
wusongqing 已提交
720 721 722 723 724 725
| Promise&lt;Array&lt;string&gt;&gt; | Promise used to return the list of URIs (starting with **dataability://**) that store the selected media assets.|

**Example**

  ```
let option = {
W
wusongqing 已提交
726
    type : "media",
W
wusongqing 已提交
727 728 729 730 731 732 733 734 735 736 737
    count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
    console.log("Media asset selected.");
    // Obtain the media selection value.
}).catch((err) => {
    console.log("An error occurred when selecting the media assets.");
});

  ```

W
wusongqing 已提交
738
## FileAsset<sup>7+</sup>
W
wusongqing 已提交
739 740 741 742 743 744 745

Provides APIs for encapsulating file asset attributes.

### Attributes

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

W
wusongqing 已提交
746
| Name                     | Type                    | Readable| Writable| Description                                                  |
W
wusongqing 已提交
747
| ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ |
W
wusongqing 已提交
748
| id                        | number                   | Yes  | No  | File asset ID.                                          |
W
wusongqing 已提交
749
| uri                       | string                   | Yes  | No  | File asset URI, for example, **dataability:///media/image/2**.        |
W
wusongqing 已提交
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
| mimeType                  | string                   | Yes  | No  | Extended file attributes.                                          |
| mediaType<sup>8+</sup>    | [MediaType](#mediatype8) | Yes  | No  | Media type.                                              |
| displayName               | string                   | Yes  | Yes  | Display file name, including the file name extension.                                |
| title                     | string                   | Yes  | Yes  | Title in the file.                                              |
| relativePath<sup>8+</sup> | string                   | Yes  | Yes  | Relative public directory of the file.                                      |
| parent<sup>8+</sup>       | number                   | Yes  | No  | Parent directory ID.                                              |
| size                      | number                   | Yes  | No  | File size, in bytes.                                |
| dateAdded                 | number                   | Yes  | No  | Date when the file was added. (The value is the number of seconds elapsed since the Epoch time.)        |
| dateModified              | number                   | Yes  | No  | Date when the file was modified. (The value is the number of seconds elapsed since the Epoch time.)        |
| dateTaken                 | number                   | Yes  | No  | Date when the file (photo) was taken. (The value is the number of seconds elapsed since the Epoch time.)        |
| artist<sup>8+</sup>       | string                   | Yes  | No  | Artist of the file.                                                  |
| audioAlbum<sup>8+</sup>   | string                   | Yes  | No  | Audio album.                                                  |
| width                     | number                   | Yes  | No  | Image width, in pixels.                                |
| height                    | number                   | Yes  | No  | Image height, in pixels.                                |
| orientation               | number                   | Yes  | Yes  | Image display direction (clockwise rotation angle, for example, 0, 90, or 180, in degrees).|
W
wusongqing 已提交
765
| duration<sup>8+</sup>     | number                   | Yes  | No  | Duration, in ms.                                  |
W
wusongqing 已提交
766 767 768
| albumId                   | number                   | Yes  | No  | ID of the album to which the file belongs.                                  |
| albumUri<sup>8+</sup>     | string                   | Yes  | No  | URI of the album to which the file belongs.                                     |
| albumName                 | string                   | Yes  | No  | Name of the album to which the file belongs.                                    |
W
wusongqing 已提交
769 770 771 772 773 774 775 776 777 778 779 780 781 782


### isDirectory<sup>8+</sup>

isDirectory(callback: AsyncCallback&lt;boolean&gt;): void

Checks whether this file asset is a directory. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
783
| Name     | Type                          | Mandatory  | Description                 |
W
wusongqing 已提交
784
| -------- | ---------------------------- | ---- | ------------------- |
W
wusongqing 已提交
785
| callback | AsyncCallback&lt;boolean&gt; | Yes   | Callback used to return whether the file asset is a directory.|
W
wusongqing 已提交
786 787 788 789 790

**Example**

```
async function example() {
W
wusongqing 已提交
791
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isDirectory((err, isDirectory) => {
        // do something
    });
}
```

### isDirectory<sup>8+</sup>

isDirectory():Promise&lt;boolean&gt;

Checks whether this file asset is a directory. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
819 820
| Type                    | Description                          |
| ---------------------- | ---------------------------- |
W
wusongqing 已提交
821 822 823 824 825 826
| Promise&lt;boolean&gt; | Promise used to return whether the file asset is a directory.|

**Example**

```
async function example() {
W
wusongqing 已提交
827
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isDirectory().then(function(isDirectory){
        console.info("isDirectory result:"+ isDirectory);
    }).catch(function(err){
        console.info("isDirectory failed with error:"+ err);
    });
}
```

### commitModify<sup>8+</sup>

commitModify(callback: AsyncCallback&lt;void&gt;): void

W
wusongqing 已提交
849
Commits the modification in this file asset to the database. This API uses an asynchronous callback to return the result.
W
wusongqing 已提交
850 851 852 853 854 855 856

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
857 858 859
| Name     | Type                       | Mandatory  | Description   |
| -------- | ------------------------- | ---- | ----- |
| callback | AsyncCallback&lt;void&gt; | Yes   | Void callback.|
W
wusongqing 已提交
860 861 862 863 864

**Example**

```
async function example() {
W
wusongqing 已提交
865
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.title = 'newtitle';
    asset.commitModify(() => {
        console.info('commitModify success');   
    });
}
```

### commitModify<sup>8+</sup>

commitModify(): Promise&lt;void&gt;

W
wusongqing 已提交
886
Commits the modification in this file asset to the database. This API uses a promise to return the result.
W
wusongqing 已提交
887 888 889 890 891 892 893

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
894 895
| Type                 | Description        |
| ------------------- | ---------- |
W
wusongqing 已提交
896 897 898 899 900 901
| Promise&lt;void&gt; | Void promise.|

**Example**

```
async function example() {
W
wusongqing 已提交
902
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.title = 'newtitle';
    asset.commitModify();
}
```

### open<sup>8+</sup>

open(mode: string, callback: AsyncCallback&lt;number&gt;): void

Opens this file asset. This API uses an asynchronous callback to return the result.

W
wusongqing 已提交
923 924 925
> **NOTE**
> 
> Currently, the write operations are mutually exclusive. After the write operation is complete, you must call **close** to release the resource.
W
wusongqing 已提交
926

W
wusongqing 已提交
927
**Required permissions**: ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
W
wusongqing 已提交
928 929 930 931 932

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
933 934
| Name     | Type                         | Mandatory  | Description                                 |
| -------- | --------------------------- | ---- | ----------------------------------- |
W
wusongqing 已提交
935
| mode     | string                      | Yes   | Mode of opening the file, for example, **'r'** (read-only), **'w'** (write-only), and **'rw'** (read-write).|
W
wusongqing 已提交
936
| callback | AsyncCallback&lt;number&gt; | Yes   | Callback used to return the file handle.                           |
W
wusongqing 已提交
937 938 939 940 941 942 943 944

**Example**

```
async function example() {
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
W
wusongqing 已提交
945
    const asset = await media.createAsset(mediaType, "image00003.jpg", path);
W
wusongqing 已提交
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
    asset.open('rw', (openError, fd) => {
            if(fd > 0){
                asset.close(fd);
            }else{
                console.info('File Open Failed!' + openError);
            }
    });
}
```

### open<sup>8+</sup>

open(mode: string): Promise&lt;number&gt;

Opens this file asset. This API uses a promise to return the result.

962 963
>  **NOTE**
>  
W
wusongqing 已提交
964
> Currently, the write operations are mutually exclusive. After the write operation is complete, you must call **close** to release the resource.
W
wusongqing 已提交
965

W
wusongqing 已提交
966
**Required permissions**: ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
W
wusongqing 已提交
967 968 969 970 971

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
972 973
| Name | Type    | Mandatory  | Description                                 |
| ---- | ------ | ---- | ----------------------------------- |
W
wusongqing 已提交
974
| mode | string | Yes   | Mode of opening the file, for example, **'r'** (read-only), **'w'** (write-only), and **'rw'** (read-write).|
W
wusongqing 已提交
975 976 977

**Return value**

W
wusongqing 已提交
978 979
| Type                   | Description           |
| --------------------- | ------------- |
W
wusongqing 已提交
980 981 982 983 984 985 986 987 988
| Promise&lt;number&gt; | Promise used to return the file handle.|

**Example**

```
async function example() {
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
W
wusongqing 已提交
989
    const asset = await media.createAsset(mediaType, "image00003.jpg", path);
W
wusongqing 已提交
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
    asset.open('rw')
        .then((fd) => {
            console.info('File fd!' + fd);
        })
        .catch((err) => {
            console.info('File err!' + err);
        });
}
```

### close<sup>8+</sup>

close(fd: number, callback: AsyncCallback&lt;void&gt;): void

Closes this file asset. This API uses an asynchronous callback to return the result.

W
wusongqing 已提交
1006
**Required permissions**: ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
W
wusongqing 已提交
1007 1008 1009 1010 1011

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1012 1013 1014 1015
| Name     | Type                       | Mandatory  | Description   |
| -------- | ------------------------- | ---- | ----- |
| fd       | number                    | Yes   | File descriptor.|
| callback | AsyncCallback&lt;void&gt; | Yes   | Void callback.|
W
wusongqing 已提交
1016 1017 1018 1019 1020

**Example**

```
async function example() {
W
wusongqing 已提交
1021
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1022 1023 1024 1025 1026 1027 1028 1029 1030
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
W
wusongqing 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
    asset.open('rw').then((fd) => {
        console.info('File fd!' + fd);
        asset.close(fd, (closeErr) => {
            if (closeErr != undefined) {
                console.info('mediaLibraryTest : close : FAIL ' + closeErr.message);
                console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL');
            } else {
                console.info("=======asset.close success====>");
            }
        });
    })
    .catch((err) => {
        console.info('File err!' + err);
W
wusongqing 已提交
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
    });
}
```

### close<sup>8+</sup>

close(fd: number): Promise&lt;void&gt;

Closes this file asset. This API uses a promise to return the result.

W
wusongqing 已提交
1054
**Required permissions**: ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
W
wusongqing 已提交
1055 1056 1057 1058 1059

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1060 1061 1062
| Name | Type    | Mandatory  | Description   |
| ---- | ------ | ---- | ----- |
| fd   | number | Yes   | File descriptor.|
W
wusongqing 已提交
1063 1064 1065

**Return value**

W
wusongqing 已提交
1066 1067
| Type                 | Description        |
| ------------------- | ---------- |
W
wusongqing 已提交
1068 1069 1070 1071 1072 1073
| Promise&lt;void&gt; | Void promise.|

**Example**

```
async function example() {
W
wusongqing 已提交
1074
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1075 1076 1077 1078 1079 1080 1081 1082 1083
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
W
wusongqing 已提交
1084 1085 1086 1087 1088 1089
    asset.open('rw').then((fd) => {
        console.info('File fd!' + fd);
        asset.close(fd).then((closeErr) => {
            if (closeErr != undefined) {
                console.info('mediaLibraryTest : close : FAIL ' + closeErr.message);
                console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL');
W
wusongqing 已提交
1090

W
wusongqing 已提交
1091 1092 1093 1094 1095 1096 1097
            } else {
                console.info("=======asset.close success====>");
            }
        });
    })
    .catch((err) => {
        console.info('File err!' + err);
W
wusongqing 已提交
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
    });
}
```

### getThumbnail<sup>8+</sup>

getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void

Obtains the thumbnail of this file asset. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1114 1115 1116
| Name     | Type                                 | Mandatory  | Description              |
| -------- | ----------------------------------- | ---- | ---------------- |
| callback | AsyncCallback&lt;image.PixelMap&gt; | Yes   | Callback used to return the pixel map of the thumbnail.|
W
wusongqing 已提交
1117 1118 1119 1120 1121

**Example**

```
async function example() {
W
wusongqing 已提交
1122
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.getThumbnail((err, pixelmap) => {
Z
zengyawen 已提交
1133
        console.info('mediaLibraryTest : getThumbnail successful '+ pixelmap);
W
wusongqing 已提交
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    });
}
```

### getThumbnail<sup>8+</sup>

getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void

Obtains the thumbnail of this file asset, with the thumbnail size passed. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1150 1151 1152 1153
| Name     | Type                                 | Mandatory  | Description              |
| -------- | ----------------------------------- | ---- | ---------------- |
| size     | [Size](#size8)                      | Yes   | Size of the thumbnail.           |
| callback | AsyncCallback&lt;image.PixelMap&gt; | Yes   | Callback used to return the pixel map of the thumbnail.|
W
wusongqing 已提交
1154 1155 1156 1157 1158

**Example**

```
async function example() {
W
wusongqing 已提交
1159
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1160 1161 1162 1163 1164 1165 1166
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
W
wusongqing 已提交
1167
    let size = { width: 720, height: 720 };
W
wusongqing 已提交
1168 1169 1170
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.getThumbnail(size, (err, pixelmap) => {
Z
zengyawen 已提交
1171
        console.info('mediaLibraryTest : getThumbnail successful '+ pixelmap);
W
wusongqing 已提交
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
    });
}
```

### getThumbnail<sup>8+</sup>

getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt;

Obtains the thumbnail of this file asset, with the thumbnail size passed. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1188 1189 1190
| Name | Type            | Mandatory  | Description   |
| ---- | -------------- | ---- | ----- |
| size | [Size](#size8) | No   | Size of the thumbnail.|
W
wusongqing 已提交
1191 1192 1193

**Return value**

W
wusongqing 已提交
1194 1195
| Type                           | Description                   |
| ----------------------------- | --------------------- |
W
wusongqing 已提交
1196 1197 1198 1199 1200 1201
| Promise&lt;image.PixelMap&gt; | Promise to return the pixel map of the thumbnail.|

**Example**

```
async function example() {
W
wusongqing 已提交
1202
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1203 1204
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
W
wusongqing 已提交
1205 1206 1207 1208
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + " DESC",
        extendArgs: "",
W
wusongqing 已提交
1209
    };
W
wusongqing 已提交
1210
    let size = { width: 720, height: 720 };
W
wusongqing 已提交
1211 1212
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
W
wusongqing 已提交
1213 1214
    asset.getThumbnail(size)
    .then((pixelmap) => {
Z
zengyawen 已提交
1215
        console.info('mediaLibraryTest : getThumbnail successful '+ pixelmap);
W
wusongqing 已提交
1216 1217 1218
    })
    .catch((err) => {
        console.info('mediaLibraryTest : getThumbnail fail'+ err);
W
wusongqing 已提交
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
    });
}
```

### favorite<sup>8+</sup>

favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void

Favorites or unfavorites this file asset. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1235 1236 1237 1238
| Name       | Type                       | Mandatory  | Description                                |
| ---------- | ------------------------- | ---- | ---------------------------------- |
| isFavorite | boolean                   | Yes   | Whether to favorite or unfavorite the file. The value **true** means to favorite the file, and **false** means to unfavorite the file.|
| callback   | AsyncCallback&lt;void&gt; | Yes   | Void callback.                             |
W
wusongqing 已提交
1239 1240 1241 1242 1243

**Example**

```
async function example() {
W
wusongqing 已提交
1244
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.favorite(true,function(err){
        // do something
    });
}
```

### favorite<sup>8+</sup>

favorite(isFavorite: boolean): Promise&lt;void&gt;

Favorites or unfavorites this file asset. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1272 1273 1274
| Name       | Type     | Mandatory  | Description                                |
| ---------- | ------- | ---- | ---------------------------------- |
| isFavorite | boolean | Yes   | Whether to favorite or unfavorite the file. The value **true** means to favorite the file, and **false** means to unfavorite the file.|
W
wusongqing 已提交
1275 1276 1277

**Return value**

W
wusongqing 已提交
1278 1279
| Type                 | Description        |
| ------------------- | ---------- |
W
wusongqing 已提交
1280 1281 1282 1283 1284 1285
| Promise&lt;void&gt; | Void promise.|

**Example**

```
async function example() {
W
wusongqing 已提交
1286
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.favorite(true).then(function() {
        console.info("favorite successfully");
    }).catch(function(err){
        console.info("favorite failed with error:"+ err);
    });
}
```

### isFavorite<sup>8+</sup>

isFavorite(callback: AsyncCallback&lt;boolean&gt;): void

Checks whether this file asset is favorited. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1316 1317 1318
| Name     | Type                          | Mandatory  | Description         |
| -------- | ---------------------------- | ---- | ----------- |
| callback | AsyncCallback&lt;boolean&gt; | Yes   | Callback used to return whether the file asset is favorited.|
W
wusongqing 已提交
1319 1320 1321 1322 1323

**Example**

```
async function example() {
W
wusongqing 已提交
1324
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isFavorite((err, isFavorite) => {
        if (isFavorite) {
            console.info('FileAsset is favorite');
        }else{
            console.info('FileAsset is not favorite');
        }
    });
}
```

### isFavorite<sup>8+</sup>

isFavorite():Promise&lt;boolean&gt;

Checks whether this file asset is favorited. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1356 1357
| Type                    | Description                |
| ---------------------- | ------------------ |
W
wusongqing 已提交
1358 1359 1360 1361 1362 1363
| Promise&lt;boolean&gt; | Promise used to return whether the file asset is favorited.|

**Example**

```
async function example() {
W
wusongqing 已提交
1364
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isFavorite().then(function(isFavorite){
        console.info("isFavorite result:"+ isFavorite);
    }).catch(function(err){
        console.info("isFavorite failed with error:"+ err);
    });
}
```

### trash<sup>8+</sup>

trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void

Moves this file asset to the trash. This API uses an asynchronous callback to return the result.

Files in the trash are not actually deleted. You can set **isTrash** to **false** to restore the files from the trash.

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1396 1397 1398 1399
| Name     | Type                       | Mandatory  | Description       |
| -------- | ------------------------- | ---- | --------- |
| isTrash  | boolean                   | Yes   | Whether to move the file asset to the trash. The value **true** means to move the file asset to the trash, and **false** means the opposite.|
| callback | AsyncCallback&lt;void&gt; | Yes   | Void callback.    |
W
wusongqing 已提交
1400 1401 1402 1403 1404

**Example**

```
async function example() {
W
wusongqing 已提交
1405
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.trash(true, trashCallBack);
    function trashCallBack(err, trash) {
        console.info('mediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash');
    }
}
```

### trash<sup>8+</sup>

trash(isTrash: boolean): Promise&lt;void&gt;

Moves this file asset to the trash. This API uses a promise to return the result.

Files in the trash are not actually deleted. You can set **isTrash** to **false** to restore the files from the trash.

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1436 1437 1438
| Name    | Type     | Mandatory  | Description       |
| ------- | ------- | ---- | --------- |
| isTrash | boolean | Yes   | Whether to move the file asset to the trash. The value **true** means to move the file asset to the trash, and **false** means the opposite.|
W
wusongqing 已提交
1439 1440 1441

**Return value**

W
wusongqing 已提交
1442 1443
| Type                 | Description        |
| ------------------- | ---------- |
W
wusongqing 已提交
1444 1445 1446 1447 1448 1449
| Promise&lt;void&gt; | Void promise.|

**Example**

```
async function example() {
W
wusongqing 已提交
1450
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.trash(true).then(function() {
        console.info("trash successfully");
    }).catch(function(err){
        console.info("trash failed with error:"+ err);
    });
}
```

### isTrash<sup>8+</sup>

isTrash(callback: AsyncCallback&lt;boolean&gt;): void

Checks whether this file asset is in the trash. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1480 1481 1482
| Name     | Type                          | Mandatory  | Description             |
| -------- | ---------------------------- | ---- | --------------- |
| callback | AsyncCallback&lt;boolean&gt; | Yes   | Callback used to return whether the file asset is in the trash. If the file asset is in the trash, **true** will be returned; otherwise, **false** will be returned.|
W
wusongqing 已提交
1483 1484 1485 1486 1487

**Example**

```
async function example() {
W
wusongqing 已提交
1488
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isTrash(isTrashCallBack);
    function isTrashCallBack(err, isTrash) {
            if (isTrash == true) {
                console.info('mediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash);
W
wusongqing 已提交
1502
                asset.trash(true, istrashCallBack);
W
wusongqing 已提交
1503 1504

            } else {
Z
zengyawen 已提交
1505
                console.info('mediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessful = ' + err);
W
wusongqing 已提交
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
                console.info('mediaLibraryTest : ASSET_CALLBACK isTrash : FAIL');

            }
    }
}
```

### isTrash<sup>8+</sup>

isTrash():Promise&lt;boolean&gt;

Checks whether this file asset is in the trash. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1525 1526
| Type                 | Description                  |
| ------------------- | -------------------- |
W
wusongqing 已提交
1527 1528 1529 1530 1531 1532
| Promise&lt;void&gt; | Promise used to return whether the file asset is in the trash. If the file asset is in the trash, **true** will be returned; otherwise, **false** will be returned.|

**Example**

```
async function example() {
W
wusongqing 已提交
1533
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isTrash().then(function(isTrash){
        console.info("isTrash result:"+ isTrash);
    }).catch(function(err){
        console.info("isTrash failed with error:"+ err);
    });
}
```

W
wusongqing 已提交
1551
## FetchFileResult<sup>7+</sup>
W
wusongqing 已提交
1552 1553 1554

Implements the result set of the file retrieval operation.

W
wusongqing 已提交
1555
### getCount<sup>7+</sup>
W
wusongqing 已提交
1556 1557 1558 1559 1560 1561 1562 1563 1564

getCount(): number

Obtains the total number of files in the result set.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1565 1566
| Type    | Description      |
| ------ | -------- |
W
wusongqing 已提交
1567 1568 1569 1570 1571 1572
| number | Total number of files.|

**Example**

```
async function example() {
W
wusongqing 已提交
1573 1574
    let fileKeyObj = mediaLibrary.FileKey
    let fileType = mediaLibrary.MediaType.FILE;
W
wusongqing 已提交
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
    let getFileCountOneOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [fileType.toString()],
        order: fileKeyObj.DATE_ADDED + " DESC",
        extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getFileCountOneOp);
    const fetchCount = fetchFileResult.getCount();
}
```

W
wusongqing 已提交
1586
### isAfterLast<sup>7+</sup>
W
wusongqing 已提交
1587 1588 1589 1590 1591 1592 1593 1594 1595

isAfterLast(): boolean

Checks whether the cursor is in the last row of the result set.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1596 1597
| Type     | Description                                |
| ------- | ---------------------------------- |
W
wusongqing 已提交
1598
| boolean | Returns **true** if the cursor is in the last row of the result set; returns *false* otherwise.|
W
wusongqing 已提交
1599 1600 1601 1602 1603

**Example**

```
async function example() {
W
wusongqing 已提交
1604
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    const fetchCount = fetchFileResult.getCount();
    console.info('mediaLibraryTest : count:' + fetchCount);
    let fileAsset = await fetchFileResult.getFirstObject();
    for (var i = 1; i < fetchCount; i++) {
            fileAsset = await fetchFileResult.getNextObject();
            if(i == fetchCount - 1) {
              console.info('mediaLibraryTest : isLast');
              var result = fetchFileResult.isAfterLast();
              console.info('mediaLibraryTest : isAfterLast:' + result);
              console.info('mediaLibraryTest : isAfterLast end');
              fetchFileResult.close();

            }
    }
}
```

W
wusongqing 已提交
1630
### close<sup>7+</sup>
W
wusongqing 已提交
1631 1632 1633

close(): void

W
wusongqing 已提交
1634
Releases and invalidates this **FetchFileResult** instance. Other APIs in this instance cannot be invoked after it is released.
W
wusongqing 已提交
1635 1636 1637 1638 1639 1640 1641

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Example**

```
async function example() {
W
wusongqing 已提交
1642
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.close();
}
```

W
wusongqing 已提交
1655
### getFirstObject<sup>7+</sup>
W
wusongqing 已提交
1656 1657 1658 1659 1660 1661 1662 1663 1664

getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void

Obtains the first file asset in the result set. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1665 1666 1667
| Name  | Type                                         | Mandatory| Description                                       |
| -------- | --------------------------------------------- | ---- | ------------------------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | Yes  | Callback used to return the first file asset.|
W
wusongqing 已提交
1668 1669 1670 1671 1672

**Example**

```
async function example() {
W
wusongqing 已提交
1673
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1674 1675 1676 1677 1678 1679 1680 1681
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
W
wusongqing 已提交
1682
    fetchFileResult.getFirstObject((err, fileAsset) => {
W
wusongqing 已提交
1683 1684 1685 1686
       if (err) {
           console.error('Failed ');
           return;
       }
W
wusongqing 已提交
1687
       console.log('fileAsset.displayName : ' + fileAsset.displayName);
W
wusongqing 已提交
1688 1689 1690 1691
    })
}
```

W
wusongqing 已提交
1692
### getFirstObject<sup>7+</sup>
W
wusongqing 已提交
1693 1694 1695 1696 1697 1698 1699 1700 1701

getFirstObject(): Promise&lt;FileAsset&gt;

Obtains the first file asset in the result set. This API uses a promise to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1702 1703 1704
| Type                                   | Description                      |
| --------------------------------------- | -------------------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | Promise used to return the file asset.|
W
wusongqing 已提交
1705 1706 1707 1708 1709

**Example**

```
async function example() {
W
wusongqing 已提交
1710
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getFirstObject().then(function(fileAsset){
        console.info("getFirstObject successfully:"+ JSON.stringify(fileAsset));
    }).catch(function(err){
        console.info("getFirstObject failed with error:"+ err);
    });
}
```

W
wusongqing 已提交
1727
### getNextObject<sup>7+</sup>
W
wusongqing 已提交
1728 1729 1730 1731 1732 1733 1734 1735 1736

 getNextObject(callback: AsyncCallback&lt;FileAsset&gt;): void

Obtains the next file asset in the result set. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1737 1738
| Name   | Type                                         | Mandatory| Description                                     |
| --------- | --------------------------------------------- | ---- | ----------------------------------------- |
Z
zengyawen 已提交
1739
| callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | Yes  | Callback used to return the next file asset.|
W
wusongqing 已提交
1740 1741 1742 1743 1744

**Example**

```
async function example() {
W
wusongqing 已提交
1745
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1746 1747 1748 1749 1750 1751 1752 1753
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
W
wusongqing 已提交
1754
    fetchFileResult.getNextObject((err, fileAsset) => {
W
wusongqing 已提交
1755 1756 1757 1758
       if (err) {
           console.error('Failed ');
           return;
       }
W
wusongqing 已提交
1759
       console.log('fileAsset.displayName : ' + fileAsset.displayName);
W
wusongqing 已提交
1760 1761 1762 1763
    })
}
```

W
wusongqing 已提交
1764
### getNextObject<sup>7+</sup>
W
wusongqing 已提交
1765 1766 1767 1768 1769 1770 1771 1772 1773

 getNextObject(): Promise&lt;FileAsset&gt;

Obtains the next file asset in the result set. This API uses a promise to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1774 1775 1776
| Type                                   | Description             |
| --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | Promise used to return the next file asset.|
W
wusongqing 已提交
1777 1778 1779 1780 1781

**Example**

```
async function example() {
W
wusongqing 已提交
1782
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    const fetchCount = fetchFileResult.getCount();
    console.info('mediaLibraryTest : count:' + fetchCount);
W
wusongqing 已提交
1793
    let fileAsset = await fetchFileResult.getNextObject();
W
wusongqing 已提交
1794 1795 1796
}
```

W
wusongqing 已提交
1797
### getLastObject<sup>7+</sup>
W
wusongqing 已提交
1798 1799 1800 1801 1802 1803 1804 1805 1806

getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void

Obtains the last file asset in the result set. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1807 1808 1809
| Name  | Type                                         | Mandatory| Description                       |
| -------- | --------------------------------------------- | ---- | --------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | Yes  | Callback used to return the last file asset.|
W
wusongqing 已提交
1810 1811 1812 1813 1814

**Example**

```
async function example() {
W
wusongqing 已提交
1815
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1816 1817 1818 1819 1820 1821 1822 1823
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
W
wusongqing 已提交
1824
    fetchFileResult.getLastObject((err, fileAsset) => {
W
wusongqing 已提交
1825 1826 1827 1828
       if (err) {
           console.error('Failed ');
           return;
       }
W
wusongqing 已提交
1829
       console.log('fileAsset.displayName : ' + fileAsset.displayName);
W
wusongqing 已提交
1830 1831 1832 1833
    })
}
```

W
wusongqing 已提交
1834
### getLastObject<sup>7+</sup>
W
wusongqing 已提交
1835 1836 1837 1838 1839 1840 1841 1842 1843

getLastObject(): Promise&lt;FileAsset&gt;

Obtains the last file asset in the result set. This API uses a promise to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1844 1845 1846
| Type                                   | Description             |
| --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | Promise used to return the next file asset.|
W
wusongqing 已提交
1847 1848 1849 1850 1851

**Example**

```
async function example() {
W
wusongqing 已提交
1852
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    let lastObject = await fetchFileResult.getLastObject();
}
```

W
wusongqing 已提交
1865
### getPositionObject<sup>7+</sup>
W
wusongqing 已提交
1866 1867 1868 1869 1870 1871 1872 1873 1874

getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void

Obtains a file asset with the specified index in the result set. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1875 1876 1877
| Name      | Type                                      | Mandatory  | Description                |
| -------- | ---------------------------------------- | ---- | ------------------ |
| index    | number                                   | Yes   | Index of the file asset to obtain. The value starts from **0**.    |
W
wusongqing 已提交
1878
| callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | Yes   | Callback used to return the last file asset.|
W
wusongqing 已提交
1879 1880 1881 1882 1883

**Example**

```
async function example() {
W
wusongqing 已提交
1884
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1885 1886 1887 1888 1889 1890 1891 1892
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
W
wusongqing 已提交
1893
    fetchFileResult.getPositionObject(0, (err, fileAsset) => {
W
wusongqing 已提交
1894 1895 1896 1897
       if (err) {
           console.error('Failed ');
           return;
       }
W
wusongqing 已提交
1898
       console.log('fileAsset.displayName : ' + fileAsset.displayName);
W
wusongqing 已提交
1899 1900 1901 1902
    })
}
```

W
wusongqing 已提交
1903
### getPositionObject<sup>7+</sup>
W
wusongqing 已提交
1904 1905 1906 1907 1908 1909 1910 1911 1912

getPositionObject(index: number): Promise&lt;FileAsset&gt;

Obtains a file asset with the specified index in the result set. This API uses a promise to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1913 1914 1915
| Name   | Type    | Mandatory  | Description            |
| ----- | ------ | ---- | -------------- |
| index | number | Yes   | Index of the file asset to obtain. The value starts from **0**.|
W
wusongqing 已提交
1916 1917 1918

**Return value**

W
wusongqing 已提交
1919 1920 1921
| Type                                   | Description             |
| --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | Promise used to return the next file asset.|
W
wusongqing 已提交
1922 1923 1924 1925 1926

**Example**

```
async function example() {
W
wusongqing 已提交
1927
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1928 1929 1930 1931 1932 1933 1934 1935
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
1936 1937 1938 1939 1940
    fetchFileResult.getPositionObject(1) .then(function (fileAsset){
        console.log('[Demo] fileAsset.displayName : ' + fileAsset.displayName);
    }).catch(function (err) {
        console.info("[Demo] getFileAssets failed with error:" + err);
    });
W
wusongqing 已提交
1941 1942 1943
}
```

W
wusongqing 已提交
1944
### getAllObject<sup>7+</sup>
W
wusongqing 已提交
1945 1946 1947 1948 1949 1950 1951 1952 1953

getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void

Obtains all the file assets in the result set. This API uses an asynchronous callback to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
1954 1955
| Name      | Type                                      | Mandatory  | Description                  |
| -------- | ---------------------------------------- | ---- | -------------------- |
W
wusongqing 已提交
1956
| callback | AsyncCallback<Array<[FileAsset](#fileasset7)>> | Yes   | Callback used to return the file assets.|
W
wusongqing 已提交
1957 1958 1959 1960 1961

**Example**

```
async function example() {
W
wusongqing 已提交
1962
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
1963 1964 1965 1966 1967 1968 1969 1970
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
W
wusongqing 已提交
1971
    fetchFileResult.getAllObject((err, fileAsset) => {
W
wusongqing 已提交
1972 1973 1974 1975
       if (err) {
           console.error('Failed ');
           return;
       }
W
wusongqing 已提交
1976
       console.log('fileAsset.displayName : ' + fileAsset.displayName);
W
wusongqing 已提交
1977 1978 1979 1980
    })
}
```

W
wusongqing 已提交
1981
### getAllObject<sup>7+</sup>
W
wusongqing 已提交
1982 1983 1984 1985 1986 1987 1988 1989 1990

getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt;

Obtains all the file assets in the result set. This API uses a promise to return the result.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
1991 1992 1993
| Type                                    | Description                 |
| ---------------------------------------- | --------------------- |
| Promise<Array<[FileAsset](#fileasset7)>> | Promise used to return the file assets.|
W
wusongqing 已提交
1994 1995 1996 1997 1998

**Example**

```
async function example() {
W
wusongqing 已提交
1999
    let fileKeyObj = mediaLibrary.FileKey
W
wusongqing 已提交
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()],
      order: fileKeyObj.DATE_ADDED + " DESC",
      extendArgs: "",
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    var data = fetchFileResult.getAllObject();
}
```

W
wusongqing 已提交
2012
## Album<sup>7+</sup>
W
wusongqing 已提交
2013 2014 2015

Provides APIs to implement a physical album.

W
wusongqing 已提交
2016
### Attributes
W
wusongqing 已提交
2017 2018 2019

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

W
wusongqing 已提交
2020 2021
| Name          | Type   | Readable  | Writable  | Description     |
| ------------ | ------ | ---- | ---- | ------- |
W
wusongqing 已提交
2022 2023 2024
| albumId | number | Yes   | No   | Album ID.   |
| albumName | string | Yes   | Yes   | Album name.   |
| albumUri<sup>8+</sup> | string | Yes   | No   | Album URI.  |
W
wusongqing 已提交
2025
| dateModified | number | Yes   | No   | Date when the album was modified.   |
W
wusongqing 已提交
2026 2027 2028
| count<sup>8+</sup> | number | Yes   | No   | Number of files in the album.|
| relativePath<sup>8+</sup> | string | Yes   | No   | Relative path of the album.   |
| coverUri<sup>8+</sup> | string | Yes   | No   | URI of the cover file of the album.|
W
wusongqing 已提交
2029 2030 2031 2032 2033

### commitModify<sup>8+</sup>

commitModify(callback: AsyncCallback&lt;void&gt;): void

W
wusongqing 已提交
2034
Commits the modification in the album attributes to the database. This API uses an asynchronous callback to return the result.
W
wusongqing 已提交
2035 2036 2037 2038 2039 2040 2041

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
2042 2043 2044
| Name  | Type                     | Mandatory| Description      |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | Yes  | Void callback.|
W
wusongqing 已提交
2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070

**Example**

```
async function example() {
    let AlbumNoArgsfetchOp = {
        selections: '',
        selectionArgs: [],
    };
    const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
    const album = albumList[0];
    album.albumName = 'hello';
    album.commitModify((err) => {
       if (err) {
           console.error('Failed ');
           return;
       }
       console.log('Modify successful.');
    })
}
```

### commitModify<sup>8+</sup>

commitModify(): Promise&lt;void&gt;

W
wusongqing 已提交
2071
Commits the modification in the album attributes to the database. This API uses a promise to return the result.
W
wusongqing 已提交
2072 2073 2074 2075 2076 2077 2078

**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Return value**

W
wusongqing 已提交
2079 2080
| Type                 | Description          |
| ------------------- | ------------ |
W
wusongqing 已提交
2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
| Promise&lt;void&gt; | Void promise.|

**Example**

```
async function example() {
    let AlbumNoArgsfetchOp = {
        selections: '',
        selectionArgs: [],
    };
    const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
    const album = albumList[0];
    album.albumName = 'hello';
    album.commitModify().then(function() {
        console.info("commitModify successfully");
    }).catch(function(err){
        console.info("commitModify failed with error:"+ err);
    });
}
```

W
wusongqing 已提交
2102
### getFileAssets<sup>7+</sup>
W
wusongqing 已提交
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113

getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileResult&gt;): void

Obtains the file assets in this album. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
2114 2115 2116 2117
| Name  | Type                                               | Mandatory| Description                               |
| -------- | --------------------------------------------------- | ---- | ----------------------------------- |
| options  | [MediaFetchOptions](#mediafetchoptions7)            | Yes  | Options for fetching the files.                     |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | Yes  | Callback used to return the file assets.|
W
wusongqing 已提交
2118 2119 2120 2121 2122 2123 2124 2125 2126

**Example**

```
async function example() {
    let AlbumNoArgsfetchOp = {
        selections: '',
        selectionArgs: [],
    };
W
wusongqing 已提交
2127 2128 2129 2130
    let fileNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
    }
W
wusongqing 已提交
2131 2132 2133 2134 2135 2136 2137 2138 2139
    const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
    const album = albumList[0];
    album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack);
    function getFileAssetsCallBack(err, fetchFileResult) {
        // do something
    }
}
```

W
wusongqing 已提交
2140
### getFileAssets<sup>7+</sup>
W
wusongqing 已提交
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151

 getFileAssets(options?: MediaFetchOptions): Promise&lt;FetchFileResult&gt;

Obtains the file assets in this album. This API uses a promise to return the result.

**Required permissions**: ohos.permission.READ_MEDIA

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

**Parameters**

W
wusongqing 已提交
2152 2153 2154
| Name | Type                                    | Mandatory| Description          |
| ------- | ---------------------------------------- | ---- | -------------- |
| options | [MediaFetchOptions](#mediafetchoptions7) | No  | Options for fetching the files.|
W
wusongqing 已提交
2155 2156 2157

**Return value**

W
wusongqing 已提交
2158 2159 2160
| Type                                         | Description                     |
| --------------------------------------------- | ------------------------- |
| Promise<[FetchFileResult](#fetchfileresult7)> | Promise used to return the file assets.|
W
wusongqing 已提交
2161 2162 2163 2164 2165 2166 2167 2168 2169

**Example**

```
async function example() {
    let AlbumNoArgsfetchOp = {
        selections: '',
        selectionArgs: [],
    };
W
wusongqing 已提交
2170 2171 2172 2173
    let fileNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
    }
W
wusongqing 已提交
2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
    const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
    const album = albumList[0];
    album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){
        console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult));
    }).catch(function(err){
        console.info("getFileAssets failed with error:"+ err);
    });
}
```

## PeerInfo<sup>8+</sup>

Describes information about a registered device.
W
wusongqing 已提交
2187
This is a system API.
W
wusongqing 已提交
2188

W
wusongqing 已提交
2189
**System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore
W
wusongqing 已提交
2190

W
wusongqing 已提交
2191 2192 2193 2194 2195 2196
| Name      | Type                      | Readable| Writable| Description            |
| ---------- | -------------------------- | ---- | ---- | ---------------- |
| deviceName | string                     | Yes  | No  | Name of the registered device.  |
| networkId  | string                     | Yes  | No  | Network ID of the registered device.|
| deviceType | [DeviceType](#devicetype8) | Yes  | No  | Type of the registered device.        |
| isOnline   | boolean                    | Yes  | No  | Whether the registered device is online.        |
W
wusongqing 已提交
2197 2198 2199



W
wusongqing 已提交
2200
## MediaType<sup>8+</sup>
W
wusongqing 已提交
2201 2202 2203 2204 2205

Enumerates media types.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

W
wusongqing 已提交
2206 2207 2208 2209 2210 2211
| Name |  Description|
| ----- |  ---- |
| FILE  |  File.|
| IMAGE |  Image.|
| VIDEO |  Video.|
| AUDIO |  Audio.|
W
wusongqing 已提交
2212

W
wusongqing 已提交
2213
## FileKey<sup>8+</sup>
W
wusongqing 已提交
2214 2215 2216 2217 2218

Enumerates key file information.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

W
wusongqing 已提交
2219
| Name         | Default Value             | Description                                                      |
W
wusongqing 已提交
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
| ------------- | ------------------- | ---------------------------------------------------------- |
| ID            | file_id             | File ID.                                                  |
| RELATIVE_PATH | relative_path       | Relative public directory of the file.                                          |
| DISPLAY_NAME  | display_name        | Display file name.                                                  |
| PARENT        | parent              | Parent directory ID.                                                  |
| MIME_TYPE     | mime_type           | Extended file attributes.                                              |
| MEDIA_TYPE    | media_type          | Media type.                                                  |
| SIZE          | size                | File size, in bytes.                                    |
| DATE_ADDED    | date_added          | Date when the file was added. (The value is the number of seconds elapsed since the Epoch time.)            |
| DATE_MODIFIED | date_modified       | Date when the file was modified. (The value is the number of seconds elapsed since the Epoch time.)            |
| DATE_TAKEN    | date_taken          | Date when the file (photo) was taken. (The value is the number of seconds elapsed since the Epoch time.)            |
| TITLE         | title               | Title in the file.                                                  |
| ARTIST        | artist              | Artist of the file.                                                      |
| AUDIOALBUM    | audio_album         | Audio album.                                                      |
W
wusongqing 已提交
2234
| DURATION      | duration            | Duration, in ms.                                      |
W
wusongqing 已提交
2235 2236
| WIDTH         | width               | Image width, in pixels.                                    |
| HEIGHT        | height              | Image height, in pixels.                                    |
W
wusongqing 已提交
2237
| ORIENTATION   | orientation         | Image display direction (clockwise rotation angle, for example, 0, 90, and 180, in degrees).|
W
wusongqing 已提交
2238 2239
| ALBUM_ID      | bucket_id           | ID of the album to which the file belongs.                                      |
| ALBUM_NAME    | bucket_display_name | Name of the album to which the file belongs.                                        |
W
wusongqing 已提交
2240

W
wusongqing 已提交
2241
## DirectoryType<sup>8+</sup>
W
wusongqing 已提交
2242 2243 2244 2245 2246

Enumerates directory types.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

W
wusongqing 已提交
2247 2248 2249 2250 2251 2252 2253 2254
| Name         |  Description              |
| ------------- |  ------------------ |
| DIR_CAMERA    |  Directory of camera files.|
| DIR_VIDEO     |  Directory of video files.      |
| DIR_IMAGE     |  Directory of image files.      |
| DIR_AUDIO     |  Directory of audio files.      |
| DIR_DOCUMENTS |  Directory of documents.      |
| DIR_DOWNLOAD  |  Download directory.      |
W
wusongqing 已提交
2255

W
wusongqing 已提交
2256
## DeviceType<sup>8+</sup>
W
wusongqing 已提交
2257 2258

Enumerates device types.
W
wusongqing 已提交
2259
This is a system API.
W
wusongqing 已提交
2260

W
wusongqing 已提交
2261
**System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore
W
wusongqing 已提交
2262

W
wusongqing 已提交
2263 2264 2265 2266 2267 2268 2269 2270 2271
| Name        |  Description      |
| ------------ |  ---------- |
| TYPE_UNKNOWN |  Unknown.|
| TYPE_LAPTOP  |  Laptop.|
| TYPE_PHONE   |  Phone.      |
| TYPE_TABLET  |  Tablet.  |
| TYPE_WATCH   |  Smart watch.  |
| TYPE_CAR     |  Vehicle-mounted device.  |
| TYPE_TV      |  TV.  |
W
wusongqing 已提交
2272

W
wusongqing 已提交
2273
## MediaFetchOptions<sup>7+</sup>
W
wusongqing 已提交
2274 2275 2276 2277 2278

Describes options for fetching media files.

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

W
wusongqing 已提交
2279 2280
| Name                   | Type               | Readable| Writable| Mandatory| Description                                                        |
| ----------------------- | ------------------- | ---- | ---- | ---- | ------------------------------------------------------------ |
W
wusongqing 已提交
2281
| selections              | string              | Yes  | Yes  | Yes  | Conditions for fetching files. The enumerated values in [FileKey](#filekey8) are used as the column names of the conditions. Example:<br>selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR ' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?', |
W
wusongqing 已提交
2282
| selectionArgs           | Array&lt;string&gt; | Yes  | Yes  | Yes  | Value of the condition, which corresponds to the value of the condition column in **selections**.<br>Example:<br>selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
W
wusongqing 已提交
2283
| order                   | string              | Yes  | Yes  | No  | Sorting mode of the search results, which can be ascending or descending. The enumerated values in [FileKey](#filekey8) are used as the columns for sorting the search results. Example:<br>Ascending: order: mediaLibrary.FileKey.DATE_ADDED + " ASC"<br>Descending: order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
W
wusongqing 已提交
2284 2285 2286
| uri<sup>8+</sup>        | string              | Yes  | Yes  | No  | File URI.                                                     |
| networkId<sup>8+</sup>  | string              | Yes  | Yes  | No  | Network ID of the registered device.                                              |
| extendArgs<sup>8+</sup> | string              | Yes  | Yes  | No  | Extended parameters for fetching the files. Currently, no extended parameters are available.                        |
W
wusongqing 已提交
2287 2288 2289 2290

## Size<sup>8+</sup>

Describes the image size.
W
wusongqing 已提交
2291
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
W
wusongqing 已提交
2292

W
wusongqing 已提交
2293 2294 2295 2296
| Name    | Type    | Readable  | Writable  | Description      |
| ------ | ------ | ---- | ---- | -------- |
| width  | number | Yes   | Yes   | Image width, in pixels.|
| height | number | Yes   | Yes   | Image height, in pixels.|
W
wusongqing 已提交
2297

W
wusongqing 已提交
2298
## MediaAssetOption<sup>(deprecated)</sup>
W
wusongqing 已提交
2299 2300 2301

Implements the media asset option.

W
wusongqing 已提交
2302 2303 2304
> **NOTE**
>
> This API is deprecated since API version 9.
W
wusongqing 已提交
2305 2306 2307 2308

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core


W
wusongqing 已提交
2309 2310 2311 2312 2313
| Name        | Type  | Mandatory| Description                                                        |
| ------------ | ------ | ---- | ------------------------------------------------------------ |
| src          | string | Yes  | Application sandbox oath of the local file.                                      |
| mimeType     | string | Yes  | Multipurpose Internet Mail Extensions (MIME) type of the media.<br>The value can be 'image/\*', 'video/\*', 'audio/\*' or 'file\*'.|
| relativePath | string | No  | Custom path for storing media assets, for example, 'Pictures/'. If this parameter is unspecified, media assets are stored in the default path.<br> Default path of images: 'Pictures/'<br> Default path of videos: 'Videos/'<br> Default path of audios: 'Audios/'<br> Default path of files: 'Documents/'|
W
wusongqing 已提交
2314

W
wusongqing 已提交
2315
## MediaSelectOption<sup>(deprecated)</sup>
W
wusongqing 已提交
2316 2317 2318

Describes media selection option.

W
wusongqing 已提交
2319 2320 2321
> **NOTE**
>
> This API is deprecated since API version 9.
W
wusongqing 已提交
2322 2323 2324

**System capability**: SystemCapability.Multimedia.MediaLibrary.Core

W
wusongqing 已提交
2325 2326
| Name   | Type    | Mandatory  | Description                  |
| ----- | ------ | ---- | -------------------- |
W
wusongqing 已提交
2327
| type  | string | Yes   | Media type, which can be **image**, **media**, or **video**. Currently, only **media** is supported.|
W
wusongqing 已提交
2328
| count | number | Yes   | Number of media assets selected. The value starts from 1, which indicates that one media asset can be selected.           |