鸿蒙开发接口媒体：【@ohos.multimedia.medialibrary (媒体库管理)】

jf_46214456 2024-06-03 678

电子说

1.2w人已加入

描述

媒体库管理

接口说明： 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

导入模块

import mediaLibrary from '@ohos.multimedia.mediaLibrary';

mediaLibrary.getMediaLibrary8+

getMediaLibrary(context: Context): MediaLibrary

获取媒体库的实例，用于访问和修改用户等个人媒体数据信息（如音频、视频、图片、文档等）。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
contextContext是传入Ability实例的Context。

返回值：

类型说明
[MediaLiary]媒体库实例

示例：（从API Version 9开始）

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

示例：（API Version 8）

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

var context = featureAbility.getContext()
var media = mediaLibrary.getMediaLibrary(context);

mediaLibrary.getMediaLibrary

getMediaLibrary(): MediaLibrary

获取媒体库的实例，用于访问和修改用户等个人媒体数据信息（如音频、视频、图片、文档等）。

说明 ： 从API Version 8开始，该接口不再维护，推荐使用新接口[mediaLibrary.getMediaLibrary8+]。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值：

类型说明
[MediaLiary]媒体库实例

示例：

var media = mediaLibrary.getMediaLibrary();

MediaLibrary

getFileAssets7+

getFileAssets(options: MediaFetchOptions, callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
options[MediaFetchOptions]是文件获取选项
callbackAsyncCallback<[FetchFileResult]>是异步获取FetchFileResult之后的回调

示例：

let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = {
    selections: fileKeyObj.MEDIA_TYPE + '= ?',
    selectionArgs: [imageType.toString()],
};
mediaLibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) = > {
    if (fetchFileResult != undefined) {
        console.info('mediaLibraryTest : ASSET_CALLBACK fetchFileResult success');
        fetchFileResult.getAllObject((err, fileAssetList) = > {
            if (fileAssetList != undefined) {
                fileAssetList.forEach(getAllObjectInfo);
            }
    	});
    }
});

getFileAssets7+

getFileAssets(options: MediaFetchOptions): Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
options[MediaFetchOptions]是文件检索选项

返回值

类型说明
[FetchFileResult]文件数据结果集

示例：

let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = {
    selections: fileKeyObj.MEDIA_TYPE + '= ?',
    selectionArgs: [imageType.toString()],
};
mediaLibrary.getFileAssets(imagesfetchOp).then(function(fetchFileResult){
    console.info("getFileAssets successfully:"+ JSON.stringify(dir));
}).catch(function(err){
    console.info("getFileAssets failed with error:"+ err);
});

on8+

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

打开媒体媒体库变更通知，使用callback方式返回异步结果。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
typestring是媒体类型 'deviceChange'： 注册设备变更 'albumChange'： 相册变更 'imageChange'： 图片文件变更 'audioChange'： 音频文件变更 'videoChange'： 视频文件变更 'fileChange'： 文件变更 'remoteFileChange'： 注册设备上文件变更
callbackcallback是回调返回空

示例：

mediaLibrary.on('imageChange', () = > {
    // image file had changed, do something
})

off8+

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

关闭媒体媒体库变更通知，使用callback方式返回异步结果。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
typestring是媒体类型 'deviceChange'： 注册设备变更 'albumChange'： 相册变更 'imageChange'： 图片文件变更 'audioChange'： 音频文件变更 'videoChange'： 视频文件变更 'fileChange'： 文件变更 'remoteFileChange'： 注册设备上文件变更
callbackcallback否回调返回空

示例：

mediaLibrary.off('imageChange', () = > {
    // stop listening success
})

createAsset 8+

createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
mediaType[MediaType]是媒体类型
displayNamestring是展示文件名
relativePathstring是文件保存路径，可以通过[getPublicDirectory]获取不同类型文件的保存路径
callbackAsyncCallback<[FileAsset]>是异步获取媒体数据FileAsset之后的回调

示例：

async function example() {
    // 使用Callback方式创建Image类型文件
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
    media.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (err, fileAsset) = > {
        if (fileAsset != undefined) {
            console.info('createAsset successfully, message = ' + err);
        } else {
            console.info('createAsset failed, message = ' + err);
        }
    });
}

createAsset8+

createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
mediaType[MediaType]是媒体类型
displayNamestring是展示文件名
relativePathstring是相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path

返回值

类型说明
[FileAsset]媒体数据FileAsset

示例：

