JGAudioList Class Reference

A List of Jingle data payloads. More...

#include <yatejingle.h>

Inheritance diagram for JGAudioList:

List of all members.

Public Member Functions
void	add (const char *id, const char *name, const char *clockrate, const char *bitrate, const char *synonym)
JGAudio *	findSynonym (const String &value)
XMLElement *	toXML (bool telEvent=true)
void	fromXML (XMLElement *xml)
bool	createList (String &dest, bool synonym, const char *sep=",")

---

Detailed Description

A List of Jingle data payloads.

Hold a list of data payloads

---

Member Function Documentation

void add	(	const char *	id,
		const char *	name,
		const char *	clockrate,
		const char *	bitrate,
		const char *	synonym
	)			[inline]

Append a new data payload

Parameters:

	id	The payload's id
	name	The payload's name
	clockrate	The payload's clockrate
	bitrate	The payload's bitrate
	synonym	The payload's synonym

References ObjList::append().

bool createList	(	String &	dest,
		bool	synonym,
		const char *	sep = ","
	)

Create a list from data payloads

Parameters:

	dest	Destination string
	synonym	True to create from synonyms, false to create from names
	sep	List item separator

Returns:

False if the list is empty

JGAudio* findSynonym

(

const String &

value

)

Find a data payload by its synonym

Parameters:

value

The value to compare with

Returns:

JGAudio pointer or 0 if not found

void fromXML

(

XMLElement *

xml

)

Fill this list from an XML element's children. Clear before attempting to fill

Parameters:

xml

The source XML element

XMLElement* toXML

(

bool

telEvent = true

)

Create a 'description' element and add payload children to it

Parameters:

telEvent

True to append a telephone event data payload

Returns:

Valid XMLElement pointer

---

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

• yatejingle.h