native_avmetadata.h

概述

提供播控元数据的定义。

库： libohavsession.so

引用文件： <multimedia/av_session/native_avmetadata.h>

系统能力： SystemCapability.Multimedia.AVSession.Core

起始版本： 13

相关模块：OHAVSession

汇总

类型定义

名称	描述
typedef struct OH_AVMetadataBuilderStruct OH_AVMetadataBuilder	会话元数据构造器。 构造器用于构造会话元数据。
typedef struct OH_AVMetadataStruct OH_AVMetadata	会话元数据。 资源设置的avmetadata的实例。

枚举

名称	描述
AVMetadata_Result { AVMETADATA_SUCCESS = 0, AVMETADATA_ERROR_INVALID_PARAM = 1, AVMETADATA_ERROR_NO_MEMORY = 2 }	元数据操作的错误码。
AVMetadata_SkipIntervals { SECONDS_10 = 10, SECONDS_15 = 15, SECONDS_30 = 30 }	表示session支持的快进快退时间间隔。
AVMetadata_DisplayTag { AVSESSION_DISPLAYTAG_AUDIO_VIVID = 1 }	应用媒体音源的特殊类型标识。

函数

名称	描述
AVMetadata_Result OH_AVMetadataBuilder_Create (OH_AVMetadataBuilder **builder)	创建一个元数据构造器。
AVMetadata_Result OH_AVMetadataBuilder_Destroy (OH_AVMetadataBuilder *builder)	销毁元数据构造器。
AVMetadata_Result OH_AVMetadataBuilder_SetAssetId (OH_AVMetadataBuilder *builder, const char *assetId)	设置当前媒体资源id。
AVMetadata_Result OH_AVMetadataBuilder_SetTitle (OH_AVMetadataBuilder *builder, const char *title)	设置资源标题。
AVMetadata_Result OH_AVMetadataBuilder_SetArtist (OH_AVMetadataBuilder *builder, const char *artist)	设置资源所属的艺术家。
AVMetadata_Result OH_AVMetadataBuilder_SetAuthor (OH_AVMetadataBuilder *builder, const char *author)	设置资源的作者。
AVMetadata_Result OH_AVMetadataBuilder_SetAlbum (OH_AVMetadataBuilder *builder, const char *album)	设置资源专辑名称。
AVMetadata_Result OH_AVMetadataBuilder_SetWriter (OH_AVMetadataBuilder *builder, const char *writer)	设置资源词作者。
AVMetadata_Result OH_AVMetadataBuilder_SetComposer (OH_AVMetadataBuilder *builder, const char *composer)	设置资源作曲者。
AVMetadata_Result OH_AVMetadataBuilder_SetDuration (OH_AVMetadataBuilder *builder, int64_t duration)	设置资源播放时长。
AVMetadata_Result OH_AVMetadataBuilder_SetMediaImageUri (OH_AVMetadataBuilder *builder, const char *mediaImageUri)	设置媒体图片数据。
AVMetadata_Result OH_AVMetadataBuilder_SetSubtitle (OH_AVMetadataBuilder *builder, const char *subtitle)	设置副标题。
AVMetadata_Result OH_AVMetadataBuilder_SetDescription (OH_AVMetadataBuilder *builder, const char *description)	设置媒体描述信息。
AVMetadata_Result OH_AVMetadataBuilder_SetLyric (OH_AVMetadataBuilder *builder, const char *lyric)	设置歌词。
AVMetadata_Result OH_AVMetadataBuilder_SetSkipIntervals (OH_AVMetadataBuilder *builder, AVMetadata_SkipIntervals intervals)	设置资源的跳转的间隔时间。
AVMetadata_Result OH_AVMetadataBuilder_SetDisplayTags (OH_AVMetadataBuilder *builder, int32_t tags)	设置媒体资源的金标类型。
AVMetadata_Result OH_AVMetadataBuilder_GenerateAVMetadata (OH_AVMetadataBuilder *builder, OH_AVMetadata **avMetadata)	生成媒体元数据对象。
AVMetadata_Result OH_AVMetadata_Destroy (OH_AVMetadata *avMetadata)	释放媒体元数据对象。