async function example() {
    // 使用Promise方式创建Image类型文件
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
    media.createAsset(mediaType, "image01.jpg", path + 'myPicture/').then (function (asset) {
        console.info("createAsset successfully:"+ JSON.stringify(asset));
    }).catch(function(err){
        console.info("createAsset failed with error:"+ err);
    });
}

getPublicDirectory8+

getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void

获取公共目录路径，使用callback方式返回结果。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
type[DirectoryType]是公共目录类型
callbackAsyncCallback是callback 返回公共目录路径

示例：

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');
    }
});

getPublicDirectory8+

getPublicDirectory(type: DirectoryType): Promise

获取公共目录路径，使用Promise方式返回结果。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
type[DirectoryType]是公共目录类型

返回值：

类型说明
Promise返回公共目录路径

示例：

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');
    }
}

getAlbums7+

getAlbums(options: MediaFetchOptions, callback: AsyncCallback>): void

获取相册列表，使用callback 方式返回结果。

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数

参数名类型必填说明
options[MediaFetchOptions]是相册获取条件
callbackAsyncCallback>是异步获取Album列表之后的回调

示例：

let AlbumNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
};
mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) = > {
    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);
     }
})

getAlbums7+

getAlbums(options: MediaFetchOptions): Promise>

获取相册列表，使用 promise 方式返回结果。

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
options[MediaFetchOptions]是相册获取条件

返回值：

类型说明
Promise>返回Album列表

示例：

let AlbumNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
};
mediaLibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){
    console.info("getAlbums successfully:"+ JSON.stringify(albumList));
}).catch(function(err){
    console.info("getAlbums failed with error:"+ err);
});

release8+

release(callback: AsyncCallback): void

释放MediaLibrary实例。 当后续不需要使用MediaLibrary实例中的方法时调用。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调表示成功还是失败

示例：

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

release8+

release(): Promise

释放MediaLibrary实例。 当后续不需要使用MediaLibrary实例中的方法时调用。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值：

类型说明
PromisePromise实例，用于获取异步返回结果

示例：

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

storeMediaAsset(deprecated)

storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback): void

保存媒体资源，以异步方法获取保存成功的URI，使用callback形式返回结果。

说明 ： 从API Version 9开始废弃。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
option[MediaAssetOption]是媒体资源选项。
callbackAsyncCallback是媒体资源保存回调，返回保存成功后得到的URI。

示例：

let option = {
  src : "/data/storage/el2/base/haps/entry/image.png",
  mimeType : "image/*",
  relativePath : "Pictures/"
};
mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) = > {
  if (err) {
      console.log("An error occurred when storing media resources.");
      return;
  }
  console.log("Media resources stored. ");
  // Obtain the URI that stores media resources.
});

storeMediaAsset(deprecated)

storeMediaAsset(option: MediaAssetOption): Promise

保存媒体资源，以异步方法获取保存成功的URI，使用Promise形式返回结果。

说明 ： 从API Version 9开始废弃。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
option[MediaAssetOption]是媒体资源选项。

返回值：

类型说明
PromisePromise实例，用于异步获取保存成功后得到的URI。

示例：

let option = {
  src : "/data/storage/el2/base/haps/entry/image.png",
  mimeType : "image/*",
  relativePath : "Pictures/"
};
mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) = > {
  console.log("Media resources stored.");
  // Obtain the URI that stores media resources.
}).catch((err) = > {
  console.log("An error occurred when storing media resources.");
});

startImagePreview(deprecated)

startImagePreview(images: Array, index: number, callback: AsyncCallback): void

启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（dataability://），也可以预览列表中的所有网络图片（https://）。使用callback方式进行异步回调。

说明 ： 从API Version 9开始废弃。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
imagesArray是预览的图片URI（"https://"，"dataability://"）列表。
indexnumber是开始显示的图片序号。
callbackAsyncCallback是图片预览回调，失败时返回错误信息。

示例：

let images = [
  "dataability:///media/xxxx/2",
  "dataability:///media/xxxx/3"
];
/* 网络图片使用方式
let images = [
  "https://media.xxxx.com/image1.jpg",
  "https://media.xxxx.com/image2.jpg"
];
*/
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.");
});

startImagePreview(deprecated)

startImagePreview(images: Array, callback: AsyncCallback): void

启动图片预览界面，可以预览列表中首张本地图片（dataability://），也可以预览列表中的所有网络图片（https://）。使用callback方式进行异步回调。

