An RTP transmission component which uses an RTPSession object (from the JRTPLIB library). More...

#include <miprtpcomponent.h>

Inheritance diagram for MIPRTPComponent:

Collaboration diagram for MIPRTPComponent:

Public Member Functions
bool	init (jrtplib::RTPSession *pSess, uint32_t silentTimestampIncrement=0)
	Initializes the component.
bool	destroy ()
	De-initializes the component.
void	setSilentSampleIncrement (uint32_t silentTimestampIncrement)
	See the MIPRTPComponent::init function for the meaning of this parameter.
void	setEnableSending (bool f)
	This flag controls if RTP packets are actually sent out, useful for a push-to-talk system for example (enabled by default).
Protected Member Functions
virtual uint64_t	getSourceID (const jrtplib::RTPPacket pPack, const jrtplib::RTPSourceData pSourceData) const
	Returns the source ID for the packet `pPack` belonging to source `pSourceData`.

Detailed Description

This component can transmit and receive RTP messages. It uses the JRTPLIB RTPSession class to accomplish this. The RTPSession instance needs to be initialized before the component can be used. Both MIPSYSTEMMESSAGE_TYPE_ISTIME messages and messages of type MIPRTPSendMessage are accepted. Messages produced by this component are of type MIPRTPReceiveMessage.

Member Function Documentation

bool MIPRTPComponent::destroy ( )

virtual uint64_t MIPRTPComponent::getSourceID	(	const jrtplib::RTPPacket *	pPack,
		const jrtplib::RTPSourceData *	pSourceData
	)		const `[protected, virtual]`

This virtual function returns the source ID when processing packet pPack originating from source pSourceData. By default, the 32-bit SSRC value is cast to a 64-bit value and is returned. In case this behaviour is not desirable, you can derive your own class from MIPRTPComponent and you can re-implement this function.

bool MIPRTPComponent::init	(	jrtplib::RTPSession *	pSess,
		uint32_t	silentTimestampIncrement = `0`
	)

With this function the component can be initialized.

Parameters:

pSess	The JRTPLIB RTPSession object which will be used to receive and transmit RTP packets.
silentTimestampIncrement	When using some kind of silence suppression or push-to-talk system, it is possible that during certain intervals no messages will reach this component. For these 'skipped' intervals, the RTP timestamp will be increased by this amount.

void MIPRTPComponent::setEnableSending ( bool f ) [inline]

void MIPRTPComponent::setSilentSampleIncrement ( uint32_t silentTimestampIncrement ) [inline]

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

src/components/transmission/miprtpcomponent.h

MIPRTPComponent Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation