harmony 鸿蒙AVMetadataExtractor

  • 2025-06-12
  • 浏览 (4)

AVMetadataExtractor

Overview

The AVMetadataExtractor module provides the APIs for extracting metadata from media assets.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

Summary

Files

Name Description
avmetadata_extractor.h Declares the AVMetadataExtractor APIs. With these native APIs, you can obtain metadata from media assets.
avmetadata_extractor_base.h Declares the constants used by the AVMetadataExtractor.

Types

Name Description
typedef struct OH_AVMetadataExtractor OH_AVMetadataExtractor Defines a struct for the OH_AVMetadataExtractor.

Functions

Name Description
OH_AVMetadataExtractor * OH_AVMetadataExtractor_Create (void) Creates an OH_AVMetadataExtractor instance.
OH_AVErrCode OH_AVMetadataExtractor_SetFDSource (OH_AVMetadataExtractor *extractor, int32_t fd, int64_t offset, int64_t size) Sets a data source based on the media file descriptor.
OH_AVErrCode OH_AVMetadataExtractor_FetchMetadata (OH_AVMetadataExtractor *extractor, OH_AVFormat *avMetadata) Obtains metadata from a media asset. This function must be called after SetFDSource.
OH_AVErrCode OH_AVMetadataExtractor_FetchAlbumCover (OH_AVMetadataExtractor *extractor, OH_PixelmapNative **pixelMap) Obtains the cover of an audio album. This function must be called after SetFDSource.
OH_AVErrCode OH_AVMetadataExtractor_Release (OH_AVMetadataExtractor *extractor) Releases the resources used by the OH_AVMetadataExtractor instance and destroys the instance.

Variables

Name Description
static const char* OH_AVMETADATA_EXTRACTOR_ALBUM = “album” Pointer to the key for obtaining the title of the album. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_ALBUM_ARTIST = “albumArtist” Pointer to the key for obtaining the artist of the album. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_ARTIST = “artist” Pointer to the key for obtaining the artist of the media asset. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_AUTHOR = “author” Pointer to the key for obtaining the author of the media asset. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_DATE_TIME = “dateTime” Pointer to the key for obtaining the creation time of the media asset. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_DATE_TIME_FORMAT = “dateTimeFormat” Pointer to the key for obtaining the creation time of the media asset. The value type is const char* and the output format is YYYY-MM-DD HH:mm:ss.
static const char* OH_AVMETADATA_EXTRACTOR_COMPOSER = “composer” Pointer to the key for obtaining the composer of the media asset. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_DURATION = “duration” Pointer to the key for obtaining the duration of the media asset, in ms. The value type is int64_t.
static const char* OH_AVMETADATA_EXTRACTOR_GENRE = “genre” Pointer to the key for obtaining the type or genre of the media asset. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_HAS_AUDIO = “hasAudio” Pointer to the key for obtaining the flag indicating whether the media asset contains audio. The value type is int32_t.
static const char* OH_AVMETADATA_EXTRACTOR_HAS_VIDEO = “hasVideo” Pointer to the key for obtaining the flag indicating whether the media asset contains video. The value type is int32_t.
static const char* OH_AVMETADATA_EXTRACTOR_MIME_TYPE = “mimeType” Pointer to the key for obtaining the MIME type of the media asset. The value type is const char*, for example, video/mp4, audio/mp4, and audio/amr wb.
static const char* OH_AVMETADATA_EXTRACTOR_TRACK_COUNT = “trackCount” Pointer to the key for obtaining the number of tracks of the media asset. The value type is int32_t.
static const char* OH_AVMETADATA_EXTRACTOR_SAMPLE_RATE = “sampleRate” Pointer to the key for obtaining the audio sampling rate, in Hz. The value type is int32_t.
static const char* OH_AVMETADATA_EXTRACTOR_TITLE = “title” Pointer to the key for obtaining the title of the media asset. The value type is const char*.
static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_HEIGHT = “videoHeight” Pointer to the key for obtaining the video height, in px. The value type is int32_t.
static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_WIDTH = “videoWidth” Pointer to the key for obtaining the video weight, in px. The value type is int32_t.
static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_ORIENTATION = “videoOrientation” Pointer to the key for obtaining the video rotation direction, in degrees (°). The value type is int32_t.
static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_IS_HDR_VIVID = “hdrType” Pointer to the key for obtaining the flag indicating whether the video is an HDR Vivid video. The value type is int32_t. For details, see the definition of OH_Core_HdrType in media_types.h.
static const char* OH_AVMETADATA_EXTRACTOR_LOCATION_LATITUDE = “latitude” Pointer to the key for obtaining the latitude in the geographical location. The value type is float.
static const char* OH_AVMETADATA_EXTRACTOR_LOCATION_LONGITUDE = “longitude” Pointer to the key for obtaining the longitude in the geographical location. The value type is float.