说明 ： 从API Version 9开始废弃。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
imagesArray是预览的图片URI（"https://"，"dataability://"）列表。
callbackAsyncCallback是图片预览回调，失败时返回错误信息。

示例：

let images = [
  "dataability:///media/xxxx/2",
  "dataability:///media/xxxx/3"
];
/* 网络图片使用方式
let images = [
  "https://media.xxxx.com/image1.jpg",
  "https://media.xxxx.com/image2.jpg"
];
*/
mediaLibrary.getMediaLibrary().startImagePreview(images, (err) = > {
  if (err) {
      console.log("An error occurred when previewing the images.");
      return;
  }
  console.log("Succeeded in previewing the images.");
});

startImagePreview(deprecated)

startImagePreview(images: Array, index?: number): Promise

启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（dataability://），也可以预览列表中的所有网络图片（https://）。使用Promise方式进行异步回调。

说明 ： 从API Version 9开始废弃。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
imagesArray是预览的图片URI（"https://"，"dataability://"）列表。
indexnumber否开始显示的图片序号，不选择时默认为0。

返回值：

类型说明
PromisePromise实例，用于异步获取预览结果，失败时返回错误信息。

示例：

let images = [
  "dataability:///media/xxxx/2",
  "dataability:///media/xxxx/3"
];
/* 网络图片使用方式
let images = [
  "https://media.xxxx.com/image1.jpg",
  "https://media.xxxx.com/image2.jpg"
];
*/
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.");
});

startMediaSelect(deprecated)

startMediaSelect(option: MediaSelectOption, callback: AsyncCallback>): void

启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用callback形式返回结果。

说明 ： 从API Version 9开始废弃。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
option[MediaSelectOption]是媒体选择选项。
callbackAsyncCallback>是媒体选择回调，返回选择的媒体URI（dataability://）列表。

示例：

let option = {
  type : "image",
  count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) = > {
  if (err) {
      console.log("An error occurred when selecting media resources.");
      return;
  }
  console.log("Media resources selected.");
  // Obtain the media selection value.
});

startMediaSelect(deprecated)

startMediaSelect(option: MediaSelectOption): Promise>

启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用Promise形式返回结果。

说明 ： 从API Version 9开始废弃。

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
option[MediaSelectOption]是媒体选择选项。

返回值：

类型说明
Promise>Promise实例，用于异步获取选择的媒体URI（dataability://）列表。

示例：

let option = {
  type : "image",
  count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) = > {
  console.log("Media resources selected.");
  // Obtain the media selection value.
}).catch((err) = > {
  console.log("An error occurred when selecting media resources.");
});

FileAsset7+

提供封装文件属性的方法。

属性

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称类型可读可写说明
idnumber是否文件资源编号
uristring是否文件资源uri（如：dataability:///media/image/2)
mimeTypestring是否文件扩展属性
mediaType8+[MediaType]是否媒体类型
displayNamestring是是显示文件名，包含后缀名
titlestring是是文件标题
relativePath8+string是是相对公共目录路径
parent8+number是否父目录id
sizenumber是否文件大小（单位：字节）
dateAddednumber是否添加日期（添加文件时间到1970年1月1日的秒数值）
dateModifiednumber是否修改日期（修改文件时间到1970年1月1日的秒数值）
dateTakennumber是否拍摄日期（文件拍照时间到1970年1月1日的秒数值）
artist8+string是否作者
audioAlbum8+string是否专辑
widthnumber是否图片宽度（单位：像素）
heightnumber是否图片高度（单位：像素）
orientationnumber是是图片显示方向（顺时针旋转角度，如0，90，180 单位：度）
duration8+number是否持续时间（单位：毫秒）
albumIdnumber是否文件所归属的相册编号
albumUri8+string是否文件所归属相册uri
albumNamestring是否文件所归属相册名称

isDirectory8+

isDirectory(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
callbackAsyncCallback是当前FileAsset是否是目录的回调

示例：

async function example() {
    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
    });
}

isDirectory8+

isDirectory():Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值：

类型说明
PromisePromise实例，返回当前FileAsset是否是目录

示例：

async function example() {
    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);
    });
}

commitModify8+

commitModify(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调返回空

示例：

async function example() {
    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');   
    });
}

commitModify8+

commitModify(): Promise

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值：

类型说明
PromisePromise返回空

示例：

async function example() {
    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();
}

open8+

open(mode: string, callback: AsyncCallback): void

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

注意 ：当前写操作是互斥的操作，写操作完成后需要调用close进行释放

