@ohos.multimedia.medialibrary (Media Library Management)

NOTE

• The APIs of this module are supported since API version 6. Updates will be marked with a superscript to indicate their earliest API version.
• This API is deprecated since API version 9 and will be retained until API version 13.
• Certain functionalities are changed as system APIs and can be used only by system applications. To use these functionalities, call @ohos.filemanagement.userFileManager.
• The functionalities for selecting and storing media assets are still open to common applications. To use these functionalities, call @ohos.file.picker.

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.

This API can be used only in the stage model.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example (from API version 9)

// Obtain a MediaLibrary instance. The instance obtained here is used in later.
const context = getContext(this);
let media = mediaLibrary.getMediaLibrary(context);

Example (API version 8)

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

let context = featureAbility.getContext();
let 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.

This API can be used only in the FA model.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

let 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

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    // Create options for fetching the files. The options are used to obtain files of the image type.
    let imagesFetchOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
    };
    // Obtain the files in asynchronous callback mode.
    media.getFileAssets(imagesFetchOp, async (error, fetchFileResult) => {
        // Check whether the result set of the obtained files is undefined. If yes, the API call fails.
        if (fetchFileResult == undefined) {
            console.error('get fetchFileResult failed with error: ' + error);
            return;
        }
        // Obtain the total number of files in the result set.
        const count = fetchFileResult.getCount();
        // Check whether the number is less than 0. If yes, the API call fails.
        if (count < 0) {
            console.error('get count from fetchFileResult failed, count: ' + count);
            return;
        }
        // Check whether the number is 0. If yes, the API call is successful, but the result set is empty. Check whether the options for fetching the files are correctly set and whether the corresponding files exist on the device.
        if (count == 0) {
            console.info('The count of fetchFileResult is zero');
            return;
        }
        console.info('Get fetchFileResult successfully, count: ' + count);
        // Obtain the first file in the result set in asynchronous callback mode. If there are a large number of files, use getAllObject instead.
        fetchFileResult.getFirstObject(async (error, fileAsset) => {
            // Check whether the first file is undefined. If yes, the API call fails.
            if (fileAsset == undefined) {
                console.error('get first object failed with error: ' + error);
                return;
            }
            console.info('fileAsset.displayName ' + '0 : ' + fileAsset.displayName);
            // Call getNextObject to obtain the next file until the last one.
            for (let i = 1; i < count; i++) {
                let fileAsset = await fetchFileResult.getNextObject();
                console.info('fileAsset.displayName ' + i + ': ' + fileAsset.displayName);
            }
            // Release the FetchFileResult instance and invalidate it. Other APIs can no longer be called.
            fetchFileResult.close();
        });
    });
}

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

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    // Create options for fetching the files. The options are used to obtain files of the image type.
    let imagesFetchOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
    };
    // Obtain the files in promise mode.
    media.getFileAssets(imagesFetchOp).then(async (fetchFileResult) => {
        // Obtain the total number of files in the result set.
        const count = fetchFileResult.getCount();
        // Check whether the number is less than 0. If yes, the API call fails.
        if (count < 0) {
            console.error('get count from fetchFileResult failed, count: ' + count);
            return;
        }
        // Check whether the number is 0. If yes, the API call is successful, but the result set is empty. Check whether the options for fetching the files are correctly set and whether the corresponding files exist on the device.
        if (count == 0) {
            console.info('The count of fetchFileResult is zero');
            return;
        }
        console.info('Get fetchFileResult successfully, count: ' + count);
        // Obtain the first file in the result set in promise mode. If there are a large number of files, use getAllObject instead.
        fetchFileResult.getFirstObject().then(async (fileAsset) => {
            console.info('fileAsset.displayName ' + '0 : ' + fileAsset.displayName);
            // Call getNextObject to obtain the next file until the last one.
            for (let i = 1; i < count; i++) {
                let fileAsset = await fetchFileResult.getNextObject();
                console.info('fileAsset.displayName ' + i + ': ' + fileAsset.displayName);
            }
            // Release the FetchFileResult instance and invalidate it. Other APIs can no longer be called.
            fetchFileResult.close();
        }).catch((error) => {
            // Calling getFirstObject fails.
            console.error('get first object failed with error: ' + error);
        });
    }).catch((error) => {
        // Calling getFileAssets fails.
        console.error('get file assets failed with error: ' + error);
    });
}

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