Type Description

OH_AVMetadataExtractor

typedef struct OH_AVMetadataExtractor OH_AVMetadataExtractor

Description

Defines a struct for the OH_AVMetadataExtractor.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

Function Description

OH_AVMetadataExtractor_Create()

OH_AVMetadataExtractor* OH_AVMetadataExtractor_Create(void)

Description

Creates an OH_AVMetadataExtractor instance.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

Returns

Returns the pointer to the OH_AVMetadataExtractor instance created if the operation is successful; returns a null pointer otherwise.

Possible cause of failures: HstEngineFactory::CreateAVMetadataHelperEngine fails to run.

OH_AVMetadataExtractor_FetchAlbumCover()

OH_AVErrCode OH_AVMetadataExtractor_FetchAlbumCover(OH_AVMetadataExtractor* extractor, OH_PixelmapNative** pixelMap)

Description

Obtains the cover of an audio album. This function must be called after SetFDSource.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

Parameters

Name Description
extractor Pointer to an OH_AVMetadataExtractor instance.
pixelMap Double pointer to the album cover obtained. For details, see OH_PixelmapNative.

Returns

Returns a result code defined in OH_AVErrCode. The following result codes are possible:

AV_ERR_OK: The operation is successful.

AV_ERR_INVALID_VAL: The input parameter extractor is a null pointer or an input parameter is invalid.

AV_ERR_OPERATE_NOT_PERMIT: The operation is not allowed.

AV_ERR_UNSUPPORTED_FORMAT: The format is not supported.

AV_ERR_NO_MEMORY: Internal memory allocation failed.

OH_AVMetadataExtractor_FetchMetadata()

OH_AVErrCode OH_AVMetadataExtractor_FetchMetadata(OH_AVMetadataExtractor* extractor, OH_AVFormat* avMetadata)

Description

Obtains metadata from a media asset. This function must be called after SetFDSource.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

Parameters

Name Description
extractor Pointer to an OH_AVMetadataExtractor instance.
avMetadata Pointer to an OH_AVFormat instance, which contains the obtained metadata.

Returns

Returns a result code defined in OH_AVErrCode. The following result codes are possible:

AV_ERR_OK: The operation is successful.

AV_ERR_INVALID_VAL: The input parameter extractor is a null pointer or an input parameter is invalid.

AV_ERR_OPERATE_NOT_PERMIT: The operation is not allowed.

AV_ERR_UNSUPPORTED_FORMAT: The format is not supported.

AV_ERR_NO_MEMORY: Internal memory allocation failed.

OH_AVMetadataExtractor_Release()

OH_AVErrCode OH_AVMetadataExtractor_Release(OH_AVMetadataExtractor* extractor)

Description

Releases the resources used by the OH_AVMetadataExtractor instance and destroys the instance.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

Parameters

Name Description
extractor Pointer to an OH_AVMetadataExtractor instance.

Returns

Returns a result code defined in OH_AVErrCode. The following result codes are possible:

AV_ERR_OK: The operation is successful.

AV_ERR_INVALID_VAL: The input parameter extractor is a null pointer or an input parameter is invalid.

OH_AVMetadataExtractor_SetFDSource()

OH_AVErrCode OH_AVMetadataExtractor_SetFDSource(OH_AVMetadataExtractor* extractor, int32_t fd, int64_t offset, int64_t size)

Description

Sets a data source based on the media file descriptor.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

Parameters

Name Description
extractor Pointer to an OH_AVMetadataExtractor instance.
fd File descriptor of the media source.
offset Offset of the media source in the file descriptor.
size Size of the media source.

Returns

Returns a result code defined in OH_AVErrCode. The following result codes are possible:

AV_ERR_OK: The operation is successful.

AV_ERR_INVALID_VAL: The input parameter extractor is a null pointer or an input parameter is invalid.

AV_ERR_OPERATE_NOT_PERMIT: The operation is not allowed.

AV_ERR_NO_MEMORY: Internal memory allocation failed.

Variable Description

OH_AVMETADATA_EXTRACTOR_ALBUM

static const char* OH_AVMETADATA_EXTRACTOR_ALBUM = "album"

Description

Pointer to the key for obtaining the title of the album. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_ALBUM_ARTIST

static const char* OH_AVMETADATA_EXTRACTOR_ALBUM_ARTIST = "albumArtist"

Description

Pointer to the key for obtaining the artist of the album. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_ARTIST