需要权限 ：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开）

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数

参数名类型必填说明
modestring是打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写）
callbackAsyncCallback是回调返回文件句柄

示例：

async function example() {
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
    asset = await media.createAsset(mediaType, "image00003.jpg", path);
    asset.open('rw', (openError, fd) = > {
            if(fd > 0){
                asset.close(fd);
            }else{
                console.info('File Open Failed!' + openError);
            }
    });
}

open8+

open(mode: string): Promise

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

注意 ：当前写操作是互斥的操作，写操作完成后需要调用close进行释放

需要权限 ：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开）

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
modestring是打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写）

返回值：

类型说明
PromisePromise返回文件句柄

示例：

async function example() {
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
    asset = await media.createAsset(mediaType, "image00003.jpg", path);
    asset.open('rw')
        .then((fd) = > {
            console.info('File fd!' + fd);
        })
        .catch((err) = > {
            console.info('File err!' + err);
        });
}

close8+

close(fd: number, callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开）

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
fdnumber是文件描述符
callbackAsyncCallback是回调返回空

示例：

async function example() {
    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.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==== >");
        }
    });
}

close8+

close(fd: number): Promise

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

需要权限 ：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开）

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
fdnumber是文件描述符

返回值：

类型说明
PromisePromise返回空

示例：

async function example() {
    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.close(fd).then((closeErr) = > {
        if (closeErr != undefined) {
            console.info('mediaLibraryTest : close : FAIL ' + closeErr.message);
            console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL');

        } else {
            console.info("=======asset.close success==== >");
        }
    });
}

getThumbnail8+

getThumbnail(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调返回缩略图的PixelMap

示例：

async function example() {
    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) = > {
        console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap);
    });
}

getThumbnail8+

getThumbnail(size: Size, callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
size[Size]是缩略图尺寸
callbackAsyncCallback是回调返回缩略图的PixelMap

示例：

async function example() {
    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(size, (err, pixelmap) = > {
        console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap);
    });
}

getThumbnail8+

getThumbnail(size?: Size): Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
size[Size]否缩略图尺寸

返回值：

类型说明
PromisePromise返回缩略图的PixelMap

示例：

async function example() {
    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(size)
    .then((pixelmap) = > {
        console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap);
    })
    .catch((err) = > {
        console.info('mediaLibraryTest : getThumbnail fail'+ err);
    });
}

favorite8+

favorite(isFavorite: boolean, callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
isFavoriteboolean是是否设置为收藏文件， true：设置为收藏文件，false：取消收藏
callbackAsyncCallback是回调返回空

示例：

async function example() {
    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
    });
}

favorite8+

favorite(isFavorite: boolean): Promise

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
isFavoriteboolean是是否设置为收藏文件， true：设置为收藏文件，false：取消收藏

返回值：

类型说明
PromisePromise返回空

示例：

async function example() {
    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);
    });
}

isFavorite8+

isFavorite(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调表示是否为收藏文件

示例：

async function example() {
    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');
        }
    });
}

isFavorite8+

isFavorite():Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值：

类型说明
PromisePromise回调表示是否是收藏文件

示例：

async function example() {
    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);
    });
}

trash8+

trash(isTrash: boolean, callback: AsyncCallback): void

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

放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
isTrashboolean是是否设置为垃圾文件
callbackAsyncCallback是回调返回空

示例：

async function example() {
    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');
    }
}

trash8+

trash(isTrash: boolean): Promise

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

放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
isTrashboolean是是否设置为垃圾文件

返回值：

类型说明
PromisePromise返回空

示例：

async function example() {
    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);
    });
}

isTrash8+

isTrash(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调返回表示文件是否为垃圾文件

示例：

async function example() {
    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);
                asset.trash(true, trashCallBack);

            } else {
                console.info('mediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err);
                console.info('mediaLibraryTest : ASSET_CALLBACK isTrash : FAIL');

            }
    }
}

isTrash8+

isTrash():Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值：

类型说明
PromisePromise回调表示文件是否为垃圾文件

示例：

async function example() {
    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);
    });
}

FetchFileResult7+

文件检索结果集。

getCount7+

getCount(): number

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值 ：

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

示例 ：

async function example() {
    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();
}

isAfterLast7+

isAfterLast(): boolean

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值 ：

类型说明
boolean当读到最后一条记录后，后续没有记录返回true，否则返回false。

示例 ：

async function example() {
    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();

            }
    }
}

close7+

close(): void

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

