SH::SHRTPData Class Reference
[StreamHandlers]

#include <SHRTPData.h>

Inheritance diagram for SH::SHRTPData:

[legend]Collaboration diagram for SH::SHRTPData:

[legend]List of all members.

Public Member Functions
	SHRTPData (u_int32 timestamp, u_int16 extHdrType, MNRope *&extHdrPayload, SHPlainData *&data, struct timeval presTime, bool sync, bool consume_data)
	SHRTPData (const uchar_t *data, size_t len, size_t hdrlen)
virtual	~SHRTPData ()
virtual DataPtr	clone ()
virtual size_t	getByteSize () const
u_int32	getRTPTimestamp ()
u_int16	getExtHdrType ()
MNRope *	getExtHdrPayload ()
SHPlainData *	get_payloadData_asPlainData ()
virtual bool	isPlainData () const
virtual bool	isOrderedData () const
virtual bool	isRTPData () const
virtual bool	isDummyData () const
virtual bool	isSHRTPData () const
bool	hasBeenSynchronized () const
timeval	getPT () const
Static Public Attributes
const bool	Consume = true
const bool	DontConsume = false
Protected Attributes
u_int32	_rtpTimestamp
u_int16	_extHdrType
MNRope *	_extHdrPayload
SHPlainData *	_payloadData

---

Detailed Description

The multimedia data that is flowing from through the stream handlers has an abstract base class Data. The derived SHRTPData class is used to save RTP and synchronization information with the plain data. This information may be processed by following stream handlers according to their needs.

---

Constructor & Destructor Documentation

SH::SHRTPData::SHRTPData (  u_int32  timestamp, u_int16  extHdrType, MNRope *&  extHdrPayload, SHPlainData *&  data, struct timeval  presTime, bool  sync, bool  consume_data )

Constructor, takes several RTP relevant data and creates the SHRTP information from it. Parameters: timestamp  RTP timestamp. Useful for debugging purposes mainly. extHdrType  User-defined type of RTP extension header. extHdrPayload  (in/out) RTP extension header payload data  (in/out) (Decoded) payload data as SHPlainData. presTime  Presentation Time calculated from RTP / RTCP information as of type struct timeval. synchronized  Flag set to true if synchronization from RTCP has been exploited. Flag indicating if inout data should be deleted by this class or not.

SH::SHRTPData::SHRTPData (  const uchar_t *  data, size_t  len, size_t  hdrlen )

Constructor, a buffer and its length to create the RTP data packet. No useful implementation of this yet.

virtual SH::SHRTPData::~SHRTPData (   )  [virtual]

Destructor

---

Member Function Documentation

virtual DataPtr SH::SHRTPData::clone (   )  [virtual]

See also: Data Implements SH::Data.

SHPlainData* SH::SHRTPData::get_payloadData_asPlainData (   )

Retrieve payload data as of type SHPlainData. Unlike similar extract functions in other classes derived from SH::Data, the payload data is not deleted in the class. Returns: Pointer on payload data

virtual size_t SH::SHRTPData::getByteSize (   )  const [virtual]

Required by SH::Data. Delivers only the size of the included payload data. Implements SH::Data.

MNRope* SH::SHRTPData::getExtHdrPayload (   )

Retrieve RTP Extension header contents. Unlike the get in MNRTPPacket, this function returns a MNRope instead of uchar_t*. Returns: RTP extension header payload

u_int16 SH::SHRTPData::getExtHdrType (   )

struct timeval SH::SHRTPData::getPT (   )  const [inline]

u_int32 SH::SHRTPData::getRTPTimestamp (   )

bool SH::SHRTPData::hasBeenSynchronized (   )  const [inline]

virtual bool SH::SHRTPData::isDummyData (   )  const [inline, virtual]

See also: Data Implements SH::Data.

virtual bool SH::SHRTPData::isOrderedData (   )  const [inline, virtual]

See also: Data Implements SH::Data.

virtual bool SH::SHRTPData::isPlainData (   )  const [inline, virtual]

See also: Data Implements SH::Data.

virtual bool SH::SHRTPData::isRTPData (   )  const [inline, virtual]

See also: Data Implements SH::Data.

virtual bool SH::SHRTPData::isSHRTPData (   )  const [inline, virtual]

See also: Data Implements SH::Data.

---

Member Data Documentation

MNRope* SH::SHRTPData::_extHdrPayload [protected]

u_int16 SH::SHRTPData::_extHdrType [protected]

SHPlainData* SH::SHRTPData::_payloadData [protected]

u_int32 SH::SHRTPData::_rtpTimestamp [protected]

const bool SH::SHRTPData::Consume = true [static]

const bool SH::SHRTPData::DontConsume = false [static]

---

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

• SHRTPData.h

---