js-apis-medialibrary.md 42.1 KB
Newer Older
P
panqiangbiao 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
媒体库管理
==========

 导入模块
---------

```
import medialibrary from '@ohos.multimedia.medialibrary';
```

权限
----

- ohos.permission.MEDIA_LOCATION
- ohos.permission.MEDIA_READ
- ohos.permission.MEDIA_WRITE


## getMediaLibrary
---------------

function getMediaLibrary(context: Context): MediaLibrary;

获取媒体库。

**参数:** 

| 参数名  | 类型    | 必填 | 说明                 |
| ------- | ------- | ---- | -------------------- |
| context | Context | 是 | API 8接口此参数是必填参数,传入context,获取媒体库 |

**返回值:**

| 类型         | 说明   |
| ------------ | :----- |
| MediaLibrary | 媒体库实例 |

**示例:**

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

## medialibrary.getFileAssets


getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void;    

获取文件资源,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                                                        | 必填 | 说明                                |
| -------- | ----------------------------------------------------------- | ---- | ----------------------------------- |
| options  | MediaFetchOptions                                           | 是   | 媒体获取选项。                      |
| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是   | 异步获取FetchFileResult之后的回调。 |

**示例:**

```
medialibrary.getFileAssets(fetchOp, (error, data) => {
        // do something
        });
```
## medialibrary.getFileAssets

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

获取文件资源,使用Promise方式返回结果。

**参数:**

| 参数名  | 类型                                    | 必填 | 说明           |
| ------- | --------------------------------------- | ---- | -------------- |
| options | [MediaFetchOptions](#MediaFetchOptions) | 是   | 媒体检索选项。 |

**返回值**

| 类型                                         | 说明             |
| -------------------------------------------- | ---------------- |
| [FetchFileResult](#FetchFileResult.getCount) | 媒体数据结果集。 |

**示例:**

```
P
panqiangbiao 已提交
86 87 88 89 90
medialibrary.getFileAssets(fileNoArgsfetchOp).then(function(fetchFileResult){
    console.info("getFileAssets successfully:"+ JSON.stringify(dir));
}).catch(function(err){
    console.info("getFileAssets failed with error:"+ err);
});
P
panqiangbiao 已提交
91 92 93 94
```

## medialibrary.on

P
panqiangbiao 已提交
95
on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback&lt;void&gt;): void;
P
panqiangbiao 已提交
96 97 98 99 100 101 102 103

打开媒体文件变更和上线通知,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                | 必填 | 说明                   |
| -------- | ---------------- | ---- | ------------------- |
| type  | type   | 是   | 媒体类型。         |
P
panqiangbiao 已提交
104
| callback | callback&lt;void&gt; | 是   | 回调返回空。 |
P
panqiangbiao 已提交
105 106 107 108

**示例:**

```
P
panqiangbiao 已提交
109
medialibrary.on('imageChange', () => {
P
panqiangbiao 已提交
110 111 112 113 114
    this.sendNotify('image');
})
```
## medialibrary.off

P
panqiangbiao 已提交
115
off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback&lt;void&gt;): void;
P
panqiangbiao 已提交
116 117 118 119 120 121 122 123

关闭媒体文件变更和设备上线通知,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                | 必填 | 说明                   |
| -------- | ---------------- | ---- | ------------------- |
| type  | type   | 是   | 媒体类型。         |
P
panqiangbiao 已提交
124
| callback | callback&lt;void&gt; | 否   | 回调返回空。 |
P
panqiangbiao 已提交
125 126 127 128

**示例:**

```
P
panqiangbiao 已提交
129
medialibrary.off('imageChange', () => {
P
panqiangbiao 已提交
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    this.sendNotify('image');
})
```

## medialibrary.createAsset

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

创建媒体资源,使用callback方式返回结果。

**参数:**

