RDK Documentation (Open Sourced RDK Components)
EmsgBox Class Reference

Class for ISO BMFF EMSG Box. More...

#include <isobmffbox.h>

Inheritance diagram for EmsgBox:
Inheritance graph
Collaboration diagram for EmsgBox:
Collaboration graph

Public Member Functions

 EmsgBox (uint32_t sz, uint32_t tScale, uint32_t evtDur, uint32_t _id)
 EmsgBox constructor.
 
 EmsgBox (FullBox &fbox, uint32_t tScale, uint32_t evtDur, uint32_t _id, uint64_t presTime, uint32_t presTimeDelta)
 EmsgBox constructor.
 
 ~EmsgBox ()
 EmsgBox dtor.
 
 EmsgBox (const EmsgBox &)=delete
 EmsgBox copy constructor.
 
EmsgBoxoperator= (const EmsgBox &)=delete
 EmsgBox =operator overloading.
 
void setTimeScale (uint32_t tScale)
 Set TimeScale value. More...
 
uint32_t getTimeScale ()
 Get schemeIdUri. More...
 
void setEventDuration (uint32_t evtDur)
 Set eventDuration value. More...
 
uint32_t getEventDuration ()
 Get eventDuration. More...
 
void setId (uint32_t _id)
 Set id. More...
 
uint32_t getId ()
 Get id. More...
 
void setPresentationTimeDelta (uint32_t presTimeDelta)
 Set presentationTimeDelta. More...
 
uint32_t getPresentationTimeDelta ()
 Get presentationTimeDelta. More...
 
void setPresentationTime (uint64_t presTime)
 Set presentationTime. More...
 
uint64_t getPresentationTime ()
 Get presentationTime. More...
 
void setSchemeIdUri (uint8_t *schemeIdURI)
 Set schemeIdUri. More...
 
uint8_t * getSchemeIdUri ()
 Get schemeIdUri. More...
 
void setValue (uint8_t *schemeIdValue)
 Set value. More...
 
uint8_t * getValue ()
 Get value. More...
 
void setMessage (uint8_t *message, uint32_t len)
 Set Message. More...
 
uint8_t * getMessage ()
 Get Message. More...
 
uint32_t getMessageLen ()
 Get Message length. More...
 
- Public Member Functions inherited from FullBox
 FullBox (uint32_t sz, const char btype[4], uint8_t ver, uint32_t f)
 FullBox constructor. More...
 
- Public Member Functions inherited from Box
 Box (uint32_t sz, const char btype[4])
 Box constructor. More...
 
virtual ~Box ()
 Box destructor.
 
void setOffset (uint32_t os)
 Set box's offset from the beginning of the buffer. More...
 
uint32_t getOffset () const
 Get box offset. More...
 
virtual bool hasChildren ()
 To check if box has any child boxes. More...
 
virtual const std::vector< Box * > * getChildren ()
 Get children of this box. More...
 
uint32_t getSize () const
 Get box size. More...
 
const char * getType ()
 Get box type. More...
 
const char * getBoxType () const
 Get box type. More...
 

Static Public Member Functions

static EmsgBoxconstructEmsgBox (uint32_t sz, uint8_t *ptr)
 Static function to construct a EmsgBox object. More...
 
- Static Public Member Functions inherited from Box
static BoxconstructBox (uint8_t *hdr, uint32_t maxSz, AampLogManager *mLOgObj=NULL, bool correctBoxSize=false, int newTrackId=-1)
 

Private Attributes

uint32_t timeScale
 
uint32_t eventDuration
 
uint32_t id
 
uint32_t presentationTimeDelta
 
uint64_t presentationTime
 
uint8_t * schemeIdUri
 
uint8_t * value
 
uint8_t * messageData
 
uint32_t messageLen
 

Additional Inherited Members

- Static Public Attributes inherited from Box
static constexpr const char * FTYP = "ftyp"
 
static constexpr const char * MOOV = "moov"
 
static constexpr const char * MVHD = "mvhd"
 
static constexpr const char * TRAK = "trak"
 
static constexpr const char * MDIA = "mdia"
 
static constexpr const char * MDHD = "mdhd"
 
static constexpr const char * EMSG = "emsg"
 
static constexpr const char * MOOF = "moof"
 
static constexpr const char * TFHD = "tfhd"
 
static constexpr const char * TRAF = "traf"
 
static constexpr const char * TFDT = "tfdt"
 
