1.2K Star 6.3K Fork 5.3K

OpenHarmony / docs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
changelogs-medialibrary.md 6.42 KB
一键复制 编辑 原始数据 按行查看 历史
Annie_wang 提交于 2023-08-17 16:04 . update docs

File Subsystem Changelog

cl.file.1 Change of the mediaLibrary Interface Compatibility

Changed the compatibility of some mediaLibrary APIs.

Change Impact

The compatibility of some mediaLibrary APIs is changed. For applications developed based on earlier versions, pay attention to the iterative update of deprecated APIs.

Key API/Component Changes

Module Method/Attribute/Enum/Constant Change Type
medialibrary function getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void Interface compatibility changed
medialibrary function getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult> Interface compatibility changed
medialibrary function createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void Interface compatibility changed
medialibrary function createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise<FileAsset> Interface compatibility changed
medialibrary function getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array<Album>>): void Interface compatibility changed
medialibrary function getAlbums(options: MediaFetchOptions): Promise<Array<Album>> Interface compatibility changed
medialibrary function FileAsset.commitModify(callback: AsyncCallback<void>): void Interface compatibility changed
medialibrary function FileAsset.commitModify(): Promise<void> Interface compatibility changed

Adaptation Guide

getFileAssets

From API version 10, the albums represented by physical directories are replaced by logical albums, which allow multiple files in an album and presence of a file in multiple albums. This design, however, makes parent, albumId, albumUri, and albumName incompatible. They cannot be used as parameters of MediaFetchOptions in getFileAssets(). The following is an example of incorrect use of the APIs.

  1. Call getMediaLibrary to obtain a MediaLibrary instance.
  2. Create the file fetching options.
  3. Call getFileAssets to obtain file assets.

Example (incorrect):

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

async function example() {
  try {
    let context = getContext(this);
    let media = mediaLibrary.getMediaLibrary(context);
    let fileKeyObj = mediaLibrary.FileKey;
    let albumId = 1;
    let getImageOp = {
      selections: fileKeyObj.ALBUM_ID + '= ?', // File assets cannot be obtained based on the parent, albumId, albumUri, and albumName attributes.
      selectionArgs: [albumId.toString()],
    };
    const fetchFileResult = await media.getFileAssets(getImageOp); // The obtained fetchFileResult is empty.
    const fileAsset = await fetchFileResult.getFirstObject();
    console.info('mediaLibrary fileAsset displayName: ' + fileAsset.displayName);
  } catch (err) {
    console.error('mediaLibrary fail, err: ' + err);
  }
}

Use getFileAssets() as follows:

Example (correct):

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

async function example() {
  try {
    let context = getContext(this);
    let media = mediaLibrary.getMediaLibrary(context);
    let fileKeyObj = mediaLibrary.FileKey;
    let imageType = mediaLibrary.MediaType.IMAGE;
    let getImageOp = {
      selections: fileKeyObj.MEDIA_TYPE + '= ?',
      selectionArgs: [imageType.toString()], // Query all files of the image type.
    };
    const fetchFileResult = await media.getFileAssets(getImageOp); 
    const fileAsset = await fetchFileResult.getFirstObject();
    console.info('mediaLibrary fileAsset displayName: ' + fileAsset.displayName);
  } catch (err) {
    console.error('mediaLibrary fail, err: ' + err);
  }
}

createAsset

Since the SDK of API version 10, relativePath is no longer associated with an album. After a file is created, the last-level directory of relativePath is not displayed as an album.

getAlbums

Since the SDK of API version 10, relativePath is no longer associated with an album. Therefore, relativePath cannot be used as a search criterion in getAlbums, and the values of ALBUM_NAME can be Camera and Screenshots only. The following is an example of incorrect use of the APIs.

  1. Call getMediaLibrary to obtain a MediaLibrary instance.
  2. Create the album fetching options.
  3. Call getAlbums to obtain albums.

Example (incorrect):

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

async function example() {
  try {
    let context = getContext(this);
    let media = mediaLibrary.getMediaLibrary(context);
    let AlbumNoArgsfetchOp = {
      selections: mediaLibrary.FileKey.ALBUM_NAME + ' = ?',
      selectionArgs:['New album 1'], //Obtain the album named New album 1.
    };
    const albumList = await media.getAlbums(AlbumNoArgsfetchOp); // The fetchFileResult returned is empty.
    for (let i = 0; i < albumList.length; i++) {
      console.info('mediaLibrary album albumName: ' + albumList[i].albumName);
    }
  } catch (err) {
    console.error('mediaLibrary fail, err: ' + err);
  }
}

The following example shows how to obtain Camera and Screenshots albums:

Example (correct):

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

async function example() {
  try {
    let context = getContext(this);
    let media = mediaLibrary.getMediaLibrary(context);
    let AlbumNoArgsfetchOp = {
      selections: mediaLibrary.FileKey.ALBUM_NAME + ' = ? OR ' + mediaLibrary.FileKey.ALBUM_NAME + ' = ?',
      selectionArgs: ['Camera', 'Screenshots'], // Obtain the camera and screenshot albums.
    };
    const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
    for (let i = 0; i < albumList.length; i++) {
      console.info('mediaLibrary album albumName: ' + albumList[i].albumName);
    }
  } catch (err) {
    console.error('mediaLibrary fail, err: ' + err);
  }
}

FileAsset.commitModify

The orientation attribute for audio is deleted from the SDK of API version 10. When commitModify is used, the orientation attribute of audio resources cannot be modified.

马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs
OpenHarmony-4.0-Beta2

搜索帮助

344bd9b3 5694891 D2dac590 5694891