OHOS::AVSession::AVMetaData


OHOS::AVSession::AVMetaData

概述

会话元数据类,提供获取metadata进程间传递的序列化和反序列话及数据拷贝的接口方法。

汇总

Public 类型

名称 描述
{
META_KEY_ASSET_ID = 0, META_KEY_TITLE = 1, META_KEY_ARTIST = 2, META_KEY_AUTHOR = 3, META_KEY_ALBUM = 4, META_KEY_WRITER = 5, META_KEY_COMPOSER = 6, META_KEY_DURATION = 7, META_KEY_MEDIA_IMAGE = 8, META_KEY_MEDIA_IMAGE_URI = 9, META_KEY_PUBLISH_DATE = 10, META_KEY_SUBTITLE = 11, META_KEY_DESCRIPTION = 12, META_KEY_LYRIC = 13, META_KEY_PREVIOUS_ASSET_ID = 14, META_KEY_NEXT_ASSET_ID = 15, META_KEY_MAX = 16
}
会话元数据具体枚举项。
MetaMaskType = std::bitset< META_KEY_MAX > 引入掩码标记需要拷贝的会话元数据。

Public 成员函数

名称 描述
AVMetaData ()=default 会话元数据默认构造函数。
~AVMetaData () override 会话元数据默认析构函数。
Marshalling (Parcel &data) const override 实现会话元数据进程间传递的序列化。
SetAssetId (const std::string &assetId) 设置曲目ID。
GetAssetId () const 获取曲目ID。
SetTitle (const std::string &title) 设置标题。
GetTitle () const 获取标题。
SetArtist (const std::string &artist) 设置艺术家名称。
GetArtist () const 获取艺术家名称。
SetAuthor (const std::string &author) 设置制作人名称。
GetAuthor () const 获取制作人名称。
SetAlbum (const std::string &album) 设置专辑名称。
GetAlbum () const 获取专辑名称。
SetWriter (const std::string &writer) 设置作词名称。
GetWriter () const 获取作词名称。
SetComposer (const std::string &composer) 设置作曲名称。
GetComposer () const 获取作曲名称。
SetDuration (int64_t duration) 设置媒体时长。
GetDuration () const 获取媒体时长。
SetMediaImage (const std::shared_ptr< AVSessionPixelMap > &mediaImage) 设置媒体图片。
GetMediaImage () const 获取媒体图片。
SetMediaImageUri (const std::string &mediaImageUri) 设置媒体图片URI。
GetMediaImageUri () const 获取媒体图片URI。
SetPublishDate (double date) 设置曲目发布日期,时间戳,单位为ms。
GetPublishDate () const 获取曲目发布日期,时间戳,单位为ms。
SetSubTitle (const std::string &subTitle) 设置子标题。
GetSubTitle () const 获取子标题。
SetDescription (const std::string &description) 设置曲目描述。
GetDescription () const 获取曲目描述。
SetLyric (const std::string &lyric) 设置歌词。
GetLyric () const 获取歌词。
SetPreviousAssetId (const std::string &assetId) 设置上一曲曲目ID。
GetPreviousAssetId () const 获取上一曲曲目ID。
SetNextAssetId (const std::string &assetId) 设置下一曲曲目ID。
GetNextAssetId () const 获取下一曲曲目ID。
Reset () 重置所有会话元数据项。
GetMetaMask () const 获取掩码。
CopyToByMask (MetaMaskType &mask, AVMetaData &metaOut) const 根据metadata掩码,将metadata项复制到metaOut。
CopyFrom (const AVMetaData &metaIn) 根据metaIn元掩码的设置位从metaIn复制metadata项。
IsValid () const 会话元数据有效性判断。

静态 Public 成员函数

名称 描述
Unmarshalling (Parcel &data) 实现会话元数据进程间传递的反序列化。

静态 Public 属性