static constexpr const char * TRUN = "trun"
 
static constexpr const char * MDAT = "mdat"
 
static constexpr const char * TKHD = "tkhd"
 
static constexpr const char * STYP = "styp"
 
static constexpr const char * SIDX = "sidx"
 
static constexpr const char * PRFT = "prft"
 
- Protected Attributes inherited from FullBox
uint8_t version
 
uint32_t flags
 

yes

Class for ISO BMFF EMSG Box.

Definition at line 472 of file isobmffbox.h.

Member Function Documentation

◆ setTimeScale()

EmsgBox::setTimeScale ( uint32_t  tScale)

Set TimeScale value.

Parameters
[in]tScale- TimeScale value
Returns
void

Definition at line 542 of file isobmffbox.cpp.

◆ getTimeScale()

EmsgBox::getTimeScale ( )

Get schemeIdUri.

Returns
TimeScale value

Definition at line 550 of file isobmffbox.cpp.

◆ setEventDuration()

EmsgBox::setEventDuration ( uint32_t  evtDur)

Set eventDuration value.

Parameters
[in]evtDur- eventDuration value
Returns
void

Definition at line 558 of file isobmffbox.cpp.

◆ getEventDuration()

EmsgBox::getEventDuration ( )

Get eventDuration.

Returns
eventDuration value

Definition at line 566 of file isobmffbox.cpp.

◆ setId()

EmsgBox::setId ( uint32_t  _id)

Set id.

Parameters
[in]_id- id
Returns
void

Definition at line 574 of file isobmffbox.cpp.

◆ getId()

EmsgBox::getId ( )

Get id.

Returns
id value

Definition at line 582 of file isobmffbox.cpp.

◆ setPresentationTimeDelta()

EmsgBox::setPresentationTimeDelta ( uint32_t  presTimeDelta)

Set presentationTimeDelta.

Parameters
[in]presTimeDelta- presTimeDelta
Returns
void

Definition at line 590 of file isobmffbox.cpp.

◆ getPresentationTimeDelta()

EmsgBox::getPresentationTimeDelta ( )

Get presentationTimeDelta.

Returns
presentationTimeDelta value

Definition at line 598 of file isobmffbox.cpp.

◆ setPresentationTime()

EmsgBox::setPresentationTime ( uint64_t  presTime)

Set presentationTime.

Parameters
[in]presTime- presTime
Returns
void

Definition at line 606 of file isobmffbox.cpp.

◆ getPresentationTime()

EmsgBox::getPresentationTime ( )

Get presentationTime.

Returns
presentationTime value

Definition at line 614 of file isobmffbox.cpp.

◆ setSchemeIdUri()

EmsgBox::setSchemeIdUri ( uint8_t *  schemeIdURI)

Set schemeIdUri.

Parameters
[in]schemeIdUri- schemeIdUri pointer
Returns
void

Definition at line 622 of file isobmffbox.cpp.

◆ getSchemeIdUri()

EmsgBox::getSchemeIdUri ( )

Get schemeIdUri.

Returns
schemeIdUri value

Definition at line 630 of file isobmffbox.cpp.

◆ setValue()

EmsgBox::setValue ( uint8_t *  schemeIdValue)

Set value.

Parameters
[in]value- value pointer
Returns
void

Definition at line 638 of file isobmffbox.cpp.

◆ getValue()

EmsgBox::getValue ( )

Get value.

Returns
schemeIdUri value

Definition at line 646 of file isobmffbox.cpp.

◆ setMessage()

EmsgBox::setMessage ( uint8_t *  message,
uint32_t  len 
)

Set Message.

Parameters
[in]message- Message pointer
[in]len- Message length
Returns
void

Definition at line 654 of file isobmffbox.cpp.

◆ getMessage()

EmsgBox::getMessage ( )

Get Message.

Returns
messageData

Definition at line 663 of file isobmffbox.cpp.

◆ getMessageLen()

EmsgBox::getMessageLen ( )

Get Message length.

Returns
messageLen

Definition at line 671 of file isobmffbox.cpp.

◆ constructEmsgBox()

EmsgBox::constructEmsgBox ( uint32_t  sz,
uint8_t *  ptr 
)
static

Static function to construct a EmsgBox object.

Parameters
[in]sz- box size
[in]ptr- pointer to box
Returns
newly constructed EmsgBox object

Definition at line 679 of file isobmffbox.cpp.


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