JGRtpMedia Class Reference

A Jingle data payload. More...

#include <yatejingle.h>

Inheritance diagram for JGRtpMedia:

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 Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual bool	alive () const
virtual void	destruct ()
virtual const String &	traceId () const
virtual void *	getObject (const String &name) const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)

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

Additional Inherited Members
Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)
static bool	getObjCounting ()
static void	setObjCounting (bool enable)
static NamedCounter *	getObjCounter (const String &name, bool create=true)
static ObjList &	getObjCounters ()

Detailed Description

A Jingle data payload.

This class holds a Jingle data payload description

Constructor & Destructor Documentation

JGRtpMedia() [1/3]

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

References m_params, and set().

Referenced by JGRtpMedia().

JGRtpMedia() [2/3]

JGRtpMedia ( XmlElement * xml )

inline

Constructor. Fill this object from an XML element

Parameters

xml	The element to fill from

References fromXml(), and m_params.

JGRtpMedia() [3/3]

JGRtpMedia ( const JGRtpMedia & src )

inline

Copy constructor

References JGRtpMedia(), m_bitRate, m_channels, m_clockrate, m_id, m_maxPTime, m_name, m_params, m_pTime, m_synonym, and set().

Member Function Documentation

fromXml()

void fromXml

(

XmlElement *

xml

)

Fill this object from a given element

Parameters

xml	The element

Referenced by JGRtpMedia().

set()

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 m_bitRate, m_channels, m_clockrate, m_id, m_maxPTime, m_name, m_params, m_pTime, and m_synonym.

Referenced by JGRtpMedia(), and JGRtpMedia().

toString()

virtual const String & toString ( ) const

inlinevirtual

Get the string repreasentation (id) of this payload

Returns

The string repreasentation (id) of this payload

Reimplemented from GenObject.

References m_id.

toXml()

XmlElement * toXml

(

)

const

Create a 'payload-type' element from this object

Returns

Valid XmlElement pointer

Member Data Documentation

m_bitRate

String m_bitRate

Data bit rate

Referenced by JGRtpMedia(), and set().

m_channels

String m_channels

The number of channels

Referenced by JGRtpMedia(), and set().

m_clockrate

String m_clockrate

The clockrate of this payload

Referenced by JGRtpMedia(), and set().

m_id

String m_id

The numeric id of this payload

Referenced by JGRtpMedia(), set(), and toString().

m_maxPTime

String m_maxPTime

Maximum packet time

Referenced by JGRtpMedia(), and set().

m_name

String m_name

The Jingle name of this payload

Referenced by JGRtpMedia(), and set().

m_params

NamedList m_params

List of optional parameters

Referenced by JGRtpMedia(), JGRtpMedia(), JGRtpMedia(), and set().

m_pTime

String m_pTime

Packet time

Referenced by JGRtpMedia(), and set().

m_synonym

String m_synonym

A synonym of this payload's name

Referenced by JGRtpMedia(), and set().

---

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

• yatejingle.h