Class for the Media Metadata event. More...

#include <AampEvent.h>

Inheritance diagram for MediaMetadataEvent:

Collaboration diagram for MediaMetadataEvent:

Public Member Functions
	MediaMetadataEvent ()=delete

	MediaMetadataEvent (const MediaMetadataEvent &)=delete

MediaMetadataEvent &	operator= (const MediaMetadataEvent &)=delete

	MediaMetadataEvent (long duration, int width, int height, bool hasDrm, bool isLive, const std::string &DrmType, double programStartTime)
	MediaMetadataEvent Constructor.

virtual	~MediaMetadataEvent ()
	MediaMetadataEvent Destructor.

long	getDuration () const
	Get Duration. More...

double	getProgramStartTime () const
	Get Program/Availability Start Time. More...

void	addLanguage (const std::string &lang)
	Add a supported language. More...

const std::vector< std::string > &	getLanguages () const
	Get Languages. More...

int	getLanguagesCount () const
	Get Language Count. More...

void	addBitrate (long bitrate)
	Add a supported bitrate. More...

const std::vector< long > &	getBitrates () const
	Get Bitrates. More...

int	getBitratesCount () const
	Get Bitrate Count. More...

int	getWidth () const
	Get Width. More...

int	getHeight () const
	Get Height. More...

bool	hasDrm () const
	Supports DRM or not. More...

bool	isLive () const
	Check for Live content or VOD. More...

const std::string &	getDrmType () const
	Get Current DRM Type. More...

void	addSupportedSpeed (float speed)
	Add a supported speed. More...

const std::vector< float > &	getSupportedSpeeds () const
	Get Supported Speeds. More...

int	getSupportedSpeedCount () const
	Get Supported Speed count. More...

void	SetVideoMetaData (float frameRate, VideoScanType videoScanType, int aspectRatioWidth, int aspectRatioHeight, const std::string &videoCodec, const std::string &hdrType, const std::string &pcRating, int ssi)
	Sets additional metadata for video. More...

const std::vector< long > &	getAudioBitrates () const

void	SetAudioMetaData (const std::string &audioCodec, const std::string &mixType, bool isAtmos)
	Sets additional metadata for Audio. More...

void	addAudioBitrate (long bitrate)
	Add a supported bitrate. More...

const std::string &	getRatings () const
	get Parental control ratings More...

int	getSsi () const
	get Signal strength indicator More...

float	getFrameRate () const
	get framerate More...

VideoScanType	getVideoScanType () const
	Get VideoScanType. More...

int	getAspectRatioWidth () const
	Get AspectRatioWidth. More...

int	getAspectRatioHeight () const
	Get AspectRatioHeight. More...

const std::string &	getVideoCodec () const
	Get VideoCodec. More...

const std::string &	getHdrType () const
	Get HdrType. More...

const std::string &	getAudioCodec () const
	Get AudioCodec. More...

const std::string &	getAudioMixType () const
	returns AudioMixType More...

bool	getAtmosInfo () const
	Get Atmos info. More...

const std::string &	getMediaFormat ()
	Get Media format type. More...

void	setMediaFormat (const std::string &mediaFormatName)
	Set Media format type. More...

Public Member Functions inherited from AAMPEventObject
	AAMPEventObject (const AAMPEventObject &)=delete
	Copy constructor disabled. More...

AAMPEventObject &	operator= (const AAMPEventObject &)=delete
	assignment operator disabled More...

	AAMPEventObject (AAMPEventType type)
	AAMPEventObject Constructor.

virtual	~AAMPEventObject ()
	AAMPEvent Destructor.

AAMPEventType	getType () const
	Get Event Type. More...

Private Attributes
long	mDuration

std::vector< std::string >	mLanguages

std::vector< long >	mBitrates

int	mWidth

int	mHeight

bool	mHasDrm

std::vector< float >	mSupportedSpeeds

bool	mIsLive

std::string	mDrmType

double	mProgramStartTime

std::string	mPCRating

int	mSsi

float	mFrameRate

VideoScanType	mVideoScanType

int	mAspectRatioWidth

int	mAspectRatioHeight

std::string	mVideoCodec

std::string	mHdrType

std::string	mMediaFormatName

std::vector< long >	mAudioBitrates

std::string	mAudioCodec

std::string	mAudioMixType

bool	isAtmos

yes

Class for the Media Metadata event.

Definition at line 747 of file AampEvent.h.

Constructor & Destructor Documentation

◆ MediaMetadataEvent()

MediaMetadataEvent::MediaMetadataEvent ( )

