Description Class Reference

An abstraction of a Jingle Description (Application Format). More...

#include <jingledescription.h>

Inherits Plugin.

Inherited by AudioRTP, and VideoRTP.

Inheritance diagram for Description:

[legend]List of all members.

Public Types
typedef std::list< const Description::Payload * >	PayloadList
Public Member Functions
	Description (const PayloadList &payload)
virtual	~Description ()
virtual const std::string &	filterString () const
virtual Tag *	tag () const
Protected Member Functions
virtual const std::string &	xmlns () const =0
Classes
class	Payload
	An abstraction of the payload-type> element used as child of the <description> element. More...

---

Detailed Description

An abstraction of a Jingle Description (Application Format).

You should not need to use this class directly. Use derived classes instead (AudioRTP, VideoRTP). See Jingle::Session for more info on Jingle.

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.0

Definition at line 39 of file jingledescription.h.

---

Member Typedef Documentation

typedef std::list<const Description::Payload*> PayloadList

A list of payloads. Definition at line 85 of file jingledescription.h.

---

Constructor & Destructor Documentation

Description (  const PayloadList &  payload  )  [inline]

Constructs a new Description (Application Format), adding the given payloads. Parameters: payload  A list payloads to include. Definition at line 92 of file jingledescription.h.

~Description (   )  [virtual]

Virtual destructor. Definition at line 47 of file jingledescription.cpp.

---

Member Function Documentation

const std::string & filterString (   )  const [virtual]

Returns an XPath expression that describes a path to child elements of a jingle element that a plugin handles. Returns: The plugin's filter string. Implements Plugin. Definition at line 62 of file jingledescription.cpp.

Tag * tag (   )  const [virtual]

Returns a Tag representation of the plugin. Returns: A Tag representation of the plugin. Implements Plugin. Definition at line 68 of file jingledescription.cpp.

virtual const std::string& xmlns (   )  const [protected, pure virtual]

Returns the Application Format's namespace. Returns: The namespace being handled by the Application Format. Implemented in AudioRTP, and VideoRTP.

---

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

• jingledescription.h
• jingledescription.cpp

---