static const char* OH_AVMETADATA_EXTRACTOR_ARTIST = "artist"

Description

Pointer to the key for obtaining the artist of the media asset. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_AUTHOR

static const char* OH_AVMETADATA_EXTRACTOR_AUTHOR = "author"

Description

Pointer to the key for obtaining the author of the media asset. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_COMPOSER

static const char* OH_AVMETADATA_EXTRACTOR_COMPOSER = "composer"

Description

Pointer to the key for obtaining the composer of the media asset. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_DATE_TIME

static const char* OH_AVMETADATA_EXTRACTOR_DATE_TIME = "dateTime"

Description

Pointer to the key for obtaining the creation time of the media asset. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_DATE_TIME_FORMAT

static const char* OH_AVMETADATA_EXTRACTOR_DATE_TIME_FORMAT = "dateTimeFormat"

Description

Pointer to the key for obtaining the creation time of the media asset. The value type is const char* and the output format is YYYY-MM-DD HH:mm:ss.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_DURATION

static const char* OH_AVMETADATA_EXTRACTOR_DURATION = "duration"

Description

Pointer to the key for obtaining the duration of the media asset, in ms. The value type is int64_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_GENRE

static const char* OH_AVMETADATA_EXTRACTOR_GENRE = "genre"

Description

Pointer to the key for obtaining the type or genre of the media asset. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_HAS_AUDIO

static const char* OH_AVMETADATA_EXTRACTOR_HAS_AUDIO = "hasAudio"

Description

Pointer to the key for obtaining the flag indicating whether the media asset contains audio. The value type is int32_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_HAS_VIDEO

static const char* OH_AVMETADATA_EXTRACTOR_HAS_VIDEO = "hasVideo"

Description

Pointer to the key for obtaining the flag indicating whether the media asset contains video. The value type is int32_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_LOCATION_LATITUDE

static const char* OH_AVMETADATA_EXTRACTOR_LOCATION_LATITUDE = "latitude"

Description

Pointer to the key for obtaining the latitude in the geographical location. The value type is float.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_LOCATION_LONGITUDE

static const char* OH_AVMETADATA_EXTRACTOR_LOCATION_LONGITUDE = "longitude"

Description

Pointer to the key for obtaining the longitude in the geographical location. The value type is float.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_MIME_TYPE

static const char* OH_AVMETADATA_EXTRACTOR_MIME_TYPE = "mimeType"

Description

Pointer to the key for obtaining the MIME type of the media asset. The value type is const char*, for example, video/mp4, audio/mp4, and audio/amr wb.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_SAMPLE_RATE

static const char* OH_AVMETADATA_EXTRACTOR_SAMPLE_RATE = "sampleRate"

Description

Pointer to the key for obtaining the audio sampling rate, in Hz. The value type is int32_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_TITLE

static const char* OH_AVMETADATA_EXTRACTOR_TITLE = "title"

Description

Pointer to the key for obtaining the title of the media asset. The value type is const char*.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_TRACK_COUNT

static const char* OH_AVMETADATA_EXTRACTOR_TRACK_COUNT = "trackCount"

Description

Pointer to the key for obtaining the number of tracks of the media asset. The value type is int32_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_VIDEO_HEIGHT

static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_HEIGHT = "videoHeight"

Description

Pointer to the key for obtaining the video height, in px. The value type is int32_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_VIDEO_IS_HDR_VIVID

static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_IS_HDR_VIVID = "hdrType"

Description

Pointer to the key for obtaining the flag indicating whether the video is an HDR Vivid video. The value type is int32_t. For details, see the definition of OH_Core_HdrType in media_types.h.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_VIDEO_ORIENTATION

static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_ORIENTATION = "videoOrientation"

Description

Pointer to the key for obtaining the video rotation direction, in degrees (°). The value type is int32_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

OH_AVMETADATA_EXTRACTOR_VIDEO_WIDTH

static const char* OH_AVMETADATA_EXTRACTOR_VIDEO_WIDTH = "videoWidth"

Description

Pointer to the key for obtaining the video weight, in px. The value type is int32_t.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Since: 18

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Media Kit

harmony 鸿蒙AVImageGenerator

harmony 鸿蒙AVPlayer

harmony 鸿蒙AVPlayerCallback

harmony 鸿蒙AVRecorder

harmony 鸿蒙AVScreenCapture

harmony 鸿蒙OH_AVRecorder_Config

harmony 鸿蒙OH_AVRecorder_EncoderInfo

harmony 鸿蒙OH_AVRecorder_Location

harmony 鸿蒙OH_AVRecorder_Metadata

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/MS5SDw
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录