示例 ：

async function example() {
    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();
}

getFirstObject7+

getFirstObject(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
callbackAsyncCallback<[FileAsset]>是异步获取结果集中第一个FileAsset完成后的回调

示例 ：

async function example() {
    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((err, value) = > {
       if (err) {
           console.error('Failed ');
           return;
       }
       console.log(value);
    })
}

getFirstObject7+

getFirstObject(): Promise

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值 ：

类型说明
Promise<[FileAsset]>Promise方式返回FileAsset。

示例 ：

async function example() {
    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);
    });
}

getNextObject7+

getNextObject(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
callbackeAsyncCallback<[FileAsset]>是异步返回结果集中下一个FileAsset之后的回调

示例 ：

async function example() {
    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.getNextObject((err, value) = > {
       if (err) {
           console.error('Failed ');
           return;
       }
       console.log(value);
    })
}

getNextObject7+

getNextObject(): Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值 ：

类型说明
Promise<[FileAsset]>返回FileAsset对象

示例 ：

async function example() {
    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);
    fileAsset = await fetchFileResult.getNextObject();
}

getLastObject7+

getLastObject(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
callbackAsyncCallback<[FileAsset]>是异步返回FileAsset之后的回调

示例 ：

async function example() {
    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.getLastObject((err, value) = > {
       if (err) {
           console.error('Failed ');
           return;
       }
       console.log(value);
    })
}

getLastObject7+

getLastObject(): Promise

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值 ：

类型说明
Promise<[FileAsset]>返回FileAsset对象

示例 ：

async function example() {
    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();
}

getPositionObject7+

getPositionObject(index: number, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
indexnumber是要获取的文件的索引，从0开始
callbackAsyncCallback<[FileAsset]>是异步返回FileAsset之后的回调

示例 ：

async function example() {
    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.getPositionObject(0, (err, value) = > {
       if (err) {
           console.error('Failed ');
           return;
       }
       console.log(value);
    })
}

getPositionObject7+

getPositionObject(index: number): Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
indexnumber是要获取的文件的索引，从0开始

返回值 ：

类型说明
Promise<[FileAsset]>返回FileAsset对象

示例 ：

async function example() {
    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.getPositionObject(1, (err, value) = > {
       if (err) {
           console.error('Failed ');
           return;
       }
       console.log(value);
    })
}

getAllObject7+

getAllObject(callback: AsyncCallback>): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
callbackAsyncCallback>是异步返回FileAsset列表之后的回调

示例 ：

async function example() {
    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.getAllObject((err, value) = > {
       if (err) {
           console.error('Failed ');
           return;
       }
       console.log(value);
    })
}

getAllObject7+

getAllObject(): Promise>

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

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值 ：

类型说明
Promise>返回FileAsset对象列表

示例 ：

async function example() {
    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();
}

Album7+

实体相册

属性

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称类型可读可写说明
albumIdnumber是否相册编号
albumNamestring是是相册名称
albumUri8+string是否相册Uri
dateModifiednumber是否修改日期
count8+number是否相册中文件数量
relativePath8+string是否相对路径
coverUri8+string是否封面文件Uri

commitModify8+

commitModify(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
callbackAsyncCallback是回调返回空

示例 ：

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.');
    })
}

commitModify8+

commitModify(): Promise

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

需要权限 ：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

返回值 ：

类型说明
PromisePromise调用返回空

示例 ：

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);
    });
}

getFileAssets7+

getFileAssets(options: MediaFetchOptions, callback: AsyncCallback): void

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
options[MediaFetchOptions]是媒体检索选项。
callbackAsyncCallback<[FetchFileResult]>是异步返回FetchFileResult之后的回调。

示例 ：

async function example() {
    let AlbumNoArgsfetchOp = {
        selections: '',
        selectionArgs: [],
    };
    const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
    const album = albumList[0];
    album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack);
    function getFileAssetsCallBack(err, fetchFileResult) {
        // do something
    }
}

getFileAssets7+

getFileAssets(options?: MediaFetchOptions): Promise

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

需要权限 ：ohos.permission.READ_MEDIA

系统能力 ：SystemCapability.Multimedia.MediaLibrary.Core

参数 ：

参数名类型必填说明
options[MediaFetchOptions]否媒体检索选项。

返回值 ：

类型说明
Promise<[FetchFileResult]>返回FetchFileResult对象。

示例 ：

async function example() {
    let AlbumNoArgsfetchOp = {
        selections: '',
        selectionArgs: [],
    };
    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);
    });
}

