媒體庫管理

說明： 該組件從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

參數：

返回值：

示例：（從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

返回值：

示例：

var media = mediaLibrary.getMediaLibrary();

MediaLibrary

getFileAssets7+

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

獲取文件資源，使用callback方式返回異步結果。

需要權限 ：ohos.permission.READ_MEDIA

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

參數：

示例：

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

參數：

返回值

示例：

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

參數：

示例：

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

參數：

示例：

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

參數：

示例：

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

參數：

返回值

示例：

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

參數：

示例：

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

參數：

返回值：

示例：

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

參數

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

release8+

release(): Promise

釋放MediaLibrary實例。 當后續不需要使用MediaLibrary實例中的方法時調用。

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

返回值：

示例：

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

storeMediaAsset(deprecated)

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

保存媒體資源，以異步方法獲取保存成功的URI，使用callback形式返回結果。

說明 ： 從API Version 9開始廢棄。

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

參數：

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

參數：

示例：

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

啟動圖片預覽界面并限定預覽開始顯示的圖片?？梢灶A覽指定序號的單張本地圖片（dataability://），也可以預覽列表中的所有網絡圖片（https://）。使用Promise方式進行異步回調。

說明 ： 從API Version 9開始廢棄。

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

參數：

返回值：

示例：

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

參數：

示例：

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

參數：

返回值：

示例：

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

isDirectory8+

isDirectory(callback: AsyncCallback): void

判斷fileAsset是否為目錄，使用callback方式返回異步結果。

需要權限 ：ohos.permission.READ_MEDIA

系統能力 ：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: "",
    };
    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

返回值：

示例：

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

參數：

示例：

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

返回值：

示例：

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

參數

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

參數：

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

返回值：

示例：

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

參數：

示例：

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

參數：

返回值：

示例：

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

參數：

示例：

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

返回值：

示例：

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

返回值 ：

示例 ：

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

返回值 ：

示例 ：

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

參數 ：

示例 ：

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

返回值 ：

示例 ：

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

參數 ：

示例 ：

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

返回值 ：

示例 ：

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

參數 ：

示例 ：

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

返回值 ：

示例 ：

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

參數 ：

示例 ：

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

參數 ：

返回值 ：

示例 ：

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

參數 ：

示例 ：

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

返回值 ：

示例 ：

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

commitModify8+

commitModify(callback: AsyncCallback): void

更新相冊屬性修改到數據庫中。

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

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

參數 ：

示例 ：

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

返回值 ：

示例 ：

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

參數 ：

示例 ：

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

參數 ：

返回值 ：

示例 ：

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

MediaType8+

枚舉，媒體類型。

系統能力： 以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core

FileKey8+

枚舉，文件關鍵信息。

系統能力： 以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core

DirectoryType8+

枚舉，目錄類型。

系統能力： 以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core

DeviceType8+

枚舉，設備類型。

系統能力： 以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core

MediaFetchOptions7+

檢索條件。

系統能力： 以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core

Size8+

圖片尺寸。

MediaAssetOption(deprecated)

媒體資源選項。

說明 ： 從API Version 9開始廢棄。

系統能力： 以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core

MediaSelectOption(deprecated)

媒體資源類型選項。

說明 ： 從API Version 9開始廢棄。

系統能力： 以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core

審核編輯 黃宇