class JGRtpMediaList
|
A List of Jingle RTP data payloads. More... |
|
|
Public Types
- enum Media { MediaMissing = -1,
MediaUnknown = 0,
Audio = 1,
}
Public Methods
- inline JGRtpMediaList (Media m = MediaMissing, bool cryptoMandatory = false)
- inline Media media () const
- inline void add (const char* id, const char* name, const char* clockrate,
const char* bitrate, const char* synonym)
- JGRtpMedia* findMedia (const String& id)
- JGRtpMedia* findSynonym (const String& value) const
- XMLElement* toXML (bool telEvent = true) const
- void fromXML (XMLElement* xml)
- bool createList (String& dest, bool synonym, const char* sep = ",")
Public Members
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:
m | Media type as enumeration
|
cryptoMandatory | True 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:
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
|
JGRtpMedia* findMedia (const String& id)
| findMedia |
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)
| findSynonym |
[const]
Find a data payload by its synonym
Parameters:
value | The 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:
telEvent | True 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:
xml | The source XML element
|
bool createList (String& dest, bool synonym, const char* sep = ",")
| createList |
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
static TokenDict s_media[]
| s_media[] |
bool m_cryptoMandatory
| m_cryptoMandatory |
ObjList m_cryptoLocal
| m_cryptoLocal |
ObjList m_cryptoRemote
| m_cryptoRemote |
Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54. |