native_avmetadata.h

Overview

The native_avmetadata.h file declares the definitions of playback control metadata.

Library: libohavsession.so

File to include: <multimedia/av_session/native_avmetadata.h>

System capability: SystemCapability.Multimedia.AVSession.Core

Since: 13

Related module: OHAVSession

Summary

Types

Name	Description
typedef struct OH_AVMetadataBuilderStruct OH_AVMetadataBuilder	Defines a struct for the session metadata builder. The builder is used to construct session metadata.
typedef struct OH_AVMetadataStruct OH_AVMetadata	Defines a struct for the session metadata. It is an AVMetadata instance set for a media asset.

Enums

Name	Description
AVMetadata_Result { AVMETADATA_SUCCESS = 0, AVMETADATA_ERROR_INVALID_PARAM = 1, AVMETADATA_ERROR_NO_MEMORY = 2 }	Enumerates the error codes related to metadata operations.
AVMetadata_SkipIntervals { SECONDS_10 = 10, SECONDS_15 = 15, SECONDS_30 = 30 }	Enumerates the fast-forward or rewind intervals supported by the media session.
AVMetadata_DisplayTag { AVSESSION_DISPLAYTAG_AUDIO_VIVID = 1 }	Enumerates the display tags of the media asset. The display tag is a special type identifier of the media audio source.

Functions

Name	Description
AVMetadata_Result OH_AVMetadataBuilder_Create (OH_AVMetadataBuilder **builder)	Creates a metadata builder.
AVMetadata_Result OH_AVMetadataBuilder_Destroy (OH_AVMetadataBuilder *builder)	Destroys a metadata builder.
AVMetadata_Result OH_AVMetadataBuilder_SetAssetId (OH_AVMetadataBuilder builder, const char assetId)	Sets the ID of the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetTitle (OH_AVMetadataBuilder builder, const char title)	Sets a title for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetArtist (OH_AVMetadataBuilder builder, const char artist)	Sets an artist for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetAuthor (OH_AVMetadataBuilder builder, const char author)	Sets an author for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetAlbum (OH_AVMetadataBuilder builder, const char album)	Sets an album name for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetWriter (OH_AVMetadataBuilder builder, const char writer)	Sets a writer for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetComposer (OH_AVMetadataBuilder builder, const char composer)	Sets a composer for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetDuration (OH_AVMetadataBuilder *builder, int64_t duration)	Sets the playback duration for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetMediaImageUri (OH_AVMetadataBuilder builder, const char mediaImageUri)	Sets an image for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetSubtitle (OH_AVMetadataBuilder builder, const char subtitle)	Sets a subtitle for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetDescription (OH_AVMetadataBuilder builder, const char description)	Sets a description for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetLyric (OH_AVMetadataBuilder builder, const char lyric)	Sets lyrics for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetSkipIntervals (OH_AVMetadataBuilder *builder, AVMetadata_SkipIntervals intervals)	Sets the skip intervals for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_SetDisplayTags (OH_AVMetadataBuilder *builder, int32_t tags)	Sets display tags for the media asset.
AVMetadata_Result OH_AVMetadataBuilder_GenerateAVMetadata (OH_AVMetadataBuilder builder, OH_AVMetadata *avMetadata)	Generates an OH_AVMetadata object.
AVMetadata_Result OH_AVMetadata_Destroy (OH_AVMetadata *avMetadata)	Releases an OH_AVMetadata object.