JGAudio Class Reference

A Jingle data payload. More...

#include <yatejingle.h>

Inheritance diagram for JGAudio:

GenObject

List of all members.

Public Member Functions

 JGAudio (const char *_id, const char *_name, const char *_clockrate, const char *_bitrate, const char *_synonym)
 JGAudio (XMLElement *xml)
 JGAudio (const JGAudio &src)
void set (const char *_id, const char *_name, const char *_clockrate, const char *_bitrate, const char *_synonym)
virtual const StringtoString () const
XMLElementtoXML ()
void fromXML (XMLElement *xml)

Public Attributes

String id
String name
String clockrate
String bitrate
String synonym


Detailed Description

A Jingle data payload.

This class holds a Jingle data payload description


Constructor & Destructor Documentation

JGAudio ( const char *  _id,
const char *  _name,
const char *  _clockrate,
const char *  _bitrate,
const char *  _synonym 
) [inline]

Constructor. Fill this object from the given attributes

Parameters:
_id The 'id' attribute
_name The 'name' attribute
_clockrate The 'clockrate' attribute
_bitrate The 'bitrate' attribute
_synonym The 'synonym' attribute

JGAudio ( XMLElement xml  )  [inline]

Constructor. Fill this object from an XML element

Parameters:
xml The element to fill from

JGAudio ( const JGAudio src  )  [inline]


Member Function Documentation

void set ( const char *  _id,
const char *  _name,
const char *  _clockrate,
const char *  _bitrate,
const char *  _synonym 
) [inline]

Set the data

Parameters:
_id The 'id' attribute
_name The 'name' attribute
_clockrate The 'clockrate' attribute
_bitrate The 'bitrate' attribute
_synonym The '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 (  ) 

Create a 'payload-type' element from this object

Returns:
Valid XMLElement pointer

void fromXML ( XMLElement xml  ) 

Fill this object from a given element

Parameters:
xml The element


Member Data Documentation

The numeric id of this payload

Referenced by JGAudio::JGAudio().

The Jingle name of this payload

Referenced by JGAudio::JGAudio().

The clockrate of this payload

Referenced by JGAudio::JGAudio().

The bitrate of this payload

Referenced by JGAudio::JGAudio().

A synonym of this payload's name

Referenced by JGAudio::JGAudio().


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

Generated on Mon Aug 11 16:17:54 2008 for Yate by  doxygen 1.5.6