名称 描述
DURATION_ALWAYS_PLAY = -1 持续时间全局变量宏定义。
localCapability 会话元数据数组,用于分布式业务,设置会话属性。

成员类型定义说明

MetaMaskType

using OHOS::AVSession::AVMetaData::MetaMaskType = std::bitset<META_KEY_MAX>
1

描述: 引入掩码标记需要拷贝的会话元数据。

成员枚举类型说明

anonymous enum

anonymous enum
1

描述: 会话元数据具体枚举项。

枚举值 描述
META_KEY_ASSET_ID 曲目ID
META_KEY_TITLE 标题
META_KEY_ARTIST 艺术家
META_KEY_AUTHOR 制作人
META_KEY_ALBUM 专辑
META_KEY_WRITER 作词
META_KEY_COMPOSER 作曲
META_KEY_DURATION 媒体时长
META_KEY_MEDIA_IMAGE 媒体影像
META_KEY_MEDIA_IMAGE_URI 媒体影像路径
META_KEY_PUBLISH_DATE 曲目发布日期
META_KEY_SUBTITLE 子标题
META_KEY_DESCRIPTION 曲目描述
META_KEY_LYRIC 歌词
META_KEY_PREVIOUS_ASSET_ID 上一曲
META_KEY_NEXT_ASSET_ID 下一曲
META_KEY_MAX 无效指令,内部用来判断会话元数据是否有效

构造及析构函数说明

AVMetaData()

OHOS::AVSession::AVMetaData::AVMetaData ()
1

描述: 会话元数据默认构造函数。

~AVMetaData()

OHOS::AVSession::AVMetaData::~AVMetaData ()
1

描述: 会话元数据默认析构函数。

成员函数说明

CopyFrom()

bool OHOS::AVSession::AVMetaData::CopyFrom (const AVMetaData & metaIn)
1

描述: 根据metaIn元掩码的设置位从metaIn复制metadata项。

参数:

名称 描述
metaIn 会话元数据将要拷贝的入参。

CopyToByMask()

bool OHOS::AVSession::AVMetaData::CopyToByMask (MetaMaskType & mask, AVMetaData & metaOut ) const
1

描述: 根据metadata掩码,将metadata项复制到metaOut。

参数:

名称 描述
mask metadata掩码MetaMaskType
metaOut metadata已拷贝成功的出参AVMetaData。

返回:

成功返回true;失败则返回false。

GetAlbum()

std::string OHOS::AVSession::AVMetaData::GetAlbum () const
1

描述: 获取专辑名称。

返回:

返回专辑名称。

参见:

SetAlbum

GetArtist()

std::string OHOS::AVSession::AVMetaData::GetArtist () const
1

描述: 获取艺术家名称。

返回:

返回艺术家名称。

参见:

SetArtist

GetAssetId()

std::string OHOS::AVSession::AVMetaData::GetAssetId () const
1

描述: 获取曲目ID。

返回:

返回曲目ID。

参见:

SetAssetId

GetAuthor()

std::string OHOS::AVSession::AVMetaData::GetAuthor () const
1

描述: 获取制作人名称。

返回:

返回制作人名称。

参见:

SetAuthor

GetComposer()

std::string OHOS::AVSession::AVMetaData::GetComposer () const
1

描述: 获取作曲名称。

返回:

返回作曲名称。

参见:

SetComposer

GetDescription()

std::string OHOS::AVSession::AVMetaData::GetDescription () const
1

描述: 获取曲目描述。

返回:

返回曲目描述。

参见:

SetDescription

GetDuration()

int64_t OHOS::AVSession::AVMetaData::GetDuration () const
1

描述: 获取媒体时长。

返回:

返回媒体时长,单位为ms。

参见:

SetDuration

GetLyric()

std::string OHOS::AVSession::AVMetaData::GetLyric () const
1

描述: 获取歌词。

返回:

返回歌词。

参见:

SetLyric

GetMediaImage()

