class JGRtpMediaList

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

Full nameTelEngine::JGRtpMediaList
Definition#include <libs/yjingle/yatejingle.h>
InheritsTelEngine::ObjList [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Members


Detailed Description

Hold a list of RTP data payloads

enum Media { MediaMissing = -1, MediaUnknown = 0, Audio = 1, }

Media

Media type enumeration

inline  JGRtpMediaList (Media m = MediaMissing, bool cryptoMandatory = false)

JGRtpMediaList

Constructor

Parameters:
mMedia type as enumeration
cryptoMandatoryTrue to require media encryption

inline Media  media ()

media

[const]

Get the media type of the payloads owned by this list

Returns: Media type as enumeration

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

add

Append a new data payload

Parameters:
idThe payload's id
nameThe payload's name
clockrateThe payload's clockrate
bitrateThe payload's bitrate
synonymThe payload's synonym

JGRtpMedia*  findMedia (const String& id)

findMedia

Find a data payload by its id

Parameters:
idIdentifier of media to find

Returns: JGRtpMedia pointer or 0 if not found

JGRtpMedia*  findSynonym (const String& value)

findSynonym

[const]

Find a data payload by its synonym

Parameters:
valueThe value to compare with

Returns: JGRtpMedia pointer or 0 if not found

XMLElement*  toXML (bool telEvent = true)

toXML

[const]

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

Parameters:
telEventTrue to append a telephone event data payload

Returns: Valid XMLElement pointer

void  fromXML (XMLElement* xml)

fromXML

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

Parameters:
xmlThe source XML element

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

createList

Create a list from data payloads

Parameters:
destDestination string
synonymTrue to create from synonyms, false to create from names
sepList item separator

Returns: False if the list is empty

static TokenDict s_media[]

s_media[]

Media m_media

m_media

bool m_cryptoMandatory

m_cryptoMandatory

ObjList m_cryptoLocal

m_cryptoLocal

ObjList m_cryptoRemote

m_cryptoRemote

bool m_ready

m_ready


Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.