Media Library Management

NOTE This component is supported since API version 6. Updates will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

mediaLibrary.getMediaLibrary⁸⁺

getMediaLibrary(context: Context): MediaLibrary

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

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

mediaLibrary.getMediaLibrary

getMediaLibrary(): MediaLibrary

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

Note: This API is no longer maintained since API version 8. You are advised to use mediaLibrary.getMediaLibrary⁸⁺ instead.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

var media = mediaLibrary.getMediaLibrary();

MediaLibrary

getFileAssets⁷⁺

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

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getFileAssets⁷⁺

getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

on⁸⁺

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

off⁸⁺

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

createAsset ⁸⁺

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

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

async function example() {
    // Create an image file in callback mode.
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
    mediaLibrary.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (err, fileAsset) => {
        if (fileAsset != undefined) {
            console.info('createAsset successfully, message = ' + err);
        } else {
            console.info('createAsset failed, message = ' + err);
        }
    });
}

createAsset⁸⁺

createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise<FileAsset>

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

async function example() {
    // Create an image file in promise mode
    let mediaType = mediaLibrary.MediaType.IMAGE;
    let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
    const path = await media.getPublicDirectory(DIR_IMAGE);
    mediaLibrary.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);
    });
}

getPublicDirectory⁸⁺

getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getPublicDirectory⁸⁺

getPublicDirectory(type: DirectoryType): Promise<string>

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

getAlbums⁷⁺

getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array<Album>>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getAlbums⁷⁺

getAlbums(options: MediaFetchOptions): Promise<Array<Album>>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

release⁸⁺

release(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

release⁸⁺

release(): Promise<void>

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

storeMediaAsset

storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback<string>): void

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

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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 the media asset.");
      return;
  }
  console.log("Media asset stored. ");
  // Obtain the URI that stores the media asset.
});

storeMediaAsset

storeMediaAsset(option: MediaAssetOption): Promise<string>

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

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

startImagePreview

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

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

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

let images = [
  "dataability:///media/xxxx/2",
  "dataability:///media/xxxx/3"
];
/* Online image usage mode
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

startImagePreview(images: Array<string>, callback: AsyncCallback<void>): void

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

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

let images = [
  "dataability:///media/xxxx/2",
  "dataability:///media/xxxx/3"
];
/* Online image usage mode
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

startImagePreview(images: Array<string>, index?: number): Promise<void>

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

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

let images = [
  "dataability:///media/xxxx/2",
  "dataability:///media/xxxx/3"
];
/* Online image usage mode
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

startMediaSelect(option: MediaSelectOption, callback: AsyncCallback<Array<string>>): void

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

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

startMediaSelect

startMediaSelect(option: MediaSelectOption): Promise<Array<string>>

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

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

FileAsset⁷⁺

Provides APIs for encapsulating file asset attributes.

Attributes

System capability: SystemCapability.Multimedia.MediaLibrary.Core

isDirectory⁸⁺

isDirectory(callback: AsyncCallback<boolean>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

isDirectory⁸⁺

isDirectory():Promise<boolean>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

commitModify⁸⁺

commitModify(callback: AsyncCallback<void>): void

Commits the modification of this file asset to the database. This API uses an asynchronous callback to return the result.

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

commitModify⁸⁺

commitModify(): Promise<void>

Commits the modification of this file asset to the database. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

open⁸⁺

open(mode: string, callback: AsyncCallback<number>): void

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

Required permissions: ohos.permission.READ_MEDIA (when mode is set to r) and ohos.permission.WRITE_MEDIA (when mode is set to w)

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

open⁸⁺

open(mode: string): Promise<number>

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

Required permissions: ohos.permission.READ_MEDIA (when mode is set to r) and ohos.permission.WRITE_MEDIA (when mode is set to w)

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

close⁸⁺

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

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

Required permissions: ohos.permission.READ_MEDIA (when mode is set to r) and ohos.permission.WRITE_MEDIA (when mode is set to w)

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

close⁸⁺

close(fd: number): Promise<void>

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

Required permissions: ohos.permission.READ_MEDIA (when mode is set to r) and ohos.permission.WRITE_MEDIA (when mode is set to w)

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

getThumbnail⁸⁺

getThumbnail(callback: AsyncCallback<image.PixelMap>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getThumbnail⁸⁺

getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getThumbnail⁸⁺

getThumbnail(size?: Size): Promise<image.PixelMap>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

favorite⁸⁺

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

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

favorite⁸⁺

favorite(isFavorite: boolean): Promise<void>

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

isFavorite⁸⁺

isFavorite(callback: AsyncCallback<boolean>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

isFavorite⁸⁺

isFavorite():Promise<boolean>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

trash⁸⁺

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

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

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

trash⁸⁺

trash(isTrash: boolean): Promise<void>

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

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

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

isTrash⁸⁺

isTrash(callback: AsyncCallback<boolean>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

            }
    }
}

isTrash⁸⁺

isTrash():Promise<boolean>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

FetchFileResult⁷⁺

Implements the result set of the file retrieval operation.

getCount⁷⁺

getCount(): number

Obtains the total number of files in the result set.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

isAfterLast⁷⁺

isAfterLast(): boolean

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

            }
    }
}

close⁷⁺

close(): void

Releases and invalidates this FetchFileResult instance. Other APIs cannot be invoked after the instance is released.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Example

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

getFirstObject⁷⁺

getFirstObject(callback: AsyncCallback<FileAsset>): void

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getFirstObject⁷⁺

getFirstObject(): Promise<FileAsset>

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

getNextObject⁷⁺

getNextObject(callback: AsyncCallback<FileAsset>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getNextObject⁷⁺

getNextObject(): Promise<FileAsset>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

getLastObject⁷⁺

getLastObject(callback: AsyncCallback<FileAsset>): void

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getLastObject⁷⁺

getLastObject(): Promise<FileAsset>

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

getPositionObject⁷⁺

getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getPositionObject⁷⁺

getPositionObject(index: number): Promise<FileAsset>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

getAllObject⁷⁺

getAllObject(callback: AsyncCallback<Array<FileAsset>>): void

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getAllObject⁷⁺

getAllObject(): Promise<Array<FileAsset>>

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

Album⁷⁺

Provides APIs to implement a physical album.

Attributes

System capability: SystemCapability.Multimedia.MediaLibrary.Core

commitModify⁸⁺

commitModify(callback: AsyncCallback<void>): void

Commits the modification of the album attributes to the database. This API uses an asynchronous callback to return the result.

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

commitModify⁸⁺

commitModify(): Promise<void>

Commits the modification of the album attributes to the database. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

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

getFileAssets⁷⁺

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

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

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

getFileAssets⁷⁺

getFileAssets(options?: MediaFetchOptions): Promise<FetchFileResult>

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

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

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

PeerInfo⁸⁺

Describes information about a registered device.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

MediaType⁸⁺

Enumerates media types.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

FileKey⁸⁺

Enumerates key file information.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

DirectoryType⁸⁺

Enumerates directory types.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

DeviceType⁸⁺

Enumerates device types.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

MediaFetchOptions⁷⁺

Describes options for fetching media files.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Size⁸⁺

Describes the image size.

MediaAssetOption

Implements the media asset option.

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

MediaSelectOption

Describes media selection option.

This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.

System capability: SystemCapability.Multimedia.MediaLibrary.Core