PeerInfo8+

注册设备的信息。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称类型可读可写说明
deviceNamestring是否注册设备的名称
networkIdstring是否注册设备的网络ID
deviceType[DeviceType]是否设备类型
isOnlineboolean是否是否在线

MediaType8+

枚举，媒体类型。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称默认值说明
FILE1文件
IMAGE3图片
VIDEO4视频
AUDIO5音频

FileKey8+

枚举，文件关键信息。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称默认值说明
IDfile_id文件编号
RELATIVE_PATHrelative_path相对公共目录路径
DISPLAY_NAMEdisplay_name显示名字
PARENTparent父目录id
MIME_TYPEmime_type文件扩展属性
MEDIA_TYPEmedia_type媒体类型
SIZEsize文件大小（单位：字节）
DATE_ADDEDdate_added添加日期（添加文件时间到1970年1月1日的秒数值）
DATE_MODIFIEDdate_modified修改日期（修改文件时间到1970年1月1日的秒数值）
DATE_TAKENdate_taken拍摄日期（文件拍照时间到1970年1月1日的秒数值）
TITLEtitle文件标题
ARTISTartist作者
AUDIOALBUMaudio_album专辑
DURATIONduration持续时间（单位：秒）
WIDTHwidth图片宽度（单位：像素）
HEIGHTheight图片高度（单位：像素）
ORIENTATIONorientation图片显示方向，即顺时针旋转角度，如0，90，180。（单位：度）
ALBUM_IDbucket_id文件所归属的相册编号
ALBUM_NAMEbucket_display_name文件所归属相册名称

DirectoryType8+

枚举，目录类型。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称默认值说明
DIR_CAMERA0表示Camera文件路径
DIR_VIDEO1表示视频路径
DIR_IMAGE2表示图片路径
DIR_AUDIO3表示音频路径
DIR_DOCUMENTS4表示文档路径
DIR_DOWNLOAD5表示下载路径

DeviceType8+

枚举，设备类型。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称默认值说明
TYPE_UNKNOWN0未识别设备
TYPE_LAPTOP1笔记本电脑
TYPE_PHONE2手机
TYPE_TABLET3平板电脑
TYPE_WATCH4智能手表
TYPE_CAR5车载设备
TYPE_TV6电视设备

MediaFetchOptions7+

检索条件。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称类型可读可写必填说明
selectionsstring是是是检索条件，使用[FileKey]中的枚举值作为检索条件的列名。示例： selections: mediaLiary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLiary.FileKey.MEDIA_TYPE + '= ?‘,
selectionArgsArray是是是检索条件的值，对应selections中检索条件列的值。 示例： selectionArgs: [mediaLiary.MediaType.IMAGE.toString(), mediaLiary.MediaType.VIDEO.toString()],
orderstring是是否检索结果排序方式，使用[FileKey]中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例： 升序排列：order: mediaLiary.FileKey.DATE_ADDED + " AESC" 降序排列：order: mediaLiary.FileKey.DATE_ADDED + " DESC"
uri8+string是是否文件URI
networkId8+string是是否注册设备网络ID
extendArgs8+string是是否扩展的检索参数，目前没有扩展检索参数

Size8+

图片尺寸。

名称类型可读可写说明
widthnumber是是宽（单位：像素）
heightnumber是是高（单位：像素）

MediaAssetOption(deprecated)

媒体资源选项。

说明 ： 从API Version 9开始废弃。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

名称类型必填描述
srcstring是本地文件应用沙箱路径。
mimeTypestring是媒体MIME（Multipurpose Internet Mail Extensions）类型。 包括：'image/ '、'video/ '、'audio/ '、 'file '。
relativePathstring否自定义媒体资源保存位置，例：Pictures/ 不填则保存到默认路径。 image类型默认路径Pictures/ video类型默认路径Videos/ audio类型默认路径Audios/ file类型默认路径Documents/ 。

MediaSelectOption(deprecated)

媒体资源类型选项。

说明 ： 从API Version 9开始废弃。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core

接口

名称类型必填描述HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿
typestring是媒体类型，包括：image, video, media，当前仅支持media类型
countnumber是媒体选择，count = 1表示单选，count大于1表示多选。

审核编辑 黄宇

打开APP阅读更多精彩内容
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

下载APP
|投诉反馈|电子发烧友网
© 2021 elecfans.com
湘ICP备2023018690号
×
20
完善资料，
赚取积分