Yate
Public Member Functions | Public Attributes
JGRtpMedia Class Reference

A Jingle data payload. More...

#include <yatejingle.h>

Inheritance diagram for JGRtpMedia:
GenObject

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 StringtoString () const
XmlElementtoXml () 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:
idThe 'id' attribute
nameThe 'name' attribute
clockrateThe 'clockrate' attribute
synonymApplication synonym for this payload
channelsOptional 'channels' attribute (the number of channels)
pTimeOptional "ptime" attribute (packet time)
maxPTimeOptional "maxptime" attribute (maximum packet time)
bitRateOptional "bitrate" attribute
JGRtpMedia ( XmlElement xml) [inline]

Constructor. Fill this object from an XML element

Parameters:
xmlThe element to fill from
JGRtpMedia ( const JGRtpMedia src) [inline]

Member Function Documentation

void fromXml ( XmlElement xml)

Fill this object from a given element

Parameters:
xmlThe 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:
idThe 'id' attribute
nameThe 'name' attribute
clockrateThe 'clockrate' attribute
synonymApplication synonym for this payload
channelsOptional 'channels' attribute (the number of channels)
pTimeOptional "ptime" attribute (packet time)
maxPTimeOptional "maxptime" attribute (maximum packet time)
bitRateOptional "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

Data bit rate

Referenced by JGRtpMedia::JGRtpMedia().

The number of channels

Referenced by JGRtpMedia::JGRtpMedia().

The clockrate of this payload

Referenced by JGRtpMedia::JGRtpMedia().

The numeric id of this payload

Referenced by JGRtpMedia::JGRtpMedia().

Maximum packet time

Referenced by JGRtpMedia::JGRtpMedia().

The Jingle name of this payload

Referenced by JGRtpMedia::JGRtpMedia().

List of optional parameters

Referenced by JGRtpMedia::JGRtpMedia().

Packet time

Referenced by JGRtpMedia::JGRtpMedia().

A synonym of this payload's name

Referenced by JGRtpMedia::JGRtpMedia().


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