delete

Parameters

[in]	duration	- Duration of Media Metadata
[in]	width	- Video width
[in]	height	- Video height
[in]	hasDrm	- Drm enablement status
[in]	isLive	- Is Live
[in]	DrmType	- DRM Type
[in]	programStartTime	- Program/Availability start time

Member Function Documentation

◆ getDuration()

MediaMetadataEvent::getDuration ( ) const

Get Duration.

Returns: Asset duration

Definition at line 344 of file AampEvent.cpp.

◆ getProgramStartTime()

MediaMetadataEvent::getProgramStartTime ( ) const

Get Program/Availability Start Time.

Returns: Program/Availability Start Time.

Definition at line 354 of file AampEvent.cpp.

◆ addLanguage()

void MediaMetadataEvent::addLanguage ( const std::string & lang )

Add a supported language.

Parameters

[in] lang - Supported language

Returns: void

Definition at line 362 of file AampEvent.cpp.

◆ getLanguages()

MediaMetadataEvent::getLanguages ( ) const

Get Languages.

Returns: Vector of supported languages

Definition at line 372 of file AampEvent.cpp.

◆ getLanguagesCount()

MediaMetadataEvent::getLanguagesCount ( ) const

Get Language Count.

Returns: Supported language count

Definition at line 382 of file AampEvent.cpp.

◆ addBitrate()

void MediaMetadataEvent::addBitrate ( long bitrate )

Add a supported bitrate.

Parameters

[in] bitrate - Supported bitrate

Returns: void

Definition at line 390 of file AampEvent.cpp.

◆ getBitrates()

MediaMetadataEvent::getBitrates ( ) const

Get Bitrates.

Returns: Vector of supported bitrates

Definition at line 400 of file AampEvent.cpp.

◆ getBitratesCount()

MediaMetadataEvent::getBitratesCount ( ) const

Get Bitrate Count.

Returns: Supported bitrate count

Definition at line 410 of file AampEvent.cpp.

◆ getWidth()

MediaMetadataEvent::getWidth ( ) const

Get Width.

Returns: Video width

Definition at line 420 of file AampEvent.cpp.

◆ getHeight()

MediaMetadataEvent::getHeight ( ) const

Get Height.

Returns: Video height

Definition at line 430 of file AampEvent.cpp.

◆ hasDrm()

bool MediaMetadataEvent::hasDrm ( ) const

Supports DRM or not.

Returns: DRM enablement status

Definition at line 440 of file AampEvent.cpp.

◆ isLive()

MediaMetadataEvent::isLive ( ) const

Check for Live content or VOD.

Returns: isLive

Definition at line 479 of file AampEvent.cpp.

◆ getDrmType()

MediaMetadataEvent::getDrmType ( ) const

Get Current DRM Type.

Returns: Current DRM

Definition at line 489 of file AampEvent.cpp.

◆ addSupportedSpeed()

void MediaMetadataEvent::addSupportedSpeed ( float speed )

Add a supported speed.

Parameters

[in] speed - Supported speed

Returns: void

Definition at line 448 of file AampEvent.cpp.

◆ getSupportedSpeeds()

MediaMetadataEvent::getSupportedSpeeds ( ) const

Get Supported Speeds.

Returns: Vector of supported speeds

Definition at line 458 of file AampEvent.cpp.

◆ getSupportedSpeedCount()

MediaMetadataEvent::getSupportedSpeedCount ( ) const

Get Supported Speed count.

Returns: Supported speeds count

Definition at line 468 of file AampEvent.cpp.

◆ SetVideoMetaData()

MediaMetadataEvent::SetVideoMetaData	(	float	frameRate,
		VideoScanType	videoScanType,
		int	aspectRatioWidth,
		int	aspectRatioHeight,
		const std::string &	videoCodec,
		const std::string &	hdrType,
		const std::string &	pcRating,
		int	ssi
	)

Sets additional metadata for video.

Parameters

[in]	mFrameRate	- video framerate
[in]	videoScanType	- Scan Type progressive/interlaced
[in]	aspectRatioWidth	- Aspect Ratio Width
[in]	aspectRatioHeight	- Aspect Ratio Height
[in]	strVideoCodec	- VideoCodec(v1) - E.g MPEG2.
[in]	strHdrType	- type of HDR being played, in example "DOLBY_VISION"
[in]	strPCRating	- Parental control rating json string object
	[int]	ssi - Signal strength indicator 0-100 where 100 is a perfect signal. -1 indicates data not available

Definition at line 497 of file AampEvent.cpp.

