未验证 提交 bc85ba06 编写于 作者: O openharmony_ci 提交者: Gitee

!8745 modified js-apis-medialibrary.md describe the error

Merge pull request !8745 from 胡伟奇/modify_medialibrary_md
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> 该组件从API Version 6开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 > 该组件从API Version 6开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 导入模块 ## 导入模块
``` ```js
import mediaLibrary from '@ohos.multimedia.mediaLibrary'; import mediaLibrary from '@ohos.multimedia.mediaLibrary';
``` ```
...@@ -32,13 +32,13 @@ getMediaLibrary(context: Context): MediaLibrary ...@@ -32,13 +32,13 @@ getMediaLibrary(context: Context): MediaLibrary
**示例:(从API Version 9开始)** **示例:(从API Version 9开始)**
``` ```ts
var media = mediaLibrary.getMediaLibrary(this.context); var media = mediaLibrary.getMediaLibrary(this.context);
``` ```
**示例:(API Version 8)** **示例:(API Version 8)**
``` ```js
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext() var context = featureAbility.getContext()
...@@ -90,7 +90,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe ...@@ -90,7 +90,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe
**示例:** **示例:**
``` ```js
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = { let imagesfetchOp = {
...@@ -134,7 +134,7 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult> ...@@ -134,7 +134,7 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>
**示例:** **示例:**
``` ```js
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = { let imagesfetchOp = {
...@@ -165,7 +165,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| ...@@ -165,7 +165,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|
**示例:** **示例:**
``` ```js
media.on('imageChange', () => { media.on('imageChange', () => {
// image file had changed, do something // image file had changed, do something
}) })
...@@ -187,7 +187,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' ...@@ -187,7 +187,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'
**示例:** **示例:**
``` ```js
media.off('imageChange', () => { media.off('imageChange', () => {
// stop listening success // stop listening success
}) })
...@@ -214,7 +214,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal ...@@ -214,7 +214,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal
**示例:** **示例:**
``` ```js
async function example() { async function example() {
// 使用Callback方式创建Image类型文件 // 使用Callback方式创建Image类型文件
let mediaType = mediaLibrary.MediaType.IMAGE; let mediaType = mediaLibrary.MediaType.IMAGE;
...@@ -256,7 +256,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr ...@@ -256,7 +256,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr
**示例:** **示例:**
``` ```js
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
media.getPublicDirectory(DIR_CAMERA).then(function(dicResult){ media.getPublicDirectory(DIR_CAMERA).then(function(dicResult){
console.info("getPublicDirectory successfully:"+ JSON.stringify(dicResult)); console.info("getPublicDirectory successfully:"+ JSON.stringify(dicResult));
...@@ -282,7 +282,7 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): ...@@ -282,7 +282,7 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>):
**示例:** **示例:**
``` ```js
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => { media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => {
if (dicResult == 'Camera/') { if (dicResult == 'Camera/') {
...@@ -315,7 +315,7 @@ getPublicDirectory(type: DirectoryType): Promise<string> ...@@ -315,7 +315,7 @@ getPublicDirectory(type: DirectoryType): Promise<string>
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
const dicResult = await media.getPublicDirectory(DIR_CAMERA); const dicResult = await media.getPublicDirectory(DIR_CAMERA);
...@@ -346,7 +346,7 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array&lt;Album&gt; ...@@ -346,7 +346,7 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array&lt;Album&gt;
**示例:** **示例:**
``` ```js
let AlbumNoArgsfetchOp = { let AlbumNoArgsfetchOp = {
selections: '', selections: '',
selectionArgs: [], selectionArgs: [],
...@@ -386,7 +386,7 @@ getAlbums(options: MediaFetchOptions): Promise<Array&lt;Album&gt;> ...@@ -386,7 +386,7 @@ getAlbums(options: MediaFetchOptions): Promise<Array&lt;Album&gt;>
**示例:** **示例:**
``` ```js
let AlbumNoArgsfetchOp = { let AlbumNoArgsfetchOp = {
selections: '', selections: '',
selectionArgs: [], selectionArgs: [],
...@@ -415,7 +415,7 @@ release(callback: AsyncCallback&lt;void&gt;): void ...@@ -415,7 +415,7 @@ release(callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
``` ```js
var media = mediaLibrary.getMediaLibrary(context); var media = mediaLibrary.getMediaLibrary(context);
media.release((err) => { media.release((err) => {
// do something // do something
...@@ -439,7 +439,7 @@ release(): Promise&lt;void&gt; ...@@ -439,7 +439,7 @@ release(): Promise&lt;void&gt;
**示例:** **示例:**
``` ```js
media.release() media.release()
``` ```
...@@ -462,7 +462,7 @@ storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;) ...@@ -462,7 +462,7 @@ storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;)
**示例:** **示例:**
``` ```js
let option = { let option = {
src : "/data/storage/el2/base/haps/entry/image.png", src : "/data/storage/el2/base/haps/entry/image.png",
mimeType : "image/*", mimeType : "image/*",
...@@ -476,7 +476,7 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => { ...@@ -476,7 +476,7 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => {
console.log("Media resources stored. "); console.log("Media resources stored. ");
// Obtain the URI that stores media resources. // Obtain the URI that stores media resources.
}); });
``` ```
### storeMediaAsset<sup>(deprecated)</sup> ### storeMediaAsset<sup>(deprecated)</sup>
...@@ -503,7 +503,7 @@ storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt; ...@@ -503,7 +503,7 @@ storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt;
**示例:** **示例:**
``` ```js
let option = { let option = {
src : "/data/storage/el2/base/haps/entry/image.png", src : "/data/storage/el2/base/haps/entry/image.png",
mimeType : "image/*", mimeType : "image/*",
...@@ -515,7 +515,7 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => { ...@@ -515,7 +515,7 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => {
}).catch((err) => { }).catch((err) => {
console.log("An error occurred when storing media resources."); console.log("An error occurred when storing media resources.");
}); });
``` ```
### startImagePreview<sup>(deprecated)</sup> ### startImagePreview<sup>(deprecated)</sup>
...@@ -538,7 +538,7 @@ startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCal ...@@ -538,7 +538,7 @@ startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCal
**示例:** **示例:**
``` ```js
let images = [ let images = [
"dataability:///media/xxxx/2", "dataability:///media/xxxx/2",
"dataability:///media/xxxx/3" "dataability:///media/xxxx/3"
...@@ -557,7 +557,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => { ...@@ -557,7 +557,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => {
} }
console.log("Succeeded in previewing the images."); console.log("Succeeded in previewing the images.");
}); });
``` ```
### startImagePreview<sup>(deprecated)</sup> ### startImagePreview<sup>(deprecated)</sup>
...@@ -579,7 +579,7 @@ startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&g ...@@ -579,7 +579,7 @@ startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&g
**示例:** **示例:**
``` ```js
let images = [ let images = [
"dataability:///media/xxxx/2", "dataability:///media/xxxx/2",
"dataability:///media/xxxx/3" "dataability:///media/xxxx/3"
...@@ -597,7 +597,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => { ...@@ -597,7 +597,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => {
} }
console.log("Succeeded in previewing the images."); console.log("Succeeded in previewing the images.");
}); });
``` ```
### startImagePreview<sup>(deprecated)</sup> ### startImagePreview<sup>(deprecated)</sup>
...@@ -625,7 +625,7 @@ startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void& ...@@ -625,7 +625,7 @@ startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&
**示例:** **示例:**
``` ```js
let images = [ let images = [
"dataability:///media/xxxx/2", "dataability:///media/xxxx/2",
"dataability:///media/xxxx/3" "dataability:///media/xxxx/3"
...@@ -642,7 +642,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => { ...@@ -642,7 +642,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => {
}).catch((err) => { }).catch((err) => {
console.log("An error occurred when previewing the images."); console.log("An error occurred when previewing the images.");
}); });
``` ```
### startMediaSelect<sup>(deprecated)</sup> ### startMediaSelect<sup>(deprecated)</sup>
...@@ -664,7 +664,7 @@ startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt; ...@@ -664,7 +664,7 @@ startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;
**示例:** **示例:**
``` ```js
let option = { let option = {
type : "media", type : "media",
count : 2 count : 2
...@@ -677,7 +677,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => { ...@@ -677,7 +677,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => {
console.log("Media resources selected."); console.log("Media resources selected.");
// Obtain the media selection value. // Obtain the media selection value.
}); });
``` ```
### startMediaSelect<sup>(deprecated)</sup> ### startMediaSelect<sup>(deprecated)</sup>
...@@ -704,7 +704,7 @@ startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt; ...@@ -704,7 +704,7 @@ startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt;
**示例:** **示例:**
``` ```js
let option = { let option = {
type : "media", type : "media",
count : 2 count : 2
...@@ -716,7 +716,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => { ...@@ -716,7 +716,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
console.log("An error occurred when selecting media resources."); console.log("An error occurred when selecting media resources.");
}); });
``` ```
## FileAsset<sup>7+</sup> ## FileAsset<sup>7+</sup>
...@@ -769,7 +769,7 @@ isDirectory(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -769,7 +769,7 @@ isDirectory(callback: AsyncCallback&lt;boolean&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -805,7 +805,7 @@ isDirectory():Promise&lt;boolean&gt; ...@@ -805,7 +805,7 @@ isDirectory():Promise&lt;boolean&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -843,7 +843,7 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void ...@@ -843,7 +843,7 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -880,7 +880,7 @@ commitModify(): Promise&lt;void&gt; ...@@ -880,7 +880,7 @@ commitModify(): Promise&lt;void&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -918,7 +918,7 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -918,7 +918,7 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let mediaType = mediaLibrary.MediaType.IMAGE; let mediaType = mediaLibrary.MediaType.IMAGE;
let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
...@@ -960,7 +960,7 @@ open(mode: string): Promise&lt;number&gt; ...@@ -960,7 +960,7 @@ open(mode: string): Promise&lt;number&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let mediaType = mediaLibrary.MediaType.IMAGE; let mediaType = mediaLibrary.MediaType.IMAGE;
let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
...@@ -995,7 +995,7 @@ close(fd: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -995,7 +995,7 @@ close(fd: number, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1048,7 +1048,7 @@ close(fd: number): Promise&lt;void&gt; ...@@ -1048,7 +1048,7 @@ close(fd: number): Promise&lt;void&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1096,7 +1096,7 @@ getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void ...@@ -1096,7 +1096,7 @@ getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1133,7 +1133,7 @@ getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void ...@@ -1133,7 +1133,7 @@ getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1176,7 +1176,7 @@ getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt; ...@@ -1176,7 +1176,7 @@ getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1218,7 +1218,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -1218,7 +1218,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1260,7 +1260,7 @@ favorite(isFavorite: boolean): Promise&lt;void&gt; ...@@ -1260,7 +1260,7 @@ favorite(isFavorite: boolean): Promise&lt;void&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1298,7 +1298,7 @@ isFavorite(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1298,7 +1298,7 @@ isFavorite(callback: AsyncCallback&lt;boolean&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1338,7 +1338,7 @@ isFavorite():Promise&lt;boolean&gt; ...@@ -1338,7 +1338,7 @@ isFavorite():Promise&lt;boolean&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1379,7 +1379,7 @@ trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -1379,7 +1379,7 @@ trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1424,7 +1424,7 @@ trash(isTrash: boolean): Promise&lt;void&gt; ...@@ -1424,7 +1424,7 @@ trash(isTrash: boolean): Promise&lt;void&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1462,7 +1462,7 @@ isTrash(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1462,7 +1462,7 @@ isTrash(callback: AsyncCallback&lt;boolean&gt;): void
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1507,7 +1507,7 @@ isTrash():Promise&lt;boolean&gt; ...@@ -1507,7 +1507,7 @@ isTrash():Promise&lt;boolean&gt;
**示例:** **示例:**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1527,6 +1527,239 @@ async function example() { ...@@ -1527,6 +1527,239 @@ async function example() {
} }
``` ```
### deleteAsset<sup>8+</sup>
deleteAsset(uri: string): Promise<void>;
删除媒体文件资源
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA
**系统能力**:SystemCapability.Multimedia.MediaLibrary.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------- |
| uri | string | 是 | 需要删除的媒体文件资源的uri |
**示例:**
```js
async function example() {
let fileKeyObj = mediaLibrary.FileKey
let fileType = mediaLibrary.MediaType.FILE
let option = {
selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [fileType.toString()],
};
const context = getContext(this);
var media = mediaLibrary.getMediaLibrary(context);
const fetchFileResult = await media.getFileAssets(option);
let asset = await fetchFileResult.getFirstObject();
if (asset == undefined) {
console.error('asset not exist')
return
}
media.deleteAsset(asset.uri).then(() => {
console.info("deleteAsset successfully");
}).catch((err) => {
console.info("deleteAsset failed with error:"+ err);
});
}
```
deleteAsset(uri: string, callback: AsyncCallback<void>): void;
删除媒体文件资源
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA
**系统能力**:SystemCapability.Multimedia.MediaLibrary.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------- |
| uri | string | 是 | 需要删除的媒体文件资源的uri |
**示例:**
```js
async function example() {
let fileKeyObj = mediaLibrary.FileKey
let fileType = mediaLibrary.MediaType.FILE
let option = {
selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [fileType.toString()],
};
const context = getContext(this);
var media = mediaLibrary.getMediaLibrary(context);
const fetchFileResult = await media.getFileAssets(option);
let asset = await fetchFileResult.getFirstObject();
if (asset == undefined) {
console.error('asset not exist')
return
}
media.deleteAsset(asset.uri, (err) => {
if (err != undefined) {
console.info("deleteAsset successfully");
} else {
console.info("deleteAsset failed with error:"+ err);
}
});
}
```
### getActivePeers<sup>8+</sup>
getActivePeers(): Promise<Array<PeerInfo>>;
获取在线对端设备的信息,使用Promise方式返回异步结果
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.READ_MEDIA
**系统能力**:SystemCapability.Multimedia.MediaLibrary.DistributedCore
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------- |
| Promise<Array<PeerInfo>> | 返回获取的所有在线对端设备的PeerInfo |
**示例:**
```js
async function example() {
const context = getContext(this);
var media = mediaLibrary.getMediaLibrary(context);
media.getActivePeers().then((devicesInfo) => {
if (devicesInfo != undefined) {
for (let i = 0; i < devicesInfo.length; i++) {
console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
}
} else {
console.info('get distributed info is undefined!')
}
}).catch((err) => {
console.info("get distributed info failed with error:" + err);
});
}
```
getActivePeers(callback: AsyncCallback<Array<PeerInfo>>): void;
获取在线对端设备的信息,使用callback方式返回异步结果。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.READ_MEDIA
**系统能力**:SystemCapability.Multimedia.MediaLibrary.DistributedCore
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------- |
| callback: AsyncCallback<Array<PeerInfo>> | 返回获取的所有在线对端设备的PeerInfo |
**示例:**
```js
async function example() {
const context = getContext(this);
var media = mediaLibrary.getMediaLibrary(context);
media.getActivePeers((err, devicesInfo) => {
if (devicesInfo != undefined) {
for (let i = 0; i < devicesInfo.length; i++) {
console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
}
} else {
console.info('get distributed fail, message = ' + err)
}
})
}
```
### getAllPeers<sup>8+</sup>
getAllPeers(): Promise<Array<PeerInfo>>;
获取所有对端设备的信息,使用Promise方式返回异步结果
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.READ_MEDIA
**系统能力**:SystemCapability.Multimedia.MediaLibrary.DistributedCore
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------- |
| Promise<Array<PeerInfo>> | 返回获取的所有对端设备的PeerInfo |
**示例:**
```js
async function example() {
const context = getContext(this);
var media = mediaLibrary.getMediaLibrary(context);
media.getAllPeers().then((devicesInfo) => {
if (devicesInfo != undefined) {
for (let i = 0; i < devicesInfo.length; i++) {
console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
}
} else {
console.info('get distributed info is undefined!')
}
}).catch((err) => {
console.info("get distributed info failed with error:" + err);
});
}
```
getAllPeers(callback: AsyncCallback<Array<PeerInfo>>): void;
获取所有对端设备的信息,使用callback方式返回异步结果。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.READ_MEDIA
**系统能力**:SystemCapability.Multimedia.MediaLibrary.DistributedCore
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------- |
| callback: AsyncCallback<Array<PeerInfo>> | 返回获取的所有对端设备的PeerInfo |
**示例:**
```js
async function example() {
const context = getContext(this);
var media = mediaLibrary.getMediaLibrary(context);
media.getAllPeers((err, devicesInfo) => {
if (devicesInfo != undefined) {
for (let i = 0; i < devicesInfo.length; i++) {
console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId);
}
} else {
console.info('get distributed fail, message = ' + err)
}
})
}
```
## FetchFileResult<sup>7+</sup> ## FetchFileResult<sup>7+</sup>
文件检索结果集。 文件检索结果集。
...@@ -1547,7 +1780,7 @@ getCount(): number ...@@ -1547,7 +1780,7 @@ getCount(): number
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let fileType = mediaLibrary.MediaType.FILE; let fileType = mediaLibrary.MediaType.FILE;
...@@ -1578,7 +1811,7 @@ isAfterLast(): boolean ...@@ -1578,7 +1811,7 @@ isAfterLast(): boolean
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1616,7 +1849,7 @@ close(): void ...@@ -1616,7 +1849,7 @@ close(): void
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1647,7 +1880,7 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -1647,7 +1880,7 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1684,7 +1917,7 @@ getFirstObject(): Promise&lt;FileAsset&gt; ...@@ -1684,7 +1917,7 @@ getFirstObject(): Promise&lt;FileAsset&gt;
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1719,7 +1952,7 @@ async function example() { ...@@ -1719,7 +1952,7 @@ async function example() {
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1756,7 +1989,7 @@ async function example() { ...@@ -1756,7 +1989,7 @@ async function example() {
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1789,7 +2022,7 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -1789,7 +2022,7 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1826,7 +2059,7 @@ getLastObject(): Promise&lt;FileAsset&gt; ...@@ -1826,7 +2059,7 @@ getLastObject(): Promise&lt;FileAsset&gt;
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1858,7 +2091,7 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -1858,7 +2091,7 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1901,7 +2134,7 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt; ...@@ -1901,7 +2134,7 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt;
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1913,9 +2146,9 @@ async function example() { ...@@ -1913,9 +2146,9 @@ async function example() {
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getPositionObject(1) .then(function (fileAsset){ fetchFileResult.getPositionObject(1) .then(function (fileAsset){
console.log('[Demo] fileAsset.displayName : ' + fileAsset.displayName); console.log('fileAsset.displayName : ' + fileAsset.displayName);
}).catch(function (err) { }).catch(function (err) {
console.info("[Demo] getFileAssets failed with error:" + err); console.info("getFileAssets failed with error:" + err);
}); });
} }
``` ```
...@@ -1936,7 +2169,7 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void ...@@ -1936,7 +2169,7 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -1973,7 +2206,7 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt; ...@@ -1973,7 +2206,7 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt;
**示例** **示例**
``` ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
...@@ -2024,7 +2257,7 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void ...@@ -2024,7 +2257,7 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
**示例** **示例**
``` ```js
async function example() { async function example() {
let AlbumNoArgsfetchOp = { let AlbumNoArgsfetchOp = {
selections: '', selections: '',
...@@ -2061,7 +2294,7 @@ commitModify(): Promise&lt;void&gt; ...@@ -2061,7 +2294,7 @@ commitModify(): Promise&lt;void&gt;
**示例** **示例**
``` ```js
async function example() { async function example() {
let AlbumNoArgsfetchOp = { let AlbumNoArgsfetchOp = {
selections: '', selections: '',
...@@ -2097,7 +2330,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe ...@@ -2097,7 +2330,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
**示例** **示例**
``` ```js
async function example() { async function example() {
let AlbumNoArgsfetchOp = { let AlbumNoArgsfetchOp = {
selections: '', selections: '',
...@@ -2140,7 +2373,7 @@ async function example() { ...@@ -2140,7 +2373,7 @@ async function example() {
**示例** **示例**
``` ```js
async function example() { async function example() {
let AlbumNoArgsfetchOp = { let AlbumNoArgsfetchOp = {
selections: '', selections: '',
...@@ -2163,7 +2396,8 @@ async function example() { ...@@ -2163,7 +2396,8 @@ async function example() {
## PeerInfo<sup>8+</sup> ## PeerInfo<sup>8+</sup>
注册设备的信息。 注册设备的信息。
此接口为系统接口。
**系统接口**:此接口为系统接口。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore
...@@ -2235,7 +2469,8 @@ async function example() { ...@@ -2235,7 +2469,8 @@ async function example() {
## DeviceType<sup>8+</sup> ## DeviceType<sup>8+</sup>
枚举,设备类型。 枚举,设备类型。
此接口为系统接口。
**系统接口**:此接口为系统接口。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore
...@@ -2267,7 +2502,8 @@ async function example() { ...@@ -2267,7 +2502,8 @@ async function example() {
## Size<sup>8+</sup> ## Size<sup>8+</sup>
图片尺寸。 图片尺寸。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | -------- | | ------ | ------ | ---- | ---- | -------- |
...@@ -2302,3 +2538,4 @@ async function example() { ...@@ -2302,3 +2538,4 @@ async function example() {
| type | string | 是 | 媒体类型,包括:image, video, media,当前仅支持media类型 | | type | string | 是 | 媒体类型,包括:image, video, media,当前仅支持media类型 |
| count | number | 是 | 媒体选择,count = 1表示单选,count大于1表示多选。 | | count | number | 是 | 媒体选择,count = 1表示单选,count大于1表示多选。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册