EMIPLIB
Public Member Functions

MIPRTPReceiveMessage Class Reference

In this message, data received using the RTP protocol can be stored. More...

#include <miprtpmessage.h>

Inheritance diagram for MIPRTPReceiveMessage:
Inheritance graph
[legend]
Collaboration diagram for MIPRTPReceiveMessage:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MIPRTPReceiveMessage (jrtplib::RTPPacket *pPack, const uint8_t *pCName, size_t cnameLength, bool deletePacket=true, jrtplib::RTPSession *pSess=0)
 Constructs a message containing received RTP data.
const jrtplib::RTPPacket * getPacket () const
 Returns the received packet.
const uint8_t * getCName () const
 Returns a pointer to the CNAME data of the sender of this packet.
size_t getCNameLength () const
 Returns the length of the CNAME data of the sender of this packet.
MIPTime getJitter () const
 Returns the jitter for this source, as set by the MIPRTPReceiveMessage::setJitter function.
void setJitter (MIPTime t)
 Sets the jitter information for the source of this packet.
real_t getTimestampUnit () const
 Returns the timestamp unit for the data in the packet, as set by MIPRTPReceiveMessage::setTimestampUnit.
void setTimestampUnit (real_t unit)
 Sets the timestamp unit for the data in the packet.
real_t getTimestampUnitEstimate () const
 Returns the timestamp unit estimate for the data in the packet, as set by MIPRTPReceiveMessage::setTimestampUnitEstimate.
void setTimestampUnitEstimate (real_t unit)
 Sets the timestamp unit for the data in the packet.
bool isTimingInfoSet () const
 Returns true if the wallclock time - RTP timestamp relation was set.
void setTimingInfo (MIPTime t, uint32_t timestamp)
 Sets the wallclock time - RTP timestamp relation.
bool getTimingInfo (MIPTime *t, uint32_t *timestamp) const
 If available, the wallclock time - RTP timestamp relation is filled in.
void setSourceID (uint64_t sourceID)
 Stores the source ID which should be used further on.
uint64_t getSourceID () const
 Returns the source ID which should be used further on.

Detailed Description

Using this message, received RTP data can be transferred. This class depends on the JRTPLIB RTPPacket class.


Constructor & Destructor Documentation

MIPRTPReceiveMessage::MIPRTPReceiveMessage ( jrtplib::RTPPacket *  pPack,
const uint8_t *  pCName,
size_t  cnameLength,
bool  deletePacket = true,
jrtplib::RTPSession *  pSess = 0 
) [inline]

This constructor creates message containing received RTP data.

Parameters:
pPackThe received RTP packet.
pCNameThe CNAME of the source of this packet. Note that this is not null-terminated.
cnameLengthThe length of the CNAME of the source of this packet.
deletePacketFlag indicating if pPack should be deleted when this message is destroyed.
pSessPointer to the RTPSession instance from which the RTPPacket originated. If not null, this RTPSession's DeletePacket member function will be used to deallocate the RTPPacket memory.

Member Function Documentation

const uint8_t* MIPRTPReceiveMessage::getCName ( ) const [inline]
size_t MIPRTPReceiveMessage::getCNameLength ( ) const [inline]
MIPTime MIPRTPReceiveMessage::getJitter ( ) const [inline]
const jrtplib::RTPPacket* MIPRTPReceiveMessage::getPacket ( ) const [inline]
uint64_t MIPRTPReceiveMessage::getSourceID ( ) const [inline]
real_t MIPRTPReceiveMessage::getTimestampUnit ( ) const [inline]
real_t MIPRTPReceiveMessage::getTimestampUnitEstimate ( ) const [inline]
bool MIPRTPReceiveMessage::getTimingInfo ( MIPTime t,
uint32_t *  timestamp 
) const [inline]
bool MIPRTPReceiveMessage::isTimingInfoSet ( ) const [inline]
void MIPRTPReceiveMessage::setJitter ( MIPTime  t) [inline]
void MIPRTPReceiveMessage::setSourceID ( uint64_t  sourceID) [inline]
void MIPRTPReceiveMessage::setTimestampUnit ( real_t  unit) [inline]
void MIPRTPReceiveMessage::setTimestampUnitEstimate ( real_t  unit) [inline]
void MIPRTPReceiveMessage::setTimingInfo ( MIPTime  t,
uint32_t  timestamp 
) [inline]

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