◆ SetAudioMetaData()

void MediaMetadataEvent::SetAudioMetaData	(	const std::string &	audioCodec,
		const std::string &	mixType,
		bool	isAtmos
	)

Sets additional metadata for Audio.

Get Bitrates.

Parameters

[in]	strAudioCodec	- AudioCodec - E.g AC3.
[in]	strMixType	- AudioMixType - E.g STEREO.
[in]	iAtmos	- 1 - True if audio playing is Dolby Atmos, 0 false , -1 indicates data not available

Returns: Vector of supported bitrates

Definition at line 515 of file AampEvent.cpp.

◆ addAudioBitrate()

void MediaMetadataEvent::addAudioBitrate ( long bitrate )

inline

Add a supported bitrate.

Parameters

[in] bitrate - Supported bitrate

Returns: void

Definition at line 924 of file AampEvent.h.

◆ getRatings()

const std::string& MediaMetadataEvent::getRatings ( ) const

inline

get Parental control ratings

Returns: ratings string

Definition at line 931 of file AampEvent.h.

◆ getSsi()

int MediaMetadataEvent::getSsi ( ) const

inline

get Signal strength indicator

Returns: ratings string

Definition at line 938 of file AampEvent.h.

◆ getFrameRate()

float MediaMetadataEvent::getFrameRate ( ) const

inline

get framerate

Returns: ratings string

Definition at line 945 of file AampEvent.h.

◆ getVideoScanType()

VideoScanType MediaMetadataEvent::getVideoScanType ( ) const

inline

Get VideoScanType.

Returns: VideoScanType

Definition at line 952 of file AampEvent.h.

◆ getAspectRatioWidth()

int MediaMetadataEvent::getAspectRatioWidth ( ) const

inline

Get AspectRatioWidth.

Returns: AspectRatioWidth

Definition at line 959 of file AampEvent.h.

◆ getAspectRatioHeight()

int MediaMetadataEvent::getAspectRatioHeight ( ) const

inline

Get AspectRatioHeight.

Returns: AspectRatioHeight

Definition at line 966 of file AampEvent.h.

◆ getVideoCodec()

const std::string& MediaMetadataEvent::getVideoCodec ( ) const

inline

Get VideoCodec.

Returns: VideoCodec

Definition at line 973 of file AampEvent.h.

◆ getHdrType()

const std::string& MediaMetadataEvent::getHdrType ( ) const

inline

Get HdrType.

Returns: HdrType

Definition at line 980 of file AampEvent.h.

◆ getAudioCodec()

const std::string& MediaMetadataEvent::getAudioCodec ( ) const

inline

Get AudioCodec.

Returns: AudioCodec

Definition at line 987 of file AampEvent.h.

◆ getAudioMixType()

const std::string& MediaMetadataEvent::getAudioMixType ( ) const

inline

returns AudioMixType

Returns: AudioMixType

Definition at line 994 of file AampEvent.h.

◆ getAtmosInfo()

bool MediaMetadataEvent::getAtmosInfo ( ) const

inline

Get Atmos info.

Returns: true/false

Definition at line 1001 of file AampEvent.h.

◆ getMediaFormat()

const std::string& MediaMetadataEvent::getMediaFormat ( )

inline

Get Media format type.

Returns: mediaFormat

Definition at line 1007 of file AampEvent.h.

◆ setMediaFormat()

void MediaMetadataEvent::setMediaFormat ( const std::string & mediaFormatName )

inline

Set Media format type.

Returns: void

Definition at line 1014 of file AampEvent.h.

Field Documentation

◆ mDuration

long MediaMetadataEvent::mDuration

private

Asset duration in MS

Definition at line 749 of file AampEvent.h.

◆ mLanguages

std::vector<std::string> MediaMetadataEvent::mLanguages

private

Available languages

Definition at line 750 of file AampEvent.h.

◆ mBitrates

std::vector<long> MediaMetadataEvent::mBitrates

private

Available bitrates

Definition at line 751 of file AampEvent.h.

◆ mWidth

int MediaMetadataEvent::mWidth

private

Maximum video width

Definition at line 752 of file AampEvent.h.

◆ mHeight

int MediaMetadataEvent::mHeight

private

Maximum video height

Definition at line 753 of file AampEvent.h.

◆ mHasDrm

bool MediaMetadataEvent::mHasDrm

private

Drm enabled

Definition at line 754 of file AampEvent.h.

◆ mSupportedSpeeds

std::vector<float> MediaMetadataEvent::mSupportedSpeeds

