class JGRtpMedia

A Jingle data payload. More...

Full nameTelEngine::JGRtpMedia
Definition#include <libs/yjabber/yatejingle.h>
InheritsTelEngine::GenObject [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Members


Detailed Description

This class holds a Jingle data payload description

inline  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

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

inline  JGRtpMedia (XmlElement* xml)

JGRtpMedia

Constructor. Fill this object from an XML element

Parameters:
xmlThe element to fill from

inline  JGRtpMedia (const JGRtpMedia& src)

JGRtpMedia

Copy constructor

inline 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)

set

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

const String&  toString ()

toString

[const virtual]

Get the string repreasentation (id) of this payload

Returns: The string repreasentation (id) of this payload

Reimplemented from GenObject.

XmlElement*  toXml ()

toXml

[const]

Create a 'payload-type' element from this object

Returns: Valid XmlElement pointer

void  fromXml (XmlElement* xml)

fromXml

Fill this object from a given element

Parameters:
xmlThe element

String m_id

m_id

String m_name

m_name

String m_clockrate

m_clockrate

String m_synonym

m_synonym

String m_channels

m_channels

String m_pTime

m_pTime

String m_maxPTime

m_maxPTime

String m_bitRate

m_bitRate

NamedList m_params

m_params


Generated by: paulc on bussard on Sun Oct 20 21:06:06 2013, using kdoc 2.0a54.