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 *channels, const char *synonym)
 JGRtpMedia (XMLElement *xml)
 JGRtpMedia (const JGRtpMedia &src)
void set (const char *id, const char *name, const char *clockrate, const char *channels, const char *synonym)
virtual const StringtoString () const
XMLElementtoXML () const
void fromXML (XMLElement *xml)

Public Attributes

String m_id
String m_name
String m_clockrate
String m_channels
String m_synonym
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 *  channels,
const char *  synonym 
) [inline]

Constructor. Fill this object from the given attributes

Parameters:
idThe 'id' attribute
nameThe 'name' attribute
clockrateThe 'clockrate' attribute
channelsThe 'channels' attribute
synonymThe 'synonym' 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 *  channels,
const char *  synonym 
) [inline]

Set the data

Parameters:
idThe 'id' attribute
nameThe 'name' attribute
clockrateThe 'clockrate' attribute
channelsThe 'channels' attribute
synonymThe 'synonym' attribute
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

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().

The Jingle name of this payload

Referenced by JGRtpMedia::JGRtpMedia().

List of optional parameters

A synonym of this payload's name

Referenced by JGRtpMedia::JGRtpMedia().


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