private

Supported playback speeds

Definition at line 755 of file AampEvent.h.

◆ mIsLive

bool MediaMetadataEvent::mIsLive

private

Is Live

Definition at line 756 of file AampEvent.h.

◆ mDrmType

std::string MediaMetadataEvent::mDrmType

private

DRM type

Definition at line 757 of file AampEvent.h.

◆ mProgramStartTime

double MediaMetadataEvent::mProgramStartTime

private

Program/Availability start time

Definition at line 758 of file AampEvent.h.

◆ mPCRating

std::string MediaMetadataEvent::mPCRating

private

Parental control rating json string object

Definition at line 761 of file AampEvent.h.

◆ mSsi

int MediaMetadataEvent::mSsi

private

Signal strength indicator 0-100 where 100 is a perfect signal. -1 indicates data not available

Definition at line 762 of file AampEvent.h.

◆ mFrameRate

float MediaMetadataEvent::mFrameRate

private

FrameRate

Definition at line 764 of file AampEvent.h.

◆ mVideoScanType

VideoScanType MediaMetadataEvent::mVideoScanType

private

Video Scan Type progressive/interlaced

Definition at line 765 of file AampEvent.h.

◆ mAspectRatioWidth

int MediaMetadataEvent::mAspectRatioWidth

private

Aspect Ratio Width

Definition at line 766 of file AampEvent.h.

◆ mAspectRatioHeight

int MediaMetadataEvent::mAspectRatioHeight

private

Aspect Ratio Height

Definition at line 767 of file AampEvent.h.

◆ mVideoCodec

std::string MediaMetadataEvent::mVideoCodec

private

VideoCodec - E.g MPEG2.

Definition at line 768 of file AampEvent.h.

◆ mHdrType

std::string MediaMetadataEvent::mHdrType

private

type of HDR being played, in example "DOLBY_VISION"

Definition at line 769 of file AampEvent.h.

◆ mAudioBitrates

std::vector<long> MediaMetadataEvent::mAudioBitrates

private

Available Audio bitrates

Definition at line 773 of file AampEvent.h.

◆ mAudioCodec

std::string MediaMetadataEvent::mAudioCodec

private

AudioCodec E.g AC3.

Definition at line 774 of file AampEvent.h.

◆ mAudioMixType

std::string MediaMetadataEvent::mAudioMixType

private

AudioMixType(- E.g STEREO.

Definition at line 775 of file AampEvent.h.

◆ isAtmos

bool MediaMetadataEvent::isAtmos

private

Is Atmos : 1 - True if audio playing is Dolby Atmos, 0 false , -1 indicates data not available

Definition at line 776 of file AampEvent.h.

The documentation for this class was generated from the following files:

components/generic/aamp/AampEvent.h
components/generic/aamp/AampEvent.cpp
components/generic/aamp/test/utests/fakes/FakeAampEvent.cpp

Public Member Functions

Private Attributes

yes

Constructor & Destructor Documentation

◆ MediaMetadataEvent()

Member Function Documentation

◆ getDuration()

◆ getProgramStartTime()

◆ addLanguage()

◆ getLanguages()

◆ getLanguagesCount()

◆ addBitrate()

◆ getBitrates()

◆ getBitratesCount()

◆ getWidth()

◆ getHeight()

◆ hasDrm()

◆ isLive()

◆ getDrmType()

◆ addSupportedSpeed()

◆ getSupportedSpeeds()

◆ getSupportedSpeedCount()

◆ SetVideoMetaData()

◆ SetAudioMetaData()

◆ addAudioBitrate()

◆ getRatings()

◆ getSsi()

◆ getFrameRate()

◆ getVideoScanType()

◆ getAspectRatioWidth()

◆ getAspectRatioHeight()

◆ getVideoCodec()

◆ getHdrType()

◆ getAudioCodec()

◆ getAudioMixType()

◆ getAtmosInfo()

◆ getMediaFormat()

◆ setMediaFormat()

Field Documentation

◆ mDuration

◆ mLanguages

◆ mBitrates

◆ mWidth

◆ mHeight

◆ mHasDrm

◆ mSupportedSpeeds

◆ mIsLive

◆ mDrmType

◆ mProgramStartTime

◆ mPCRating

◆ mSsi

◆ mFrameRate

◆ mVideoScanType

◆ mAspectRatioWidth

◆ mAspectRatioHeight

◆ mVideoCodec

◆ mHdrType

◆ mAudioBitrates

◆ mAudioCodec

◆ mAudioMixType

◆ isAtmos