RTPPacket Class Reference

Represents an RTP Packet. More...

#include <rtppacket.h>

Inherits RTPMemoryObject.

Public Member Functions
	RTPPacket (RTPRawPacket &rawpack, RTPMemoryManager *mgr=0)
	Creates an RTPPacket instance based upon the data in rawpack, optionally installing a memory manager. More...
	RTPPacket (uint8_t payloadtype, const void *payloaddata, size_t payloadlen, uint16_t seqnr, uint32_t timestamp, uint32_t ssrc, bool gotmarker, uint8_t numcsrcs, const uint32_t *csrcs, bool gotextension, uint16_t extensionid, uint16_t extensionlen_numwords, const void *extensiondata, size_t maxpacksize, RTPMemoryManager *mgr=0)
	Creates a new buffer for an RTP packet and fills in the fields according to the specified parameters. More...
	RTPPacket (uint8_t payloadtype, const void *payloaddata, size_t payloadlen, uint16_t seqnr, uint32_t timestamp, uint32_t ssrc, bool gotmarker, uint8_t numcsrcs, const uint32_t *csrcs, bool gotextension, uint16_t extensionid, uint16_t extensionlen_numwords, const void *extensiondata, void *buffer, size_t buffersize, RTPMemoryManager *mgr=0)
	This constructor is similar to the other constructor, but here data is stored in an external buffer buffer with size buffersize. More...
int	GetCreationError () const
	If an error occurred in one of the constructors, this function returns the error code. More...
bool	HasExtension () const
	Returns true if the RTP packet has a header extension and false otherwise. More...
bool	HasMarker () const
	Returns true if the marker bit was set and false otherwise. More...
int	GetCSRCCount () const
	Returns the number of CSRCs contained in this packet. More...
uint32_t	GetCSRC (int num) const
	Returns a specific CSRC identifier. More...
uint8_t	GetPayloadType () const
	Returns the payload type of the packet. More...
uint32_t	GetExtendedSequenceNumber () const
	Returns the extended sequence number of the packet. More...
uint16_t	GetSequenceNumber () const
	Returns the sequence number of this packet. More...
void	SetExtendedSequenceNumber (uint32_t seq)
	Sets the extended sequence number of this packet to seq. More...
uint32_t	GetTimestamp () const
	Returns the timestamp of this packet. More...
uint32_t	GetSSRC () const
	Returns the SSRC identifier stored in this packet. More...
uint8_t *	GetPacketData () const
	Returns a pointer to the data of the entire packet. More...
uint8_t *	GetPayloadData () const
	Returns a pointer to the actual payload data. More...
size_t	GetPacketLength () const
	Returns the length of the entire packet. More...
size_t	GetPayloadLength () const
	Returns the payload length. More...
uint16_t	GetExtensionID () const
	If a header extension is present, this function returns the extension identifier. More...
uint8_t *	GetExtensionData () const
	Returns the length of the header extension data. More...
size_t	GetExtensionLength () const
	Returns the length of the header extension data. More...
RTPTime	GetReceiveTime () const
	Returns the time at which this packet was received. More...

Detailed Description

The RTPPacket class can be used to parse a RTPRawPacket instance if it represents RTP data. The class can also be used to create a new RTP packet according to the parameters specified by the user.

Constructor & Destructor Documentation

RTPPacket() [1/3]

RTPPacket::RTPPacket	(	RTPRawPacket &	rawpack,
		RTPMemoryManager *	mgr = 0
	)

Creates an RTPPacket instance based upon the data in rawpack, optionally installing a memory manager. If successful, the data is moved from the raw packet to the RTPPacket instance.

RTPPacket() [2/3]

RTPPacket::RTPPacket	(	uint8_t	payloadtype,
		const void *	payloaddata,
		size_t	payloadlen,
		uint16_t	seqnr,
		uint32_t	timestamp,
		uint32_t	ssrc,
		bool	gotmarker,
		uint8_t	numcsrcs,
		const uint32_t *	csrcs,
		bool	gotextension,
		uint16_t	extensionid,
		uint16_t	extensionlen_numwords,
		const void *	extensiondata,
		size_t	maxpacksize,
		RTPMemoryManager *	mgr = 0
	)

Creates a new buffer for an RTP packet and fills in the fields according to the specified parameters. If maxpacksize is not equal to zero, an error is generated if the total packet size would exceed maxpacksize. The arguments of the constructor are self-explanatory. Note that the size of a header extension is specified in a number of 32-bit words. A memory manager can be installed.

RTPPacket() [3/3]

RTPPacket::RTPPacket	(	uint8_t	payloadtype,
		const void *	payloaddata,
		size_t	payloadlen,
		uint16_t	seqnr,
		uint32_t	timestamp,
		uint32_t	ssrc,
		bool	gotmarker,
		uint8_t	numcsrcs,
		const uint32_t *	csrcs,
		bool	gotextension,
		uint16_t	extensionid,
		uint16_t	extensionlen_numwords,
		const void *	extensiondata,
		void *	buffer,
		size_t	buffersize,
		RTPMemoryManager *	mgr = 0
	)

Member Function Documentation

GetCreationError()

int RTPPacket::GetCreationError ( ) const

inline

GetCSRC()

uint32_t RTPPacket::GetCSRC

(

int

num

)

const

Returns a specific CSRC identifier. The parameter num can go from 0 to GetCSRCCount()-1.

Referenced by GetCSRCCount().

GetCSRCCount()

int RTPPacket::GetCSRCCount ( ) const

inline

References GetCSRC().

GetExtendedSequenceNumber()

uint32_t RTPPacket::GetExtendedSequenceNumber ( ) const

inline

Returns the extended sequence number of the packet. When the packet is just received, only the low $16$ bits will be set. The high 16 bits can be filled in later.

GetExtensionData()

uint8_t* RTPPacket::GetExtensionData ( ) const

inline

GetExtensionID()

uint16_t RTPPacket::GetExtensionID ( ) const

inline

GetExtensionLength()

size_t RTPPacket::GetExtensionLength ( ) const

inline

GetPacketData()

uint8_t* RTPPacket::GetPacketData ( ) const

inline

GetPacketLength()

size_t RTPPacket::GetPacketLength ( ) const

inline

GetPayloadData()

uint8_t* RTPPacket::GetPayloadData ( ) const

inline

GetPayloadLength()

size_t RTPPacket::GetPayloadLength ( ) const

inline

GetPayloadType()

uint8_t RTPPacket::GetPayloadType ( ) const

inline

GetReceiveTime()

RTPTime RTPPacket::GetReceiveTime ( ) const

inline

When an RTPPacket instance is created from an RTPRawPacket instance, the raw packet's reception time is stored in the RTPPacket instance. This function then retrieves that time.

GetSequenceNumber()

uint16_t RTPPacket::GetSequenceNumber ( ) const

inline

GetSSRC()

uint32_t RTPPacket::GetSSRC ( ) const

inline

GetTimestamp()

uint32_t RTPPacket::GetTimestamp ( ) const

inline

HasExtension()

bool RTPPacket::HasExtension ( ) const

inline

HasMarker()

bool RTPPacket::HasMarker ( ) const

inline

SetExtendedSequenceNumber()

void RTPPacket::SetExtendedSequenceNumber ( uint32_t  seq )

inline

---

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

• src/rtppacket.h