jrtplib::RTCPSDESInfo Class Reference

The class RTCPSDESInfo is a container for RTCP SDES information. More...

#include <rtcpsdesinfo.h>

Inherits jrtplib::RTPMemoryObject.

Public Member Functions
	RTCPSDESInfo (RTPMemoryManager *mgr=0)
	Constructs an instance, optionally installing a memory manager. More...
void	Clear ()
	Clears all SDES information. More...
int	SetCNAME (const uint8_t *s, size_t l)
	Sets the SDES CNAME item to s with length l. More...
int	SetName (const uint8_t *s, size_t l)
	Sets the SDES name item to s with length l. More...
int	SetEMail (const uint8_t *s, size_t l)
	Sets the SDES e-mail item to s with length l. More...
int	SetPhone (const uint8_t *s, size_t l)
	Sets the SDES phone item to s with length l. More...
int	SetLocation (const uint8_t *s, size_t l)
	Sets the SDES location item to s with length l. More...
int	SetTool (const uint8_t *s, size_t l)
	Sets the SDES tool item to s with length l. More...
int	SetNote (const uint8_t *s, size_t l)
	Sets the SDES note item to s with length l. More...
int	SetPrivateValue (const uint8_t *prefix, size_t prefixlen, const uint8_t *value, size_t valuelen)
	Sets the entry for the prefix string specified by prefix with length prefixlen to contain the value string specified by value with length valuelen (if the maximum allowed number of prefixes was reached, the error code ERR_RTP_SDES_MAXPRIVITEMS is returned.
int	DeletePrivatePrefix (const uint8_t *s, size_t len)
	Deletes the entry for the prefix specified by s with length len. More...
uint8_t *	GetCNAME (size_t *len) const
	Returns the SDES CNAME item and stores its length in len. More...
uint8_t *	GetName (size_t *len) const
	Returns the SDES name item and stores its length in len. More...
uint8_t *	GetEMail (size_t *len) const
	Returns the SDES e-mail item and stores its length in len. More...
uint8_t *	GetPhone (size_t *len) const
	Returns the SDES phone item and stores its length in len. More...
uint8_t *	GetLocation (size_t *len) const
	Returns the SDES location item and stores its length in len. More...
uint8_t *	GetTool (size_t *len) const
	Returns the SDES tool item and stores its length in len. More...
uint8_t *	GetNote (size_t *len) const
	Returns the SDES note item and stores its length in len. More...
void	GotoFirstPrivateValue ()
	Starts the iteration over the stored SDES private item prefixes and their associated values. More...
bool	GetNextPrivateValue (uint8_t **prefix, size_t *prefixlen, uint8_t **value, size_t *valuelen)
	Returns SDES priv item information. More...
bool	GetPrivateValue (const uint8_t *prefix, size_t prefixlen, uint8_t **value, size_t *valuelen) const
	Returns SDES priv item information. More...

Detailed Description

Constructor & Destructor Documentation

jrtplib::RTCPSDESInfo::RTCPSDESInfo ( RTPMemoryManager *  mgr = 0 )

inline

Member Function Documentation

void jrtplib::RTCPSDESInfo::Clear

(

)

int jrtplib::RTCPSDESInfo::DeletePrivatePrefix	(	const uint8_t *	s,
		size_t	len
	)

uint8_t* jrtplib::RTCPSDESInfo::GetCNAME ( size_t *  len ) const

inline

Referenced by jrtplib::RTPSourceData::SDES_GetCNAME().

uint8_t* jrtplib::RTCPSDESInfo::GetEMail ( size_t *  len ) const

inline

Referenced by jrtplib::RTPSourceData::SDES_GetEMail().

uint8_t* jrtplib::RTCPSDESInfo::GetLocation ( size_t *  len ) const

inline

Referenced by jrtplib::RTPSourceData::SDES_GetLocation().

uint8_t* jrtplib::RTCPSDESInfo::GetName ( size_t *  len ) const

inline

Referenced by jrtplib::RTPSourceData::SDES_GetName().

bool jrtplib::RTCPSDESInfo::GetNextPrivateValue	(	uint8_t **	prefix,
		size_t *	prefixlen,
		uint8_t **	value,
		size_t *	valuelen
	)

If available, returns true and stores the next SDES private item prefix in prefix and its length in prefixlen. The associated value and its length are then stored in value and valuelen. Otherwise, it returns false.

Referenced by jrtplib::RTPSourceData::SDES_GetNextPrivateValue().

uint8_t* jrtplib::RTCPSDESInfo::GetNote ( size_t *  len ) const

inline

Referenced by jrtplib::RTPSourceData::SDES_GetNote().

uint8_t* jrtplib::RTCPSDESInfo::GetPhone ( size_t *  len ) const

inline

Referenced by jrtplib::RTPSourceData::SDES_GetPhone().

bool jrtplib::RTCPSDESInfo::GetPrivateValue	(	const uint8_t *	prefix,
		size_t	prefixlen,
		uint8_t **	value,
		size_t *	valuelen
	)		const

Looks for the entry which corresponds to the SDES private item prefix prefix with length prefixlen. If found, the function returns true and stores the associated value and its length in value and valuelen respectively.

Referenced by jrtplib::RTPSourceData::SDES_GetPrivateValue().

uint8_t* jrtplib::RTCPSDESInfo::GetTool ( size_t *  len ) const

inline

Referenced by jrtplib::RTPSourceData::SDES_GetTool().

void jrtplib::RTCPSDESInfo::GotoFirstPrivateValue

(

)

Referenced by jrtplib::RTPSourceData::SDES_GotoFirstPrivateValue().

int jrtplib::RTCPSDESInfo::SetCNAME ( const uint8_t *  s, size_t  l  )

inline

int jrtplib::RTCPSDESInfo::SetEMail ( const uint8_t *  s, size_t  l  )

inline

int jrtplib::RTCPSDESInfo::SetLocation ( const uint8_t *  s, size_t  l  )

inline

int jrtplib::RTCPSDESInfo::SetName ( const uint8_t *  s, size_t  l  )

inline

int jrtplib::RTCPSDESInfo::SetNote ( const uint8_t *  s, size_t  l  )

inline

int jrtplib::RTCPSDESInfo::SetPhone ( const uint8_t *  s, size_t  l  )

inline

int jrtplib::RTCPSDESInfo::SetTool ( const uint8_t *  s, size_t  l  )

inline

---

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

• src/rtcpsdesinfo.h