std::shared_ptr<AVSessionPixelMap> OHOS::AVSession::AVMetaData::GetMediaImage () const
1

描述: 获取媒体图片。

返回:

返回媒体图片AVSessionPixelMap

参见:

SetMediaImage

GetMediaImageUri()

std::string OHOS::AVSession::AVMetaData::GetMediaImageUri () const
1

描述: 获取媒体图片URI。

返回:

返回媒体图片URI。

参见:

SetMediaImageUri

GetMetaMask()

MetaMaskType OHOS::AVSession::AVMetaData::GetMetaMask () const
1

描述: 获取掩码。

返回:

返回掩码MetaMaskType

GetNextAssetId()

std::string OHOS::AVSession::AVMetaData::GetNextAssetId () const
1

描述: 获取下一曲曲目ID。

返回:

返回下一曲曲目ID。

参见:

SetNextAssetId

GetPreviousAssetId()

std::string OHOS::AVSession::AVMetaData::GetPreviousAssetId () const
1

描述: 获取上一曲曲目ID。

返回:

返回上一曲曲目ID。

参见:

SetPreviousAssetId

GetPublishDate()

double OHOS::AVSession::AVMetaData::GetPublishDate () const
1

描述: 获取曲目发布日期,时间戳,单位为ms。

返回:

返回曲目发布日期,时间戳,单位为ms。

参见:

SetPublishDate

GetSubTitle()

std::string OHOS::AVSession::AVMetaData::GetSubTitle () const
1

描述: 获取子标题。

返回:

返回子标题。

参见:

SetSubTitle

GetTitle()

std::string OHOS::AVSession::AVMetaData::GetTitle () const
1

描述: 获取标题。

返回:

返回标题。

参见:

SetTitle

GetWriter()

std::string OHOS::AVSession::AVMetaData::GetWriter () const
1

描述: 获取作词名称。

返回:

返回作词名称。

参见:

SetWriter

IsValid()

bool OHOS::AVSession::AVMetaData::IsValid () const
1

描述: 会话元数据有效性判断。

返回:

有效返回true;无效则返回false。

Marshalling()

bool OHOS::AVSession::AVMetaData::Marshalling (Parcel & data) const
1

描述: 实现会话元数据进程间传递的序列化。

参数:

名称 描述
data 保存序列化值的对象Parcel

返回:

如果序列化成功,则返回true;如果操作失败,则返回false。

参见:

Unmarshalling

Reset()

void OHOS::AVSession::AVMetaData::Reset ()
1

描述: 重置所有会话元数据项。

SetAlbum()

void OHOS::AVSession::AVMetaData::SetAlbum (const std::string & album)
1

描述: 设置专辑名称。

参数:

名称 描述
album 专辑名称。

参见:

GetAlbum

SetArtist()

void OHOS::AVSession::AVMetaData::SetArtist (const std::string & artist)
1

描述: 设置艺术家名称。

参数:

名称 描述
artist 艺术家名称。

参见:

GetArtist

SetAssetId()

void OHOS::AVSession::AVMetaData::SetAssetId (const std::string & assetId)
1

描述: 设置曲目ID。

参数:

名称 描述
assetId 曲目ID,不可为空。

参见:

GetAssetId

SetAuthor()

void OHOS::AVSession::AVMetaData::SetAuthor (const std::string & author)
1

描述: 设置制作人名称。

参数:

名称 描述
author 制作人名称。

参见:

GetArtist

SetComposer()

void OHOS::AVSession::AVMetaData::SetComposer (const std::string & composer)
1

描述: 设置作曲名称。

参数:

名称 描述
composer 作曲名称。

参见:

GetComposer

SetDescription()

void OHOS::AVSession::AVMetaData::SetDescription (const std::string & description)
1

描述: 设置曲目描述。

参数:

名称 描述
description 曲目描述。

参见:

GetDescription

SetDuration()

void OHOS::AVSession::AVMetaData::SetDuration (int64_t duration)
1

描述: 设置媒体时长。

参数:

名称 描述
duration 媒体时长,必须大于等于-1,单位为ms 。

参见:

GetDuration

SetLyric()

void OHOS::AVSession::AVMetaData::SetLyric (const std::string & lyric)
1

描述: 设置歌词。

参数:

名称 描述
lyric 歌词。

参见:

GetLyric

SetMediaImage()

void OHOS::AVSession::AVMetaData::SetMediaImage (const std::shared_ptr< AVSessionPixelMap > & mediaImage)
1

描述: 设置媒体图片。

参数:

名称 描述
mediaImage 媒体图片AVSessionPixelMap

参见:

GetMediaImage

SetMediaImageUri()

void OHOS::AVSession::AVMetaData::SetMediaImageUri (const std::string & mediaImageUri)
1

描述: 设置媒体图片URI。

参数:

名称 描述
mediaImageUri 媒体图片URI。

参见:

GetMediaImageUri

SetNextAssetId()

void OHOS::AVSession::AVMetaData::SetNextAssetId (const std::string & assetId)
1

描述: 设置下一曲曲目ID。

参数:

名称 描述
assetId 下一曲曲目ID。

参见:

GetNextAssetId

SetPreviousAssetId()

void OHOS::AVSession::AVMetaData::SetPreviousAssetId (const std::string & assetId)
1

描述: 设置上一曲曲目ID。

参数:

名称 描述
assetId 上一曲曲目ID。

参见:

GetPreviousAssetId

SetPublishDate()

void OHOS::AVSession::AVMetaData::SetPublishDate (double date)
1

描述: 设置曲目发布日期,时间戳,单位为ms。

参数:

名称 描述
date 曲目发布日期,时间戳,单位为ms。

参见:

GetPublishDate

SetSubTitle()

void OHOS::AVSession::AVMetaData::SetSubTitle (const std::string & subTitle)
1

描述: 设置子标题。

参数:

名称 描述
subTitle 子标题。

参见:

GetSubTitle

SetTitle()

void OHOS::AVSession::AVMetaData::SetTitle (const std::string & title)
1

描述: 设置标题。

参数:

名称 描述
title 标题。

参见:

GetTitle

SetWriter()

void OHOS::AVSession::AVMetaData::SetWriter (const std::string & writer)
1

描述: 设置作词名称。

参数:

名称 描述
writer 作词名称。

参见:

GetWriter

Unmarshalling()

static AVMetaData* OHOS::AVSession::AVMetaData::Unmarshalling (Parcel & data)
1

描述: 实现会话元数据进程间传递的反序列化。

参数:

名称 描述
data 序列化对象Parcel

返回:

如果反序列化成功,返回AVMetaData类型指针;失败则返回nullptr。

参见:

Marshalling

结构体成员变量说明

DURATION_ALWAYS_PLAY

constexpr std::int64_t OHOS::AVSession::AVMetaData::DURATION_ALWAYS_PLAY = -1
1

描述: 持续时间全局变量宏定义。

localCapability

const std::vector<int32_t> OHOS::AVSession::AVMetaData::localCapability
1

Value:

{
 META_KEY_ASSET_ID,
 META_KEY_TITLE,
 META_KEY_ARTIST,
 META_KEY_AUTHOR,
 META_KEY_ALBUM,
 META_KEY_WRITER,
 META_KEY_COMPOSER,
 META_KEY_DURATION,
 META_KEY_MEDIA_IMAGE,
 META_KEY_MEDIA_IMAGE_URI,
 META_KEY_PUBLISH_DATE,
 META_KEY_SUBTITLE,
 META_KEY_DESCRIPTION,
 META_KEY_LYRIC,
 META_KEY_PREVIOUS_ASSET_ID,
 META_KEY_NEXT_ASSET_ID,
 }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

描述: 会话元数据数组,用于分布式业务,设置会话属性。