JGRtpMediaList Class Reference

A List of Jingle RTP data payloads. More...

#include <yatejingle.h>

Inheritance diagram for JGRtpMediaList:

List of all members.

Public Types
enum	Media { MediaMissing = -1, MediaUnknown = 0, Audio = 1 }
Public Member Functions
	JGRtpMediaList (Media m=MediaMissing, bool cryptoRequired=false)
	~JGRtpMediaList ()
Media	media () const
void	add (const char *id, const char *name, const char *clockrate, const char *synonym=0, const char *channels=0, const char *pTime=0, const char *maxPTime=0)
void	reset ()
void	setMedia (const JGRtpMediaList &src, const String &only=String::empty())
JGRtpMedia *	findMedia (const String &id)
JGRtpMedia *	findSynonym (const String &value) const
XmlElement *	toXml () const
void	fromXml (XmlElement *xml)
bool	createList (String &dest, bool synonym, const char *sep=",")
void	addTelEvent (XmlElement *xml, const char *name=0) const
Public Attributes
Media	m_media
String	m_ssrc
NamedString *	m_bandwidth
bool	m_cryptoRequired
ObjList	m_cryptoLocal
ObjList	m_cryptoRemote
bool	m_ready
int	m_telEvent
String	m_telEventName
String	m_telEventName2
Static Public Attributes
static const TokenDict	s_media []

---

Detailed Description

A List of Jingle RTP data payloads.

Hold a list of RTP data payloads

---

Member Enumeration Documentation

enum Media

Media type enumeration

---

Constructor & Destructor Documentation

JGRtpMediaList	(	Media	m = MediaMissing,
		bool	cryptoRequired = false
	)		[inline]

Constructor

Parameters:

m	Media type as enumeration
cryptoRequired	True to require media encryption

~JGRtpMediaList

(

)

[inline]

Destructor

References TelEngine::destruct().

---

Member Function Documentation

void add	(	const char *	id,
		const char *	name,
		const char *	clockrate,
		const char *	synonym = 0,
		const char *	channels = 0,
		const char *	pTime = 0,
		const char *	maxPTime = 0
	)		[inline]

Append a new data payload

Parameters:

id	The 'id' attribute
name	The 'name' attribute
clockrate	The 'clockrate' attribute
synonym	Optional application synonym for the payload
channels	Optional 'channels' attribute (the number of channels)
pTime	Optional "ptime" attribute (packet time)
maxPTime	Optional "maxptime" attribute (maximum packet time)

void addTelEvent	(	XmlElement *	xml,
		const char *	name = 0
	)		const

Build and add telephone-event media child to a parent xml element. Add a second telephone event media child if set

Parameters:

xml	Parent element
name	Optional event name. Defaults to set event name

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

JGRtpMedia* findMedia

(

const String &

id

)

Find a data payload by its id

Parameters:

id	Identifier of media to find

Returns:

JGRtpMedia pointer or 0 if not found

JGRtpMedia* findSynonym

(

const String &

value

)

const

Find a data payload by its synonym

Parameters:

value

The value to compare with

Returns:

JGRtpMedia 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

Media media

(

)

const [inline]

Get the media type of the payloads owned by this list

Returns:

Media type as enumeration

void reset

(

)

Reset the list and data

void setMedia	(	const JGRtpMediaList &	src,
		const String &	only = String::empty()
	)

Set media type and payloads from another list

Parameters:

src	Media list to copy into this one
only	Optional list of synonyms to set if found in src. Copy the whole list if this parameter is empty

XmlElement* toXml

(

)

const

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

Returns:

Valid XmlElement pointer

---

Member Data Documentation

NamedString* m_bandwidth

Optional SDP media bandwith. The name of the string keeps the type ('bwtype') and its value keeps the actual bandwith

bool m_cryptoRequired

Crypto (SRTP) params

Media m_media

The media type

bool m_ready

Flag indicating wether media was negotiated

String m_ssrc

Synchronization source

int m_telEvent

Telephone event payload id

String m_telEventName

Telephone event payload name

String m_telEventName2

Second telephone event payload name

const TokenDict s_media[] [static]

The list of media type names

---

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

• yatejingle.h