DTMF Class Reference

An abstraction of a Jingle DTMF element, of XEP-0181. More...

#include <jingledtmf.h>

Inherits Plugin.

Inheritance diagram for DTMF:

[legend]List of all members.

Public Member Functions
	DTMF (const std::string &code, int volume, int duration=100)
	DTMF (const Tag *tag)
virtual	~DTMF ()
const std::string &	code () const
int	volume () const
int	duration () const
virtual const std::string &	filterString () const
virtual Tag *	tag () const
virtual DTMF *	clone () const

---

Detailed Description

An abstraction of a Jingle DTMF element, of XEP-0181.

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.0

Definition at line 36 of file jingledtmf.h.

---

Constructor & Destructor Documentation

DTMF (  const std::string &  code, int  volume, int  duration = 100 )

Constructs a new DTMF object. Parameters: code  The DTMF code to generate. volume  The volume, ranges from 0 to -63 dBm0. Thus, a larger value denotes a lower volume. duration  The duration if the tone, in ms, defaults to 100ms. Definition at line 26 of file jingledtmf.cpp.

DTMF (  const Tag *  tag  )

Constructs a new DTMF object from the given Tag. Parameters: tag  The Tag to parse. Definition at line 31 of file jingledtmf.cpp.

virtual ~DTMF (   )  [inline, virtual]

Virtual destructor. Definition at line 57 of file jingledtmf.h.

---

Member Function Documentation

virtual DTMF* clone (   )  const [inline, virtual]

Creates an identical deep copy of the current instance. Returns: An identical deep copy of the current instance. Implements Plugin. Definition at line 84 of file jingledtmf.h.

const std::string& code (   )  const [inline]

Returns the DTMF tone to generate. Returns: The DTMF tone to generate. Definition at line 63 of file jingledtmf.h.

int duration (   )  const [inline]

Returns the duration of the tone. Returns: The duration of the tone. Definition at line 75 of file jingledtmf.h.

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 42 of file jingledtmf.cpp.

Tag * tag (   )  const [virtual]

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

int volume (   )  const [inline]

Returns the volume, ranges from 0 to -63 dBm0. Thus, a larger value denotes a lower volume. Returns: The volume. Definition at line 69 of file jingledtmf.h.

---

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

• jingledtmf.h
• jingledtmf.cpp

---