harmony 鸿蒙使用AVMetadataExtractor提取音视频元数据信息(ArkTS)

2025-06-12
浏览 (8)

使用AVMetadataExtractor提取音视频元数据信息(ArkTS)

使用AVMetadataExtractor可以实现从原始媒体资源中获取元数据，本开发指导将以获取一个音频资源的元数据作为示例，向开发者讲解AVMetadataExtractor元数据相关功能。视频资源的元数据获取流程与音频类似，由于视频没有专辑封面，所以无法获取视频资源的专辑封面。

获取音频资源的元数据的全流程包含：创建AVMetadataExtractor，设置资源，获取元数据，获取专辑封面，销毁资源。

开发步骤及注意事项

详细的API说明请参考AVMetadataExtractor API参考。

使用createAVMetadataExtractor()创建实例。

import { media } from '@kit.MediaKit';
// 创建AVMetadataExtractor对象。
let avMetadataExtractor: media.AVMetadataExtractor = await media.createAVMetadataExtractor();

设置资源：用户可以根据需要选择设置属性fdSrc（表示文件描述符）, 或者设置属性dataSrc（表示dataSource描述符）。 > 说明： > > 开发者需根据实际情况，确认资源有效性并设置（只能设置其中一种）： > > - 如果设置fdSrc，可以使用ResourceManager.getRawFd打开HAP资源文件描述符，使用方法可参考ResourceManager API参考。也可以通过应用沙箱路径访问对应资源（必须确保资源可用），参考获取应用文件路径。应用沙箱的介绍及如何向应用沙箱推送文件，请参考文件管理。 > > - 如果设置dataSrc，必须正确设置dataSrc中的callback属性，确保callback被调用时能正确读取到对应资源，使用应用沙箱路径访问对应资源，参考获取应用文件路径。应用沙箱的介绍及如何向应用沙箱推送文件，请参考文件管理。 > > - 不同AVMetadataExtractor或者AVImageGenerator实例，如果需要操作同一资源，需要多次打开文件描述符，不要共用同一文件描述符。

   import { common } from '@kit.AbilityKit';
   import { fileIo as fs, ReadOptions } from '@kit.CoreFileKit';
   // 获取rawfile目录下资源文件描述符，设置fdSrc属性。
   // 获取当前组件所在Ability的Context，并通过Context获取应用文件路径。
   let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
   // 设置fdSrc，test.mp3为rawfile目录下的预置资源，需要开发者根据实际情况进行替换。
   avMetadataExtractor.fdSrc = await context.resourceManager.getRawFd('test.mp3');

   // 使用fs文件系统打开沙箱地址获取媒体文件地址，设置fdSrc属性。
   context: Context = this.getUIContext().getHostContext() as common.UIAbilityContext;
   rootPath: string = this.context.filesDir; // 应用文件目录。
   testFilename: string = '/test.mp3'; // test.mp3为应用文件目录下的预置资源，需要开发者根据实际情况进行替换。
   avMetadataExtractor.fdSrc = fs.openSync(this.rootPath + this.testFilename); // 设置fdSrc属性。

   // 使用fs文件系统打开沙箱地址获取媒体文件地址，设置dataSrc属性。
   // 通过UIAbilityContext获取沙箱地址filesDir（以Stage模型为例）。
   let fd: number = fs.openSync(this.rootPath + this.testFilename).fd;
   let fileSize: number = fs.statSync(this.rootPath + this.testFilename).size;
   // 设置dataSrc描述符，通过callback从文件中获取资源，写入buffer中。
   let dataSrc: media.AVDataSrcDescriptor = {
     fileSize: fileSize,
     callback: (buffer, len, pos) => {
       if (buffer == undefined||len == undefined||pos == undefined) {
         console.error(TAG, `dataSrc callback param invalid`);
         return -1;
       }
       let options: ReadOptions = {
         offset: pos,
         length: len
       };
       let num = fs.readSync(fd, buffer, options);
       console.info(TAG, 'readAt end, num: ' + num);
       if (num > 0 && fileSize >= pos) {
         return num;
       }
       return -1;
     }
   };
   // 设置dataSrc。
   avMetadataExtractor.dataSrc = dataSrc;

获取元数据：调用fetchMetadata()，可以获取到一个AVMetadata对象，通过访问该对象的各个属性，可以获取到元数据。 “ts // 获取元数据（callback模式）。 avMetadataExtractor.fetchMetadata((error, metadata) => { if (error) { console.error(TAG,fetchMetadata callback failed, err = ${JSON.stringify(error)}`); return; } })

// 获取元数据（promise模式）。 let metadata = await avMetadataExtractor.fetchMetadata();


4. （可选）获取专辑封面：调用fetchAlbumCover()，可以获取到专辑封面。
   ```ts
   import { image } from '@kit.ImageKit';
   // pixelMap对象声明，用于图片显示。
   @State pixelMap: image.PixelMap|undefined = undefined;
   //获取专辑封面（callback模式）。
   avMetadataExtractor.fetchAlbumCover((err, pixelMap) => {
     if (err) {
       console.error(TAG, `fetchAlbumCover callback failed, err = ${JSON.stringify(err)}`);
       return;
     }
     this.pixelMap = pixelMap;
   })

   // 获取专辑封面（promise模式）。
   this.pixelMap = await avMetadataExtractor.fetchAlbumCover();

释放资源：调用release()销毁实例，释放资源。 “ts // 释放资源（callback模式）。 avMetadataExtractor.release((error) => { if (error) { console.error(TAG,release failed, err = ${JSON.stringify(error)}); return; } console.info(TAG,release success.`); })

// 释放资源（promise模式）。 avMetadataExtractor.release(); “`

运行示例工程

参考以下示例，获取一个音频的元数据和专辑封面。

新建工程，下载完整示例工程，并将示例工程的资源复制到对应目录。 AVMetadataExtractorArkTS entry/src/main/ets/ └── pages └── Index.ets (获取元数据界面) entry/src/main/resources/ ├── base │ ├── element │ │ ├── color.json │ │ ├── float.json │ │ └── string.json │ └── media │ └── rawfile └── test.mp3 (音频资源)
编译新建工程并运行。