| 参数名       | 类型                                   | 必填 | 说明                                  |
| ------------ | -------------------------------------- | ---- | ------------------------------------- |
| mediaType    | [MediaType](#MediaType)                | 是   | 媒体类型。                            |
| displayName  | string                                 | 是   | 展示文件名。                          |
| relativePath | string                                 | 是   | 相对路径。                            |
| callback     | AsyncCallback<[FileAsset](#FileAsset)> | 是   | 异步获取媒体数据FileAsset之后的回调。 |

**示例:**

```
medialibrary.createAsset(mediaType, displayName, rp, (createAssetErr, fileObj) => {
        // do something
        });
```

## medialibrary.createAsset

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

创建媒体资源,使用Promise方式返回结果。

**参数:**

| 参数名       | 类型                    | 必填 | 说明         |
| ------------ | ----------------------- | ---- | ------------ |
| mediaType    | [MediaType](#MediaType) | 是   | 媒体类型。   |
| displayName  | string                  | 是   | 展示文件名。 |
| relativePath | string                  | 是   | 相对路径。   |

**返回值**

| 类型                    | 说明              |
| ----------------------- | ----------------- |
| [FileAsset](#FileAsset) | 媒体数据FileAsset |

**示例:**

```
P
panqiangbiao 已提交
180 181 182 183 184
medialibrary.createAsset(mediaType, "image01.jpg", path).then(function(asset){
    console.info("createAsset successfully:"+ JSON.stringify(asset));
}).catch(function(err){
    console.info("createAsset failed with error:"+ err);
});
P
panqiangbiao 已提交
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
```

## medialibrary.deleteAsset

deleteAsset(uri: string, callback: AsyncCallback&lt;void&gt;): void;

删除媒体资源,使用callback方式返回结果。

**参数:**

| 参数名   | 类型                | 必填 | 说明                   |
| -------- | ------------------- | ---- | ---------------------- |
| uri      | string              | 是   | 文件uri。             |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调返回空。 |

**示例:**

```
medialibrary.deleteAsset(fileAsset.uri, (deleteAssetErr, deleteRows) => {
            // do something
            });
```

## medialibrary.deleteAsset

deleteAsset(uri: string): Promise&lt;void&gt;;

删除媒体资源,使用promise方式返回结果。

**参数:**

| 参数名 | 类型   | 必填 | 说明      |
| ------ | ------ | ---- | --------- |
| uri    | string | 是   | 文件uri。 |

**返回值:**

| 类型          | 说明                                              |
| ------------- | ------------------------------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |

**示例:**

```
P
panqiangbiao 已提交
229 230 231 232 233
medialibrary.deleteAsset(asset.uri).then(()=>{
    console.info("deleteAsset successfully");
}).catch(function(err){
    console.info("deleteAsset failed with error:"+ err);
});
P
panqiangbiao 已提交
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
```

## medialibrary.getAlbums

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

获取实体相册,使用callback 方式返回结果。

**参数**

| 参数名   | 类型                                    | 必填 | 说明                          |
| -------- | --------------------------------------- | ---- | ----------------------------- |
| options  | [MediaFetchOptions](#MediaFetchOptions) | 是   | 媒体文件获取条件。            |
| callback | AsyncCallback&lt;Array<[Album](#Album)>&gt;   | 是   | 异步获取Album列表之后的回调。 |

**示例:**

```
medialibrary.getAlbums(AlbumNoArgsfetchOp, getAlbumsCallBack);
```

## medialibrary.getAlbums

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

获取实体相册,使用 promise 方式返回结果。

**参数:**

| 参数名  | 类型                                    | 必填 | 说明               |
| ------- | --------------------------------------- | ---- | ------------------ |
| options | [MediaFetchOptions](#MediaFetchOptions) | 是   | 媒体文件获取条件。 |

**返回值:**

| 类型                            | 说明          |
| ------------------------------- | ------------- |
| Promise<Array<[Album](#Album)>> | 返回Album列表 |

**示例:**

```
P
panqiangbiao 已提交
276 277 278 279 280
medialibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){
    console.info("getAlbums successfully:"+ JSON.stringify(albumList));
}).catch(function(err){
    console.info("getAlbums failed with error:"+ err);
});
P
panqiangbiao 已提交
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
```

## medialibrary.getActivePeers

getActivePeers(callback: AsyncCallback<Array&lt;PeerInfo&gt;>): void;

获取活动对端设备

**参数:**

| 参数名   | 类型                            | 必填 | 说明                   |
| -------- | ------------------------------ | ---- | ---------------------- |
| callback | AsyncCallback<Array<[PeerInfo](#PeerInfo)>> | 是   | 回调表示成功还是失败。 |

**示例:**

```
medialibrary.getActivePeers((err, data) => {
    // do something    
    });
```

## medialibrary.getActivePeers

getActivePeers(): Promise<Array&lt;PeerInfo&gt;>;

获取活动对端设备

**参数:**

返回值:

| 类型                                  | 说明                                |
| ------------------------------------- | ----------------------------------- |
| Promise<Array<[PeerInfo](#PeerInfo)>> | Promise实例,用于获取异步返回结果。 |

**示例:**

```
peerInfoList = medialibrary.getActivePeers();
```

## medialibrary.getAllPeers

getAllPeers(callback: AsyncCallback<Array&lt;PeerInfo&gt;>): void;

获取所有对端设备

**参数:**

| 参数名   | 类型                            | 必填 | 说明                   |
| -------- | ------------------------------ | ---- | ---------------------- |
| callback | AsyncCallback<Array<[PeerInfo](#PeerInfo)>> | 是   | 回调表示成功还是失败。 |

**示例:**

```
medialibrary.getAllPeers((err, data) => {
    // do something
    });
```

## medialibrary.getAllPeers

getAllPeers(): Promise<Array&lt;PeerInfo&gt;>;

获取所有对端设备

**返回值:**

| 类型                                  | 说明                                |
| ------------------------------------- | ----------------------------------- |
| Promise<Array<[PeerInfo](#PeerInfo)>> | Promise实例,用于获取异步返回结果。 |

**示例:**

peerInfoList = media.getAllPeers();

## medialibrary.release

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

释放MediaLibrary实例

**参数:**

| 参数名   | 类型                   | 必填 | 说明                   |
| -------- | ------------------- | ---- | ---------------------- |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调表示成功还是失败。 |

**示例:**

```
medialibrary.release((err, data) => {
    // do something
    });
```

## medialibrary.release

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

释放MediaLibrary实例

**返回值:**

| 类型          | 说明                                |
| ------------- | ----------------------------------- |
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

**示例:**

```
medialibrary.release()
```





## FileAsset.isDirectory

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

判断fileAsset是否为目录,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                          |
| -------- | ---------------------- | ---- | ----------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 当前FileAsset是否是目录的回调 |

**示例:**

```
asset.isDirectory((err, isDirectory) => {
    // do something
    });
```

## FileAsset.isDirectory

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

判断fileAsset是否为目录,使用Promise方式返回异步结果。

**返回值:**

| 类型             | 说明                                       |
| ---------------- | ------------------------------------------ |
| Promise&lt;boolean&gt; | Promise实例,返回当前FileAsset是否是目录。 |

**示例:**

```
P
panqiangbiao 已提交
436 437 438 439 440
asset.isDirectory().then(function(isDirectory){
    console.info("isDirectory result:"+ isDirectory);
}).catch(function(err){
    console.info("isDirectory failed with error:"+ err);
});
P
panqiangbiao 已提交
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
```

## FileAsset.commitModify

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

修改文件的元数据,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调返回空 |

**示例:**

```
P
panqiangbiao 已提交
458 459 460
asset.commitModify(function(err){
    // do something
});
P
panqiangbiao 已提交
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
```

## FileAsset.commitModify

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

修改文件的元数据,使用promise方式返回异步结果。

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise返回空。 |

**示例:**

```
asset.commitModify(commitModifyCallBack);
function commitModifyCallBack(err, commitModify) {
        // do something

    }
```

## FileAsset.open

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

打开当前文件,使用callback方式返回异步结果。

**参数**

| 参数名   | 类型                   | 必填 | 说明                 |
| -------- | ---------------------- | ---- | -------------------- |
| mode     | string                 | 是   | 打开文件方式         |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调返回文件句柄 |

**示例:**

```
asset.open('Rw').then((openError, fd) => {
        // do something
        }
```

## FileAsset.open

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

打开当前文件,使用promise方式返回异步结果。

**参数:**

| 参数名 | 类型   | 必填 | 说明         |
| ------ | ------ | ---- | ------------ |
| mode   | string | 是   | 打开文件方式 |

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;number&gt; | Promise返回文件句柄。 |

**示例:**

```
asset.open('Rw').then((openError, fd) => {
        // do something
        }
```

## FileAsset.close

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

关闭当前文件,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                 |
| -------- | ---------------------- | ---- | -------------------- |
| fd       | number                 | 是   | 文件描述符           |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调返回空 |

**示例:**

```
fileAsset.close(fd).then((closeErr) => {
        // do something
        }
```

## FileAsset.close

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

关闭当前文件,使用promise方式返回异步结果。

**参数:**

| 参数名 | 类型   | 必填 | 说明       |
| ------ | ------ | ---- | ---------- |
| fd     | number | 是   | 文件描述符 |

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise返回空。 |

**示例:**

```
fileAsset.close(fd).then((closeErr) => {
        // do something
        }
```

## FileAsset.getThumbnail

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

获取文件的缩略图,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是   | 回调返回缩略图的PixelMap |

**示例:**

```
data1.getThumbnail(size, (err2, pixelmap) => {
	console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap);
```

## FileAsset.getThumbnail

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

获取文件的缩略图,传入缩略图尺寸,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                 |
| -------- | ---------------------- | ---- | -------------------- |
| size     | [Size](#Size)          | 是   | 缩略图尺寸           |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是   | 回调返回缩略图的PixelMap |

**示例:**

```
data1.getThumbnail(size, (err2, pixelmap) => {
	console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap);
```

## FileAsset.getThumbnail

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

获取文件的缩略图,传入缩略图尺寸,使用promise方式返回异步结果。

**参数:**

| 参数名 | 类型          | 必填 | 说明       |
| ------ | ------------- | ---- | ---------- |
| size   | [Size](#Size) | 否   | 缩略图尺寸 |

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;image.PixelMap&gt; | Promise返回缩略图的PixelMap。 |

**示例:**

```
data1.getThumbnail(size, (err2, pixelmap) => {
	console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap);
```

## FileAsset.favorite

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

将文件设置为收藏文件,使用callback方式返回异步结果。

**参数:**

| 参数名     | 类型                | 必填 | 说明           |
| ---------- | ------------------- | ---- | -------------- |
| isFavorite | boolean             | 是   | 是否为收藏文件 |
| callback   | AsyncCallback&lt;void&gt; | 是   | 回调返回空     |

**示例:**

```
P
panqiangbiao 已提交
659 660 661
asset.favorite(true,function(err){
    // do something
});
P
panqiangbiao 已提交
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
```

## FileAsset.favorite

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

将文件设置为收藏文件,使用promise方式返回异步结果。

**参数:**

| 参数名     | 类型    | 必填 | 说明           |
| ---------- | ------- | ---- | -------------- |
| isFavorite | boolean | 是   | 是否为收藏文件 |

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise返回空。 |

**示例:**

```
P
panqiangbiao 已提交
685 686 687 688 689
asset.favorite(true).then(function() {
    console.info("favorite successfully");
}).catch(function(err){
    console.info("favorite failed with error:"+ err);
});
P
panqiangbiao 已提交
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
```

## FileAsset.isFavorite

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

判断该文件是否为收藏文件,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                   |
| -------- | ---------------------- | ---- | ---------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调表示是否为收藏文件 |

**示例:**

```
asset.favorite(true, (err) => {
        // do something
        });
```

## FileAsset.isFavorite

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

判断该文件是否为收藏文件,使用promise方式返回异步结果。

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;boolean&gt; | Promise回调表示是否是收藏文件。 |

**示例:**

```
P
panqiangbiao 已提交
727 728 729 730 731
asset.isFavorite().then(function(isFavorite){
    console.info("isFavorite result:"+ isFavorite);
}).catch(function(err){
    console.info("isFavorite failed with error:"+ err);
});
P
panqiangbiao 已提交
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
```

## FileAsset.trash

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

当文件被定位时,将文件放到垃圾文件夹,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                 |
| -------- | ---------------------- | ---- | -------------------- |
| isTrash  | boolean                | 是   | 是否为收藏文件       |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调返回空 |

**示例:**

```
asset.trash(true, (err) => {
        // do something
        });
```

## FileAsset.trash

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

当文件被定位时,将文件放到垃圾文件夹,使用promise方式返回异步结果。

**参数:**

| 参数名  | 类型    | 必填 | 说明           |
| ------- | ------- | ---- | -------------- |
| isTrash | boolean | 是   | 是否放入回收站 |

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise返回空。 |

**示例:**

```
P
panqiangbiao 已提交
776 777 778 779 780
asset.trash(true).then(function() {
    console.info("trash successfully");
}).catch(function(err){
    console.info("trash failed with error:"+ err);
});
P
panqiangbiao 已提交
781 782 783 784 785 786 787 788 789 790 791 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
```

## FileAsset.isTrash

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

当文件被定位,判断文件是否为垃圾文件,使用callback方式返回异步结果。

**参数:**

| 参数名   | 类型                   | 必填 | 说明                 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调返回表示文件是否为垃圾文件 |

**示例:**

```
asset.isTrash((err, isTrash) => {
        // do something
        });
```

## FileAsset.isTrash

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

当文件被定位,设置文件为垃圾文件,使用promise方式返回异步结果。

**返回值:**

| 类型          | 说明                          |
| ------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise回调表示文件是否为垃圾文件。 |

**示例:**

```
P
panqiangbiao 已提交
818 819 820 821 822
asset.isTrash().then(function(isTrash){
    console.info("isTrash result:"+ isTrash);
}).catch(function(err){
    console.info("isTrash failed with error:"+ err);
});
P
panqiangbiao 已提交
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
```

**FetchFileResult**

文件检索结果集。

## FetchFileResult.getCount

getCount(): number;

获取文件检索结果中的文件总数。

**返回值**

| 类型   | 说明               |
| ------ | ------------------ |
| number | 检索到的文件总数。 |

**示例**

```
var resultnum = FetchFileResult.getCount();
```

## FetchFileResult.isAfterLast

isAfterLast(): boolean;

检查结果集是否指向最后一行。

**返回值**

| 类型    | 说明                                                         |
| ------- | ------------------------------------------------------------ |
| boolean | 当读到最后一条记录后,再继续读就到结果集尾了,没有记录了,执行isAfterLast()方法就返回true,否则返回false。 |

**示例**

```
var result = FetchFileResult.isAfterLast();
```

## FetchFileResult.close

close(): void;

释放 FetchFileResult 实例并使其失效。无法调用其他方法。

**示例**

```
var result = FetchFileResult.close();
```

## FetchFileResult.getFirstObject

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

获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。

**参数**

| 参数名   | 类型                                   | 必填 | 说明                                          |
| -------- | -------------------------------------- | ---- | --------------------------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#FileAsset)&gt; | 是   | 异步获取结果集中第一个FileAsset完成后的回调。 |

**示例**

```
data.getFirstObject((err, value) => {
   if (err) {
	   console.error('Failed ');
	   return;
   }
   console.log(value);
})
```

## FetchFileResult.getFirstObject

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

获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。

**返回值**

| 类型                | 说明                                   |
| ------------------ | -------------------------------------- |
| Promise&lt;[FileAsset](#FileAsset)&gt; | Promise方式返回FileAsset                |


**示例**

```
P
panqiangbiao 已提交
917 918 919 920 921
queryResultSet_.getFirstObject().then(function(fileAsset){
    console.info("getFirstObject successfully:"+ JSON.stringify(fileAsset));
}).catch(function(err){
    console.info("getFirstObject failed with error:"+ err);
});
P
panqiangbiao 已提交
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
```

## FetchFileResult.getNextObject

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

获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。

**参数**

| 参数名    | 类型                                   | 必填 | 说明                                        |
| --------- | -------------------------------------- | ---- | ------------------------------------------- |
| callbacke | AsyncCallback&lt;[FileAsset](#FileAsset)&gt; | 是   | 异步返回结果集中下一个FileAsset之后的回调。 |

**示例**

```
data.getNextObject((err, value) => {
   if (err) {
	   console.error('Failed ');
	   return;
   }
   console.log(value);
})
```

## FetchFileResult.getNextObject

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

获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。

**返回值**

| 类型                             | 说明                |
| -------------------------------- | ------------------- |
| Promise&lt;[FileAsset](#FileAsset)&gt; | 返回FileAsset对象。 |

**示例**

```
var result = FetchFileResult.getNextObject
```

## FetchFileResult.getLastObject

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

获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。

**参数**

| 参数     | 类型                                   | 必填 | 说明                          |
| -------- | -------------------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#FileAsset)&gt; | 是   | 异步返回FileAsset之后的回调。 |

**示例**

```
data.getLastObject((err, value) => {
   if (err) {
	   console.error('Failed ');
	   return;
   }
   console.log(value);
})
```



## FetchFileResult.getLastObject

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

获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。

**返回值**

| 类型                             | 说明                |
| -------------------------------- | ------------------- |
| Promise&lt;[FileAsset](#FileAsset)&gt; | 返回FileAsset对象。 |

**示例**

```
var result = FetchFileResult.getLastObject()
```

## FetchFileResult.getPositionObject

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

获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。

**参数**

| 参数     | 类型                                   | 必填 | 说明                          |
| -------- | -------------------------------------- | ---- | ----------------------------- |
| index    | number                                 | 是   | 要获取的文件的索引。          |
| callback | AsyncCallback&lt;[FileAsset](#FileAsset)&gt; | 是   | 异步返回FileAsset之后的回调。 |

**示例**

```
data. getPositionObject(1,(err, value) => {
   if (err) {
	   console.error('Failed ');
	   return;
   }
   console.log(value);
})
```

## FetchFileResult.getPositionObject

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

获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。

**参数**

| 参数  | 类型   | 必填 | 说明                 |
| ----- | ------ | ---- | -------------------- |
| index | number | 是   | 要获取的文件在结果集中的位置。 |

**返回值**

| 类型                             | 说明                |
| -------------------------------- | ------------------- |
| Promise&lt;[FileAsset](#FileAsset)&gt; | 返回FileAsset对象。 |

**示例**

```
data.getPositionObject(1,(err, value) => {
   if (err) {
	   console.error('Failed ');
	   return;
   }
   console.log(value);
})
```

## FetchFileResult.getAllObject

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

获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。

**参数**

| 参数     | 类型                                          | 必填 | 说明                              |
| -------- | --------------------------------------------- | ---- | --------------------------------- |
| callback | AsyncCallback<Array<[FileAsset](#FileAsset)>> | 是   | 异步返回FileAsset列表之后的回调。 |

**示例**

```
data.getAllObject((err, value) => {
   if (err) {
	   console.error('Failed ');
	   return;
   }
   console.log(value);
})
```

## FetchFileResult.getAllObject

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

获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。

**返回值**

| 类型                                    | 说明                    |
| --------------------------------------- | ----------------------- |
| Promise<Array<[FileAsset](#FileAsset)>> | 返回FileAsset对象列表。 |

**示例**

```
var data = FetchFileResult.getAllObject();
```





## Album.commitModify

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

更新相册属性修改到数据库中。

**参数**

| 参数     | 类型                | 必填 | 说明                          |
| -------- | ------------------- | ---- | ----------------------------- |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调返回空                   |

**示例**

```
album.albumName = 'hello';
album.commitModify((err, value) => {
   if (err) {
	   console.error('Failed ');
	   return;
   }
   console.log(value);
})
```

## Album.commitModify

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

更新相册属性修改到数据库中。

**返回值**

| 类型          | 说明                                                 |
| ------------- | ---------------------------------------------------- |
| Promise&lt;void&gt; | Promise调用返回空 |

**示例**

```
album.albumName = 'hello';
P
panqiangbiao 已提交
1152 1153 1154 1155 1156
album.commitModify().then(function() {
    console.info("commitModify successfully");
}).catch(function(err){
    console.info("commitModify failed with error:"+ err);
});
P
panqiangbiao 已提交
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
```

## Album.getFileAssets

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

按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。

**参数**

| 参数     | 类型                                                        | 必填 | 说明                                |
| -------- | ----------------------------------------------------------- | ---- | ----------------------------------- |
| options  | [MediaFetchOptions](#MediaFetchOptions)                     | 是   | 媒体检索选项。                      |
| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是   | 异步返回FetchFileResult之后的回调。 |

**示例**

```
album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack);
})
function getFileAssetsCallBack(err, fetchFileResult) {
    // do something
}
```

## Album.getFileAssets

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

按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。

**参数**

| 参数    | 类型                                    | 必填 | 说明           |
| ------- | --------------------------------------- | ---- | -------------- |
| options | [MediaFetchOptions](#MediaFetchOptions) | 否   | 媒体检索选项。 |

**返回值**

| 类型                                                  | 说明                      |
| ----------------------------------------------------- | ------------------------- |
| Promise<[FetchFileResult](#FetchFileResult.getCount)> | 返回FetchFileResult对象。 |

**示例**

```
P
panqiangbiao 已提交
1203 1204 1205 1206 1207
album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){
    console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult));
}).catch(function(err){
    console.info("getFileAssets failed with error:"+ err);
});
P
panqiangbiao 已提交
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
```





## SmartAlbum.getFileAssets

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

获取智能相册中的文件资源

**参数**

| 参数    | 类型              | 必填 | 说明           |
| ------- | ----------------- | ---- | -------------- |
| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是   | 异步返回FetchFileResult之后的回调。 |

**示例**

```
favSmartAlbum.getFileAssets(getFileAssetsCallBack);
function getFileAssetsCallBack(err, fSmartFetchFileResult) {
      // do something
    }
```

## SmartAlbum.getFileAssets

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

获取智能相册中的文件资源

**返回值**

| 类型                                                  | 说明                    |
| ----------------------------------------------------- | ----------------------- |
| Promise<[FetchFileResult](#FetchFileResult.getCount)> | 返回FetchFileResult对象 |

**示例**

```
P
panqiangbiao 已提交
1250 1251 1252 1253 1254
favSmartAlbum.getFileAssets().then(function(fSmartFetchFileResult){
    console.info("getFileAssets successfully:"+ JSON.stringify(fSmartFetchFileResult));
}).catch(function(err){
    console.info("getFileAssets failed with error:"+ err);
});
P
panqiangbiao 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 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 1316 1317 1318 1319 1320 1321 1322 1323 1324 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 1356 1357 1358 1359 1360 1361 1362 1363 1364 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 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 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 1436 1437 1438 1439 1440
```



FileAsset
---------

**属性:**

| 名称         | 类型      | 可读 | 可写 | 说明         |
| ------------ | --------- | ---- | ---- | ------------ |
| id           | number    | 是   | 否   | 文件资源编号 |
| uri          | string    | 是   | 否   | 文件资源uri  |
| mimeType     | string    | 是   | 否   | 文件扩展     |
| mediaType    | MediaType | 是   | 否   | 媒体类型     |
| displayName  | string    | 是   | 是   | 显示文件名   |
| title        | string    | 是   | 是   | 文件标题     |
| relativePath | string    | 是   | 是   | 相对路径     |
| parent       | number    | 是   | 否   | 父目录id     |
| size         | number    | 是   | 否   | 文件大小     |
| dateAdded    | number    | 是   | 否   | 添加日期     |
| dateModified | number    | 是   | 否   | 修改日期     |
| dateTaken    | number    | 是   | 否   | 拍摄日期     |
| artist       | string    | 是   | 否   | 创建者       |
| audioAlbum   | string    | 是   | 否   | 音频相册     |
| width        | number    | 是   | 否   | 图片宽度     |
| height       | number    | 是   | 否   | 图片高度     |
| orientation  | number    | 是   | 是   | 图片方向     |
| duration     | number    | 是   | 否   | 持续时间     |
| albumId      | number    | 是   | 否   | 相册编号     |
| albumUri     | string    | 是   | 否   | 相册uri      |
| albumName    | string    | 是   | 否   | 相册名称     |

Album
---------
实体相册。

**属性**

| 名称         | 参数型 | 可读 | 可写 | 说明           |
| ------------ | ------ | ---- | ---- | -------------- |
| albumId      | number | 是   | 否   | 相册ID         |
| albumName    | string | 是   | 是   | 相册名         |
| albumUri     | string | 是   | 否   | 相册Uri        |
| dateModified | number | 是   | 否   | 修改日期       |
| count        | number | 是   | 否   | 相册中文件数量 |
| relativePath | string | 是   | 否   | 相对路径       |
| coverUri     | string | 是   | 否   | 封面文件Uri    |

SmartAlbum
---------

智能相册

**属性:**

| 名称          | 参数型 | 可读 | 可写 | 说明          |
| ------------- | ------ | ---- | ---- | ------------- |
| albumName     | string | 是   | 是   | 相册名。      |
| albumUri      | string | 是   | 否   | 相册目录。    |
| albumTag      | string | 是   | 是   | 相册标签。    |
| albumCapacity | number | 是   | 否   | 相册容量。    |
| categoryId    | number | 是   | 否   | 相册分类ID。  |
| categoryName  | strign | 是   | 否   | 相册分类名。  |
| coverUri      | string | 是   | 否   | 封面文件uri。 |



MediaType
---------

枚举,媒体类型。

| 名称  | 默认值 | 描述   |
| ----- | ------ | ------ |
| FILE  | 0      | 文件。 |
| IMAGE | 1      | 图片。 |
| VIDEO | 2      | 视频。 |
| AUDIO | 3      | 音频。 |

FileKey
-------

枚举,文件关键信息。

| 名称          | 默认值              | 可读 | 可写 | 描述                 |
| ------------- | ------------------- | ---- | ---- | -------------------- |
| ID            | file_id             | 是   | 否   | 文件编号。           |
| RELATIVE_PATH | relative_path       | 是   | 是   | 相对路径。           |
| DISPLAY_NAME  | display_name        | 是   | 是   | 显示名字。           |
| PARENT        | parent              | 是   | 否   | 父目录。             |
| MIME_TYPE     | mime_type           | 是   | 否   | 该资源的媒体类型。   |
| MEDIA_TYPE    | media_type          | 是   | 否   | 媒体类型。           |
| SIZE          | size                | 是   | 否   | 文件大小。           |
| DATE_ADDED    | date_added          | 是   | 否   | 添加日期。           |
| DATE_MODIFIED | date_modified       | 是   | 否   | 修改日期。           |
| DATE_TAKEN    | date_taken          | 是   | 否   | 表示拍摄日期         |
| TITLE         | title               | 是   | 是   | 表示标题             |
| ARTIST        | artist              | 是   | 否   | 创建者。             |
| AUDIOALBUM    | audio_album         | 是   | 否   | 表示音频相册。       |
| DURATION      | duration            | 是   | 否   | 表示媒体文件时长     |
| WIDTH         | width               | 是   | 否   | 表示图片宽。         |
| HEIGHT        | height              | 是   | 否   | 表示图片高。         |
| ORIENTATION   | orientation         | 是   | 否   | 图片显示方向。       |
| ALBUM_ID      | bucket_id           | 是   | 否   | 媒体文件所在相册ID。 |
| ALBUM_NAME    | bucket_display_name | 是   | 否   | 媒体文件所在相册名。 |

DirectoryType
-------------

枚举,目录类型。

| 名称                   | 默认值 | 描述               |
| ---------------------- | ------ | ------------------ |
| DIR_CDSA               | 0      | 表示CDSA规范路径。 |
| DIR_VIDEO              | 1      | 表示视频路径。     |
| DIR_IMAGE              | 2      | 表示图片路径。     |
| DIR_AUDIO              | 3      | 表示音频路径。     |
| DIR_AUDIO_RINGS        | 4      | 表示铃声音频路径。 |
| DIR_AUDIO_NOTICE       | 5      | 表示提示音频路径。 |
| DIR_AUDIO_CLOCK        | 6      | 表示时钟音频路径。 |
| DIR_DOCUMENTS          | 7      | 表示文档路径。     |
| DIR_DOWNLOAD           | 8      | 表示下载路径。     |
| DIR_DOWNLOAD_BLUETOOTH | 9      | 表示蓝牙下载路径。 |

PrivateAlbumType 
-----------------

枚举,智能相册类型。

| 名称          | 默认值 | 描述                 |
| ------------- | ------ | -------------------- |
| TYPE_FAVORITE | 0      | 表示收藏文件类型。   |
| TYPE_TRASH    | 1      | 表示回收站文件类型。 |

DeviceType 
-----------

枚举,设备类型。

| 名称         | 默认值 | 描述         |
| ------------ | ------ | ------------ |
| TYPE_UNKNOWN | 0      | 未识别设备。 |
| TYPE_LAPTOP  | 1      | 笔记本电脑。 |
| TYPE_PHONE   | 2      | 手机。       |
| TYPE_TABLET  | 3      | 平板电脑。   |
| TYPE_WATCH   | 4      | 智能手表。   |
| TYPE_CAR     | 5      | 车载设备。   |
| TYPE_TV      | 6      | 电视设备。   |

## MediaFetchOptions  

检索条件。

| 名称          | 类型          | 可读 | 可写 | 说明             |
| ------------- | ------------- | ---- | ---- | ---------------- |
| selections    | string        | 是   | 是   | 检索条件         |
| selectionArgs | Array<string> | 是   | 是   | 检索条件的值     |
| order         | string        | 是   | 是   | 检索结果排序方式 |
| uri           | string        | 是   | 是   | 文件URI          |
| networkId     | string        | 是   | 是   | 对端设备网络ID   |
| extendArgs    | string        | 是   | 是   | 扩展的检索参数   |



## PeerInfo 

对端设备信息。

| 名称       | 类型       | 可读 | 可写 | 说明           |
| ---------- | ---------- | ---- | ---- | -------------- |
| deviceName | string     | 是   | 否   | 设备名称       |
| networkId  | string     | 是   | 否   | 对端设备网络ID |
| deviceType | DeviceType | 是   | 否   | 设备类型       |
| isOnline   | boolean    | 是   | 否   | 是否在线       |



## Size

图片尺寸。

| 名称   | 类型   | 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | ---- |
| width  | number | 是   | 是   | 宽   |
| height | number | 是   | 是   | 高   |
P
panqiangbiao 已提交
1441 1442