RDK Documentation (Open Sourced RDK Components)
ID3MetadataEvent Class Reference

Class for the ID3 Metadata Event. More...

#include <AampEvent.h>

Inheritance diagram for ID3MetadataEvent:
Inheritance graph
Collaboration diagram for ID3MetadataEvent:
Collaboration graph

Public Member Functions

 ID3MetadataEvent (const ID3MetadataEvent &)=delete
 
ID3MetadataEventoperator= (const ID3MetadataEvent &)=delete
 
 ID3MetadataEvent (const std::vector< uint8_t > &metadata, const std::string &schIDUri, std::string &id3Value, uint32_t timeScale, uint64_t presentationTime, uint32_t eventDuration, uint32_t id, uint64_t timestampOffset)
 ID3MetadataEvent. More...
 
virtual ~ID3MetadataEvent ()
 ID3MetadataEvent Destructor.
 
const std::vector< uint8_t > & getMetadata () const
 Get ID3 metdata. More...
 
int getMetadataSize () const
 Get ID3 metdata size. More...
 
uint32_t getTimeScale () const
 Get TimeScale value. More...
 
uint32_t getEventDuration () const
 Get eventDuration. More...
 
uint32_t getId () const
 Get id. More...
 
uint64_t getTimestampOffset () const
 Get timestampOffset. More...
 
uint64_t getPresentationTime () const
 Get presentationTime. More...
 
const std::string & getSchemeIdUri () const
 Get schemeIdUri. More...
 
const std::string & getValue () const
 Get value. 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::vector< uint8_t > mMetadata
 
std::string mSchemeIdUri
 
std::string mValue
 
uint32_t mTimeScale
 
uint64_t mPresentationTime
 
uint32_t mEventDuration
 
uint32_t mId
 
uint64_t mTimestampOffset
 

yes

Class for the ID3 Metadata Event.

Definition at line 1814 of file AampEvent.h.

Constructor & Destructor Documentation

◆ ID3MetadataEvent()

ID3MetadataEvent::ID3MetadataEvent ( const std::vector< uint8_t > &  metadata,
const std::string &  schIDUri,
std::string &  id3Value,
uint32_t  timeScale,
uint64_t  presentationTime,
uint32_t  eventDuration,
uint32_t  id,
uint64_t  timestampOffset 
)

ID3MetadataEvent.

ID3MetadataEvent Constructor.

Parameters
[in]metadata- ID3 metadata
[in]timeScale- timeScale od ID3 data
[in]presentationTime- PTS value
[in]eventDuration- eventDuration
[in]id- id of ID3 data
[in]timestampOffset

Definition at line 1260 of file AampEvent.cpp.

Member Function Documentation

◆ getMetadata()

const std::vector< uint8_t > & ID3MetadataEvent::getMetadata ( ) const

Get ID3 metdata.

Returns
ID3 metadata content

Definition at line 1271 of file AampEvent.cpp.

◆ getMetadataSize()

int ID3MetadataEvent::getMetadataSize ( ) const

Get ID3 metdata size.

Returns
ID3 metadata size

Definition at line 1281 of file AampEvent.cpp.

◆ getTimeScale()

uint32_t ID3MetadataEvent::getTimeScale ( ) const

Get TimeScale value.

Returns
TimeScale value

Definition at line 1291 of file AampEvent.cpp.

◆ getEventDuration()

uint32_t ID3MetadataEvent::getEventDuration ( ) const

Get eventDuration.

Returns
eventDuration value

Definition at line 1301 of file AampEvent.cpp.

◆ getId()

uint32_t ID3MetadataEvent::getId ( ) const

Get id.

Returns
id value

Definition at line 1311 of file AampEvent.cpp.

◆ getTimestampOffset()

uint64_t ID3MetadataEvent::getTimestampOffset ( ) const

Get timestampOffset.

Returns
timestampOffset value

Definition at line 1331 of file AampEvent.cpp.

◆ getPresentationTime()

uint64_t ID3MetadataEvent::getPresentationTime ( ) const

Get presentationTime.

Returns
presentationTime value

Definition at line 1321 of file AampEvent.cpp.

◆ getSchemeIdUri()

const std::string & ID3MetadataEvent::getSchemeIdUri ( ) const

Get schemeIdUri.

Returns
schemeIdUri value

Definition at line 1341 of file AampEvent.cpp.

◆ getValue()

const std::string & ID3MetadataEvent::getValue ( ) const

Get value.

Returns
schemeIdUri value

Definition at line 1351 of file AampEvent.cpp.

Field Documentation

◆ mMetadata

std::vector<uint8_t> ID3MetadataEvent::mMetadata
private

ID3 Metadata content

Definition at line 1816 of file AampEvent.h.


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