JGRtpMedia Class Reference

A Jingle data payload. More...

#include <yatejingle.h>

Inheritance diagram for JGRtpMedia:

List of all members.

Public Member Functions
	JGRtpMedia (const char *id, const char *name, const char *clockrate, const char *synonym, const char *channels=0, const char *pTime=0, const char *maxPTime=0, const char *bitRate=0)
	JGRtpMedia (XmlElement *xml)
	JGRtpMedia (const JGRtpMedia &src)
void	set (const char *id, const char *name, const char *clockrate, const char *synonym=0, const char *channels=0, const char *pTime=0, const char *maxPTime=0, const char *bitRate=0)
virtual const String &	toString () const
XmlElement *	toXml () const
void	fromXml (XmlElement *xml)
Public Attributes
String	m_id
String	m_name
String	m_clockrate
String	m_synonym
String	m_channels
String	m_pTime
String	m_maxPTime
String	m_bitRate
NamedList	m_params

---

Detailed Description

A Jingle data payload.

This class holds a Jingle data payload description

---

Constructor & Destructor Documentation

JGRtpMedia	(	const char *	id,
		const char *	name,
		const char *	clockrate,
		const char *	synonym,
		const char *	channels = 0,
		const char *	pTime = 0,
		const char *	maxPTime = 0,
		const char *	bitRate = 0
	)		[inline]

Constructor. Fill this object from the given attributes

Parameters:

id	The 'id' attribute
name	The 'name' attribute
clockrate	The 'clockrate' attribute
synonym	Application synonym for this payload
channels	Optional 'channels' attribute (the number of channels)
pTime	Optional "ptime" attribute (packet time)
maxPTime	Optional "maxptime" attribute (maximum packet time)
bitRate	Optional "bitrate" attribute

JGRtpMedia

(

XmlElement *

xml

)

[inline]

Constructor. Fill this object from an XML element

Parameters:

xml	The element to fill from

JGRtpMedia

(

const JGRtpMedia &

src

)

[inline]

Copy constructor

References JGRtpMedia::m_bitRate, JGRtpMedia::m_channels, JGRtpMedia::m_clockrate, JGRtpMedia::m_id, JGRtpMedia::m_maxPTime, JGRtpMedia::m_name, JGRtpMedia::m_params, JGRtpMedia::m_pTime, and JGRtpMedia::m_synonym.

---

Member Function Documentation

void fromXml

(

XmlElement *

xml

)

Fill this object from a given element

Parameters:

xml	The element

void set	(	const char *	id,
		const char *	name,
		const char *	clockrate,
		const char *	synonym = 0,
		const char *	channels = 0,
		const char *	pTime = 0,
		const char *	maxPTime = 0,
		const char *	bitRate = 0
	)		[inline]

Set the data

Parameters:

id	The 'id' attribute
name	The 'name' attribute
clockrate	The 'clockrate' attribute
synonym	Application synonym for this payload
channels	Optional 'channels' attribute (the number of channels)
pTime	Optional "ptime" attribute (packet time)
maxPTime	Optional "maxptime" attribute (maximum packet time)
bitRate	Optional "bitrate" attribute

References NamedList::clearParams().

virtual const String& toString

(

)

const [inline, virtual]

Get the string repreasentation (id) of this payload

Returns:

The string repreasentation (id) of this payload

Reimplemented from GenObject.

XmlElement* toXml

(

)

const

Create a 'payload-type' element from this object

Returns:

Valid XmlElement pointer

---

Member Data Documentation

String m_bitRate

Data bit rate

Referenced by JGRtpMedia::JGRtpMedia().

String m_channels

The number of channels

Referenced by JGRtpMedia::JGRtpMedia().

String m_clockrate

The clockrate of this payload

Referenced by JGRtpMedia::JGRtpMedia().

String m_id

The numeric id of this payload

Referenced by JGRtpMedia::JGRtpMedia().

String m_maxPTime

Maximum packet time

Referenced by JGRtpMedia::JGRtpMedia().

String m_name

The Jingle name of this payload

Referenced by JGRtpMedia::JGRtpMedia().

NamedList m_params

List of optional parameters

Referenced by JGRtpMedia::JGRtpMedia().

String m_pTime

Packet time

Referenced by JGRtpMedia::JGRtpMedia().

String m_synonym

A synonym of this payload's name

Referenced by JGRtpMedia::JGRtpMedia().

---

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

• yatejingle.h