media.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

media.off('imageChange', () => {
    // Stop listening successfully.
})

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);
    media.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (error, fileAsset) => {
        if (fileAsset != undefined) {
            console.info('createAsset successfully, message');
        } else {
            console.error('createAsset failed with error: ' + error);
        }
    });
}

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);
    media.createAsset(mediaType, 'imagePromise.jpg', path + 'myPicture/').then((fileAsset) => {
        console.info('createAsset successfully, message = ' + JSON.stringify(fileAsset));
    }).catch((error) => {
        console.error('createAsset failed with error: ' + error);
    });
}

deleteAsset⁸⁺

deleteAsset(uri: string): Promise<void>

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

System API: This is a system API.

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 fileKeyObj = mediaLibrary.FileKey;
    let fileType = mediaLibrary.MediaType.FILE;
    let option = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [fileType.toString()],
    };
    const fetchFileResult = await media.getFileAssets(option);
    let asset = await fetchFileResult.getFirstObject();
    if (asset == undefined) {
        console.error('asset not exist');
        return;
    }
    media.deleteAsset(asset.uri).then(() => {
        console.info('deleteAsset successfully');
    }).catch((error) => {
        console.error('deleteAsset failed with error: ' + error);
    });
    fetchFileResult.close();
}

deleteAsset⁸⁺

deleteAsset(uri: string, callback: AsyncCallback<void>): void

Deletes a file asset. This API uses an asynchronous callback to return the result.

System API: This is a system API.

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let fileType = mediaLibrary.MediaType.FILE;
    let option = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [fileType.toString()],
    };
    const fetchFileResult = await media.getFileAssets(option);
    let asset = await fetchFileResult.getFirstObject();
    if (asset == undefined) {
        console.error('asset not exist');
        return;
    }
    media.deleteAsset(asset.uri, (error) => {
        if (error != undefined) {
            console.error('deleteAsset failed with error: ' + error);
        } else {
            console.info('deleteAsset successfully');
        }
    });
    fetchFileResult.close();
}

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, (error, dicResult) => {
    if (dicResult == 'Camera/') {
        console.info('getPublicDirectory DIR_CAMERA successfully');
    } else {
        console.error('getPublicDirectory DIR_CAMERA failed with error: ' + error);
    }
});

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;
    media.getPublicDirectory(DIR_CAMERA).then((dicResult) => {
        if (dicResult == 'Camera/') {
            console.info('getPublicDirectory DIR_CAMERA successfully');
        } else {
            console.error('getPublicDirectory DIR_CAMERA failed');
        }
    }).catch((error) => {
        console.error('getPublicDirectory failed with error: ' + error);
    });
}

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

async function example() {
   // To obtain the file assets in an album, you must preset the album and resources. The sample code below presets 'New Album 1'.
  let AlbumNoArgsfetchOp = {
    selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
    selectionArgs:['New Album 1'],
  };
  media.getAlbums(AlbumNoArgsfetchOp, (error, albumList) => {
    if (albumList != undefined) {
      console.info('getAlbums successfully: ' + JSON.stringify(albumList));
    } else {
      console.error('getAlbums failed with error: ' + error);
    }
  })
}

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

async function example() {
   // To obtain the file assets in an album, you must preset the album and resources. The sample code below presets 'New Album 1'.
  let AlbumNoArgsfetchOp = {
    selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
    selectionArgs:['New Album 1'],
  };
  media.getAlbums(AlbumNoArgsfetchOp).then((albumList) => {
    console.info('getAlbums successfully: ' + JSON.stringify(albumList));
  }).catch((error) => {
    console.error('getAlbums failed with error: ' + error);
  });
}

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

media.release(() => {
    // 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

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.

NOTE

This API is supported since API version 6 and can be used only by the FA model.

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, (error, value) => {
    if (error) {
        console.error('storeMediaAsset failed with error: ' + error);
        return;
    }
    console.info('Media resources 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.

NOTE

This API is supported since API version 6 and can be used only by the FA model.

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.info('Media resources stored.');
    // Obtain the URI that stores the media asset.
}).catch((error) => {
    console.error('storeMediaAsset failed with error: ' + error);
});

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 datashare:// or online images whose URIs start with https://. It uses an asynchronous callback to return the execution result.

NOTE This API is supported since API version 6 and can be used only by the FA model. You are advised to use the <Image> component instead. The <Image> component can be used to render and display local and online images.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

let images = [
    'datashare:///media/xxxx/2',
    'datashare:///media/xxxx/3'
];
/* Preview online images.
let images = [
    'https://media.xxxx.com/image1.jpg',
    'https://media.xxxx.com/image2.jpg'
];
*/
let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index, (error) => {
    if (error) {
        console.error('startImagePreview failed with error: ' + error);
        return;
    }
    console.info('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 datashare:// or online images whose URIs start with https://. It uses an asynchronous callback to return the execution result.

NOTE This API is supported since API version 6 and can be used only by the FA model. You are advised to use the <Image> component instead. The <Image> component can be used to render and display local and online images.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

let images = [
    'datashare:///media/xxxx/2',
    'datashare:///media/xxxx/3'
];
/* Preview online images.
let images = [
    'https://media.xxxx.com/image1.jpg',
    'https://media.xxxx.com/image2.jpg'
];
*/
mediaLibrary.getMediaLibrary().startImagePreview(images, (error) => {
    if (error) {
        console.error('startImagePreview failed with error: ' + error);
        return;
    }
    console.info('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 datashare:// or online images whose URIs start with https://. It uses a promise to return the execution result.

NOTE This API is supported since API version 6 and can be used only by the FA model. You are advised to use the <Image> component instead. The <Image> component can be used to render and display local and online images.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

let images = [
    'datashare:///media/xxxx/2',
    'datashare:///media/xxxx/3'
];
/* Preview online images.
let images = [
    'https://media.xxxx.com/image1.jpg',
    'https://media.xxxx.com/image2.jpg'
];
*/
let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => {
    console.info('Succeeded in previewing the images.');
}).catch((error) => {
    console.error('startImagePreview failed with error: ' + error);
});

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.

NOTE This API is supported since API version 6 and can be used only by the FA model. You are advised to use the system app Gallery instead. Gallery is a built-in visual resource access application that provides features such as image and video management and browsing. For details about how to use Gallery, visit OpenHarmony/applications_photos.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

let option : mediaLibrary.MediaSelectOption = {
    type : 'media',
    count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option, (error, value) => {
    if (error) {
        console.error('startMediaSelect failed with error: ' + error);
        return;
    }
    console.info('Media resources 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.

NOTE This API is supported since API version 6 and can be used only by the FA model. You are advised to use the system app Gallery instead. Gallery is a built-in visual resource access application that provides features such as image and video management and browsing. For details about how to use Gallery, visit OpenHarmony/applications_photos.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

let option : mediaLibrary.MediaSelectOption = {
    type : 'media',
    count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
    console.info('Media resources selected.');
    // Obtain the media selection value.
}).catch((error) => {
    console.error('startMediaSelect failed with error: ' + error);
});

getActivePeers⁸⁺

getActivePeers(): Promise<Array<PeerInfo>>;

Obtains information about online peer devices. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.DistributedCore

Return value

Example

async function example() {
    media.getActivePeers().then((devicesInfo) => {
        if (devicesInfo != undefined) {
            console.info('get distributed info ' + JSON.stringify(devicesInfo));
        } else {
            console.info('get distributed info is undefined!');
        }
    }).catch((error) => {
        console.error('get distributed info failed with error: ' + error);
    });
}

getActivePeers⁸⁺

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

Obtains information about online peer devices. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.DistributedCore

Return value

Example

async function example() {
    media.getActivePeers((error, devicesInfo) => {
        if (devicesInfo != undefined) {
            console.info('get distributed info ' + JSON.stringify(devicesInfo));
        } else {
            console.error('get distributed failed with error: ' + error);
        }
    });
}

getAllPeers⁸⁺

getAllPeers(): Promise<Array<PeerInfo>>;

Obtains information about all peer devices. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.DistributedCore

Return value

Example

async function example() {
    media.getAllPeers().then((devicesInfo) => {
        if (devicesInfo != undefined) {
            console.info('get distributed info ' + JSON.stringify(devicesInfo));
        } else {
            console.info('get distributed info is undefined!');
        }
    }).catch((error) => {
        console.error('get distributed info failed with error: ' + error);
    });
}

getAllPeers⁸⁺

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

Obtains information about online peer devices. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.READ_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.DistributedCore

Return value

Example

async function example() {
    media.getAllPeers((error, devicesInfo) => {
        if (devicesInfo != undefined) {
            console.info('get distributed info ' + JSON.stringify(devicesInfo));
        } else {
            console.error('get distributed failed with error: ' + error);
        }
    });
}

FileAsset⁷⁺

Provides APIs for encapsulating file asset attributes.

NOTE

1. The system attempts to parse the file content if the file is an audio or video file. The actual field values will be restored from the passed values during scanning on some devices.
2. Some devices may not support the modification of orientation. You are advised to use ModifyImageProperty of the image module.

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isDirectory((error, isDirectory) => {
        if (error) {
            console.error('isDirectory failed with error: ' + error);
        } else {
            console.info('isDirectory result:' + isDirectory);
        }
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isDirectory().then((isDirectory) => {
        console.info('isDirectory result:' + isDirectory);
    }).catch((error) => {
        console.error('isDirectory failed with error: ' + error);
    });
    fetchFileResult.close();
}

commitModify⁸⁺

commitModify(callback: AsyncCallback<void>): void

Commits the modification in 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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.title = 'newtitle';
    asset.commitModify(() => {
        console.info('commitModify successfully');   
    });
    fetchFileResult.close();
}

commitModify⁸⁺

commitModify(): Promise<void>

Commits the modification in 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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.title = 'newtitle';
    await asset.commitModify();
    fetchFileResult.close();
}

open⁸⁺

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

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

NOTE: When a file is opened in 'w' mode, the returned FD cannot be read. However, due to the implementation differences of file systems, some user-mode files opened in 'w' mode can be read by using FD. To perform the read or write operation on a file by using FD, you are advised to open the file in 'rw' mode. The write operations are mutually exclusive. After a write operation is complete, you must call close to release the resource.

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

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);
    const asset = await media.createAsset(mediaType, 'image00003.jpg', path);
    asset.open('rw', (error, fd) => {
        if (fd > 0) {
            asset.close(fd);
        } else {
            console.error('File Open failed with error: ' + error);
        }
    });
}

open⁸⁺

open(mode: string): Promise<number>

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

NOTE: When a file is opened in 'w' mode, the returned FD cannot be read. However, due to the implementation differences of file systems, some user-mode files opened in 'w' mode can be read by using FD. To perform the read or write operation on a file by using FD, you are advised to open the file in 'rw' mode. The write operations are mutually exclusive. After a write operation is complete, you must call close to release the resource.

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

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);
    const asset = await media.createAsset(mediaType, 'image00003.jpg', path);
    asset.open('rw').then((fd) => {
        console.info('File open fd: ' + fd);
    }).catch((error) => {
        console.error('File open failed with error: ' + error);
    });
}

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 or ohos.permission.WRITE_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.open('rw').then((fd) => {
        console.info('File open fd: ' + fd);
        asset.close(fd, (error) => {
            if (error) {
                console.error('asset.close failed with error: ' + error);
            } else {
                console.info('asset.close successfully');
            }
        });
    }).catch((error) => {
        console.error('File open failed with error: ' + error);
    });
    fetchFileResult.close();
}

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 or ohos.permission.WRITE_MEDIA

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.open('rw').then((fd) => {
        console.info('File fd!' + fd);
        asset.close(fd).then(() => {
            console.info('asset.close successfully');
        }).catch((closeErr) => {
            console.error('asset.close fail, closeErr: ' + closeErr);
        });
    }).catch((error) => {
        console.error('open File failed with error: ' + error);
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.getThumbnail((error, pixelmap) => {
        if (error) {
            console.error('mediaLibrary getThumbnail failed with error: ' + error);
        } else {
            console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap));
        }
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let size = { width: 720, height: 720 };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.getThumbnail(size, (error, pixelmap) => {
        if (error) {
            console.error('mediaLibrary getThumbnail failed with error: ' + error);
        } else {
            console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap));
        }
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let size = { width: 720, height: 720 };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.getThumbnail(size).then((pixelmap) => {
        console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap));
    }).catch((error) => {
        console.error('mediaLibrary getThumbnail failed with error: ' + error);
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.favorite(true,(error) => {
        if (error) {
            console.error('mediaLibrary favorite failed with error: ' + error);
        } else {
            console.info('mediaLibrary favorite Successful');
        }
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.favorite(true).then(() => {
        console.info('mediaLibrary favorite Successful');
    }).catch((error) => {
        console.error('mediaLibrary favorite failed with error: ' + error);
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isFavorite((error, isFavorite) => {
        if (error) {
            console.error('mediaLibrary favoriisFavoritete failed with error: ' + error);
        } else {
            console.info('mediaLibrary isFavorite Successful, isFavorite result: ' + isFavorite);
        }
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isFavorite().then((isFavorite) => {
        console.info('mediaLibrary isFavorite Successful, isFavorite result: ' + isFavorite);
    }).catch((error) => {
        console.error('mediaLibrary favoriisFavoritete failed with error: ' + error);
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.trash(true, (error) => {
        if (error) {
            console.error('mediaLibrary trash failed with error: ' + error);
        } else {
            console.info('mediaLibrary trash Successful');
        }
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.trash(true).then(() => {
        console.info('trash successfully');
    }).catch((error) => {
        console.error('trash failed with error: ' + error);
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isTrash((error, isTrash) => {
        if (error) {
            console.error('Failed to get trash state failed with error: ' + error);
            return;
        }
        console.info('Get trash state successfully, isTrash result: ' + isTrash);
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    const fetchFileResult = await media.getFileAssets(getImageOp);
    const asset = await fetchFileResult.getFirstObject();
    asset.isTrash().then((isTrash) => {
        console.info('isTrash result: ' + isTrash);
    }).catch((error) => {
        console.error('isTrash failed with error: ' + error);
    });
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let fileType = mediaLibrary.MediaType.FILE;
    let getFileCountOneOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [fileType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getFileCountOneOp);
    const fetchCount = fetchFileResult.getCount();
    console.info('fetchCount result: ' + fetchCount);
    fetchFileResult.close();
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    const fetchCount = fetchFileResult.getCount();
    console.info('mediaLibrary fetchFileResult.getCount, count:' + fetchCount);
    let fileAsset = await fetchFileResult.getFirstObject();
    for (var i = 1; i < fetchCount; i++) {
        fileAsset = await fetchFileResult.getNextObject();
        if(i == fetchCount - 1) {
            var result = fetchFileResult.isAfterLast();
            console.info('mediaLibrary fileAsset isAfterLast result: ' + result);
            fetchFileResult.close();
        }
    }
}

close⁷⁺

close(): void

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

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getFirstObject((error, fileAsset) => {
        if (error) {
            console.error('fetchFileResult getFirstObject failed with error: ' + error);
            return;
        }
        console.info('getFirstObject successfully, displayName : ' + fileAsset.displayName);
        fetchFileResult.close();
    })
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getFirstObject().then((fileAsset) => {
        console.info('getFirstObject successfully, displayName: ' + fileAsset.displayName);
        fetchFileResult.close();
    }).catch((error) => {
        console.error('getFirstObject failed with error: ' + error);
    });
}

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.

NOTE

Before using this API, you must use getFirstObject to obtain the first file asset and then use isAfterLast to ensure that the cursor does not point to the last file asset in the result set.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    let fileAsset = await fetchFileResult.getFirstObject();
    console.log('fetchFileResult getFirstObject successfully, displayName: ' + fileAsset.displayName);
    if (!fetchFileResult.isAfterLast()) {
        fetchFileResult.getNextObject((error, fileAsset) => {
            if (error) {
                console.error('fetchFileResult getNextObject failed with error: ' + error);
                return;
            }
            console.log('fetchFileResult getNextObject successfully, displayName: ' + fileAsset.displayName);
            fetchFileResult.close();
        })
    }
}

getNextObject⁷⁺

getNextObject(): Promise<FileAsset>

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

NOTE

Before using this API, you must use getFirstObject to obtain the first file asset and then use isAfterLast to ensure that the cursor does not point to the last file asset in the result set.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Return value

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    let fileAsset = await fetchFileResult.getFirstObject();
    console.log('fetchFileResult getFirstObject successfully, displayName: ' + fileAsset.displayName);
    if (!fetchFileResult.isAfterLast()) {
        fetchFileResult.getNextObject().then((fileAsset) => {
            console.info('fetchFileResult getNextObject successfully, displayName: ' + fileAsset.displayName);
            fetchFileResult.close();
        }).catch((error) => {
            console.error('fetchFileResult getNextObject failed with error: ' + error);
        })
    }
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getLastObject((error, fileAsset) => {
        if (error) {
            console.error('getLastObject failed with error: ' + error);
            return;
        }
        console.info('getLastObject successfully, displayName: ' + fileAsset.displayName);
        fetchFileResult.close();
    })
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getLastObject().then((fileAsset) => {
        console.info('getLastObject successfully, displayName: ' + fileAsset.displayName);
        fetchFileResult.close();
    }).catch((error) => {
        console.error('getLastObject failed with error: ' + error);
    });
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getPositionObject(0, (error, fileAsset) => {
        if (error) {
            console.error('getPositionObject failed with error: ' + error);
            return;
        }
        console.info('getPositionObject successfully, displayName: ' + fileAsset.displayName);
        fetchFileResult.close();
    })
}

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.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Return value

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getPositionObject(0).then((fileAsset) => {
        console.info('getPositionObject successfully, displayName: ' + fileAsset.displayName);
        fetchFileResult.close();
    }).catch((error) => {
        console.error('getPositionObject failed with error: ' + error);
    });
}

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.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Parameters

Example

async function example() {
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getAllObject((error, fileAssetList) => {
        if (error) {
           console.error('getAllObject failed with error: ' + error);
           return;
        }
        for (let i = 0; i < fetchFileResult.getCount(); i++) {
            console.info('getAllObject fileAssetList ' + i + ' displayName: ' + fileAssetList[i].displayName);
        }
        fetchFileResult.close();
    })
}

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 fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
        selections: fileKeyObj.MEDIA_TYPE + '= ?',
        selectionArgs: [imageType.toString()],
        order: fileKeyObj.DATE_ADDED + ' DESC',
    };
    let fetchFileResult = await media.getFileAssets(getImageOp);
    fetchFileResult.getAllObject().then((fileAssetList) => {
        for (let i = 0; i < fetchFileResult.getCount(); i++) {
            console.info('getAllObject fileAssetList ' + i + ' displayName: ' + fileAssetList[i].displayName);
        } 
        fetchFileResult.close();
    }).catch((error) => {
        console.error('getAllObject failed with error: ' + error);
    });
}

Album⁷⁺

Provides APIs to implement a physical album.

Attributes

System capability: SystemCapability.Multimedia.MediaLibrary.Core

commitModify⁸⁺

commitModify(callback: AsyncCallback<void>): void

Commits the modification in 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() {
  // To obtain the file assets in an album, you must preset the album and resources. The sample code below presets 'New Album 1'.
  let AlbumNoArgsfetchOp = {
    selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
    selectionArgs:['New Album 1'],
  };
  const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
  const album = albumList[0];
  album.albumName = 'hello';
  album.commitModify((error) => {
    if (error) {
      console.error('commitModify failed with error: ' + error);
      return;
    }
    console.info('commitModify successful.');
  })
}

commitModify⁸⁺

commitModify(): Promise<void>

Commits the modification in 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() {
  // To obtain the file assets in an album, you must preset the album and resources. The sample code below presets 'New Album 1'.
  let AlbumNoArgsfetchOp = {
    selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
    selectionArgs:['New Album 1'],
  };
  const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
  const album = albumList[0];
  album.albumName = 'hello';
  album.commitModify().then(() => {
    console.info('commitModify successfully');
  }).catch((error) => {
    console.error('commitModify failed with error: ' + error);
  });
}

getFileAssets⁷⁺

getFileAssets(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() {
  // To obtain the file assets in an album, you must preset the album and resources. The sample code below presets 'New Album 1'.
  let AlbumNoArgsfetchOp = {
    selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
    selectionArgs:['New Album 1'],
  };
  // Obtain the albums that meet the retrieval options and return the album list.
  const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
  const album = albumList[0];
  // Obtain an album from the album list and obtain all media assets that meet the retrieval options in the album.
  album.getFileAssets((error, fetchFileResult) => {
    if (error) {
      console.error('album getFileAssets failed with error: ' + error);
      return;
    }
    let count = fetchFileResult.getCount();
    console.info('album getFileAssets successfully, count: ' + count);
    fetchFileResult.close();
  });
}

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() {
  // To obtain the file assets in an album, you must preset the album and resources. The sample code below presets 'New Album 1'.
  let AlbumNoArgsfetchOp = {
    selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
    selectionArgs:['New Album 1'],
  };
  let fileNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
  }
  // Obtain the albums that meet the retrieval options and return the album list.
  const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
  const album = albumList[0];
  // Obtain an album from the album list and obtain all media assets that meet the retrieval options in the album.
  album.getFileAssets(fileNoArgsfetchOp, (error, fetchFileResult) => {
    if (error) {
      console.error('album getFileAssets failed with error: ' + error);
      return;
    }
    let count = fetchFileResult.getCount();
    console.info('album getFileAssets successfully, count: ' + count);
    fetchFileResult.close();
  });
}

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() {
  // To obtain the file assets in an album, you must preset the album and resources. The sample code below presets 'New Album 1'.
  let AlbumNoArgsfetchOp = {
    selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
    selectionArgs:['New Album 1'],
  };
  let fileNoArgsfetchOp = {
    selections: '',
    selectionArgs: [],
  };
  // Obtain the albums that meet the retrieval options and return the album list.
  const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
  const album = albumList[0];
  // Obtain an album from the album list and obtain all media assets that meet the retrieval options in the album.
  album.getFileAssets(fileNoArgsfetchOp).then((fetchFileResult) => {
    let count = fetchFileResult.getCount();
    console.info('album getFileAssets successfully, count: ' + count);
    fetchFileResult.close();
  }).catch((error) => {
    console.error('album getFileAssets failed with error: ' + error);
  });
}

PeerInfo⁸⁺

Describes information about a registered device.

System API: This is a system API.

System capability: SystemCapability.Multimedia.MediaLibrary.DistributedCore

MediaType⁸⁺

Enumerates media types.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

FileKey⁸⁺

Enumerates key file information.

NOTE The bucket_id field may change after file rename or movement. Therefore, you must obtain the field again before using it.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

DirectoryType⁸⁺

Enumerates directory types.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

DeviceType⁸⁺

Enumerates device types.

System API: This is a system API.

System capability: SystemCapability.Multimedia.MediaLibrary.DistributedCore

MediaFetchOptions⁷⁺

Describes options for fetching media files.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

Size⁸⁺

Describes the image size.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

MediaAssetOption

Implements the media asset option.

System capability: SystemCapability.Multimedia.MediaLibrary.Core

MediaSelectOption

Describes media selection option.

System capability: SystemCapability.Multimedia.MediaLibrary.Core