RDK Documentation (Open Sourced RDK Components)
TimedMetadataEvent Class Reference

Class for the Timed Metadata event. More...

#include <AampEvent.h>

Inheritance diagram for TimedMetadataEvent:
Inheritance graph
Collaboration diagram for TimedMetadataEvent:
Collaboration graph

Public Member Functions

 TimedMetadataEvent ()=delete
 
 TimedMetadataEvent (const TimedMetadataEvent &)=delete
 
TimedMetadataEventoperator= (const TimedMetadataEvent &)=delete
 
 TimedMetadataEvent (const std::string &name, const std::string &id, double time, double duration, const std::string &content)
 TimedMetadataEvent Constructor.
 
virtual ~TimedMetadataEvent ()
 TimedMetadataEvent Destructor.
 
const std::string & getName () const
 Get Timed Metadata Name. More...
 
const std::string & getId () const
 Get Timed Metadata Id. More...
 
double getTime () const
 Get Time. More...
 
double getDuration () const
 Get Duration. More...
 
const std::string & getContent () const
 Get Content. More...
 
- Public Member Functions inherited from AAMPEventObject
 AAMPEventObject (const AAMPEventObject &)=delete
 Copy constructor disabled. More...
 
AAMPEventObjectoperator= (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

std::string mName
 
std::string mId
 
double mTime
 
double mDuration
 
std::string mContent
 

yes

Class for the Timed Metadata event.

Definition at line 1134 of file AampEvent.h.

Constructor & Destructor Documentation

◆ TimedMetadataEvent()

TimedMetadataEvent::TimedMetadataEvent ( )
delete
Parameters
[in]name- TimedMetadata name
[in]id- TimedMetadata id
[in]time- Time of event
[in]duration- Duration of event
[in]content- Content field of the TimedMetadata

Member Function Documentation

◆ getName()

TimedMetadataEvent::getName ( ) const

Get Timed Metadata Name.

Returns
TimedMetadata name string

Definition at line 679 of file AampEvent.cpp.

◆ getId()

TimedMetadataEvent::getId ( ) const

Get Timed Metadata Id.

Returns
TimedMetadata id string

Definition at line 689 of file AampEvent.cpp.

◆ getTime()

TimedMetadataEvent::getTime ( ) const

Get Time.

Returns
Time of the Timed Metadata

Definition at line 699 of file AampEvent.cpp.

◆ getDuration()

TimedMetadataEvent::getDuration ( ) const

Get Duration.

Returns
Duration (in MS) of the TimedMetadata

Definition at line 709 of file AampEvent.cpp.

◆ getContent()

TimedMetadataEvent::getContent ( ) const

Get Content.

Returns
Content field of the TimedMetadata

Definition at line 719 of file AampEvent.cpp.

Field Documentation

◆ mName

std::string TimedMetadataEvent::mName
private

Metadata name

Definition at line 1136 of file AampEvent.h.

◆ mId

std::string TimedMetadataEvent::mId
private

Id of the timedMetadata

Definition at line 1137 of file AampEvent.h.

◆ mTime

double TimedMetadataEvent::mTime
private

Playback position in MS- relative to tune time - starts at zero

Definition at line 1138 of file AampEvent.h.

◆ mDuration

double TimedMetadataEvent::mDuration
private

Duration of the timed event in MS

Definition at line 1139 of file AampEvent.h.

◆ mContent

std::string TimedMetadataEvent::mContent
private

Metadata content

Definition at line 1140 of file AampEvent.h.


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