JGRtpMediaList Class Reference
A List of Jingle RTP data payloads.
More...
#include <yatejingle.h>
List of all members.
Public Types |
enum | Media { MediaMissing = -1,
MediaUnknown = 0,
Audio = 1
} |
Public Member Functions |
| JGRtpMediaList (Media m=MediaMissing, bool cryptoMandatory=false) |
Media | media () const |
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 Attributes |
Media | m_media |
bool | m_cryptoMandatory |
ObjList | m_cryptoLocal |
ObjList | m_cryptoRemote |
bool | m_ready |
Static Public Attributes |
static TokenDict | s_media [] |
Detailed Description
A List of Jingle RTP data payloads.
Hold a list of RTP data payloads
Member Enumeration Documentation
Constructor & Destructor Documentation
Constructor
- Parameters:
-
| m | Media type as enumeration |
| cryptoMandatory | True to require media encryption |
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 |
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
Find a data payload by its id
- Parameters:
-
| id | Identifier of media to find |
- Returns:
- JGRtpMedia pointer or 0 if not found
Find a data payload by its synonym
- Parameters:
-
| value | The value to compare with |
- Returns:
- JGRtpMedia pointer or 0 if not found
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
Create a 'description' element and add payload children to it
- Parameters:
-
| telEvent | True to append a telephone event data payload |
- Returns:
- Valid XMLElement pointer
Member Data Documentation
Flag indicating wether media was negotiated
The list of media type names
The documentation for this class was generated from the following file: