MIPRTPSendMessage Class Reference

This message describes data to be sent using RTP. More...

#include <miprtpmessage.h>

Inheritance diagram for MIPRTPSendMessage:

Collaboration diagram for MIPRTPSendMessage:

List of all members.

Public Member Functions
	MIPRTPSendMessage (uint8_t *pData, size_t dataLength, uint8_t payloadType, bool marker, uint32_t tsInc, bool deleteData=true)
	Constructs a message containing data to be sent using RTP.
const uint8_t *	getPayload () const
	Returns the payload data.
size_t	getPayloadLength () const
	Returns the payload length.
uint8_t	getPayloadType () const
	Returns the payload type.
bool	getMarker () const
	Returns the marker flag.
uint32_t	getTimestampIncrement () const
	Returns the amount with which the timestamp should be incremented.
void	setSamplingInstant (MIPTime t)
	Sets the time to which the first sample in the payload corresponds.
MIPTime	getSamplingInstant () const
	Returns the sampling instant as set by the MIPRTPSendMessage::setSamplingInstant function.

---

Detailed Description

This message is a container for data which has to be sent using the RTP protocol. The subtype of this message is MIPRTPMESSAGE_TYPE_SEND, defined in miprtpmessage.h

---

Constructor & Destructor Documentation

MIPRTPSendMessage::MIPRTPSendMessage	(	uint8_t *	pData,
		size_t	dataLength,
		uint8_t	payloadType,
		bool	marker,
		uint32_t	tsInc,
		bool	deleteData = true
	)		[inline]

This constructor creates a message with data to be sent using RTP.

Parameters:

pData	A pointer to the RTP payload.
dataLength	The length of the payload.
payloadType	The payload type.
marker	Flag indicating if the RTP marker bit should be set.
tsInc	The amount with which the timestamp should be incremented.
deleteData	Flag indicating if a delete call should be used on pData when the message is destroyed.

---

Member Function Documentation

bool MIPRTPSendMessage::getMarker

(

)

const [inline]

const uint8_t* MIPRTPSendMessage::getPayload

(

)

const [inline]

size_t MIPRTPSendMessage::getPayloadLength

(

)

const [inline]

uint8_t MIPRTPSendMessage::getPayloadType

(

)

const [inline]

MIPTime MIPRTPSendMessage::getSamplingInstant

(

)

const [inline]

uint32_t MIPRTPSendMessage::getTimestampIncrement

(

)

const [inline]

void MIPRTPSendMessage::setSamplingInstant

(

MIPTime

t

)

[inline]

---

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

• src/core/miprtpmessage.h