Yate
|
A list of RTP transport candidates. More...
#include <yatejingle.h>
Public Types | |
enum | Type { Unknown = -1, RtpIceUdp = 1, RtpRawUdp, RtpP2P } |
Public Member Functions | |
JGRtpCandidates (Type t=Unknown) | |
const char * | typeName () const |
void | generateIceAuth () |
void | generateOldIceAuth () |
JGRtpCandidate * | findByComponent (unsigned int component) |
XmlElement * | toXml (bool addCandidates, bool addAuth) const |
void | fromXml (XmlElement *element) |
Static Public Member Functions | |
static void | generateIceToken (String &dest, bool pwd, unsigned int max=0) |
static void | generateOldIceToken (String &dest) |
static const char * | typeName (int t, const char *defVal="unknown") |
Public Attributes | |
Type | m_type |
String | m_password |
String | m_ufrag |
Static Public Attributes | |
static const TokenDict | s_type [] |
A list of RTP transport candidates.
This class holds a list of jingle RTP transport candidates
enum Type |
Enumeration of transport types
JGRtpCandidates | ( | Type | t = Unknown | ) | [inline] |
Constructor. Fill this object from an XML element
t | The transport type |
JGRtpCandidate* findByComponent | ( | unsigned int | component | ) |
Find a candidate by its component value
component | The value to search |
void fromXml | ( | XmlElement * | element | ) |
Fill this object from a given element
element | The element |
void generateIceAuth | ( | ) | [inline] |
Fill password and ufrag data
static void generateIceToken | ( | String & | dest, |
bool | pwd, | ||
unsigned int | max = 0 |
||
) | [static] |
Generate a random password or username to be used with ICE-UDP transport
dest | Destination string |
pwd | True to generate a password, false to generate an username (ufrag) |
max | Maximum number of characters. The maxmimum value is 256. The minimum value is 22 for password and 4 for username |
void generateOldIceAuth | ( | ) | [inline] |
Fill password and ufrag data using old transport restrictions (16 bytes length)
static void generateOldIceToken | ( | String & | dest | ) | [static] |
Generate a random password or username to be used with old ICE-UDP transport
dest | Destination string |
XmlElement* toXml | ( | bool | addCandidates, |
bool | addAuth | ||
) | const |
Create a 'transport' element from this object. Add candidates
addCandidates | True to add the candidate children |
addAuth | RtpIceUdp only: add auth data |
const char* typeName | ( | ) | const [inline] |
Get the name of this list's type
References JGRtpCandidates::typeName().
Referenced by JGRtpCandidates::typeName().
static const char* typeName | ( | int | t, |
const char * | defVal = "unknown" |
||
) | [inline, static] |
Get the name associated with a list's type
t | The desired type |
defVal | Default value to return |
References TelEngine::lookup().