class JGRtpMediaList

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

Full nameTelEngine::JGRtpMediaList
Definition#include <libs/yjabber/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 cryptoRequired = false)

JGRtpMediaList

Constructor

Parameters:
mMedia type as enumeration
cryptoRequiredTrue to require media encryption

inline  ~JGRtpMediaList ()

~JGRtpMediaList

Destructor

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* synonym = 0, const char* channels = 0, const char* pTime = 0, const char* maxPTime = 0)

add

Append a new data payload

Parameters:
idThe 'id' attribute
nameThe 'name' attribute
clockrateThe 'clockrate' attribute
synonymOptional application synonym for the payload
channelsOptional 'channels' attribute (the number of channels)
pTimeOptional "ptime" attribute (packet time)
maxPTimeOptional "maxptime" attribute (maximum packet time)

void  reset ()

reset

Reset the list and data

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

setMedia

Set media type and payloads from another list

Parameters:
srcMedia list to copy into this one
onlyOptional list of synonyms to set if found in src. Copy the whole list if this parameter is empty

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 ()

toXml

[const]

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

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

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

addTelEvent

[const]

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

Parameters:
xmlParent element
nameOptional event name. Defaults to set event name

static const TokenDict s_media[]

s_media[]

Media m_media

m_media

String m_ssrc

m_ssrc

NamedString* m_bandwidth

m_bandwidth

bool m_cryptoRequired

m_cryptoRequired

ObjList m_cryptoLocal

m_cryptoLocal

ObjList m_cryptoRemote

m_cryptoRemote

bool m_ready

m_ready

int m_telEvent

m_telEvent

String m_telEventName

m_telEventName

String m_telEventName2

m_telEventName2


Generated by: paulc on bussard on Fri Apr 1 18:17:10 2011, using kdoc 2.0a54.