class JGSessionContent

A Jingle session content. More...

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

Public Types

Public Methods

Public Static Methods

Public Members


Detailed Description

This class holds a Jingle content negotiated during a session It can be built from a received xml element and it can build an xml element from itself

enum Type { Unknown = -1, UnknownFileTransfer = -2, RtpIceUdp = 1, RtpRawUdp = 2, FileBSBOffer = 3, FileBSBRequest = 4, }

Type

Enumeration of content type

enum Senders { SendUnknown = 0, SendBoth = 1, SendInitiator = 2, SendResponder = 3 }

Senders

Enumeration values for the 'senders' attribute (required)

enum Creator { CreatorUnknown = 0, CreatorInitiator = 1, CreatorResponder = 2 }

Creator

Enumeration values for the 'creator' attribute (required)

 JGSessionContent (Type t, const char* name, Senders senders, Creator creator, const char* disposition = 0)

JGSessionContent

Constructor

Parameters:
tContent type as enumeration
nameContent name
sendersContent senders as enumeration
creatorContent creator as enumeration
dispositionOptional content disposition (defauls to 'session' if empty)

inline Type  type ()

type

[const]

Get the content type

Returns: Content type as enumeration

inline Senders  senders ()

senders

[const]

Get the senders

Returns: Senders as enumeration

inline Creator  creator ()

creator

[const]

Get the content creator

Returns: Content creator as enumeration

inline bool  isValidAudio ()

isValidAudio

[const]

Check if this content is a valid audio one: it's media list type is Audio and the payload list is not empty

Returns: True if this content can be used for audio purposes

const String&  toString ()

toString

[const virtual]

Get the name of this content

Reimplemented from GenObject.

inline bool  isSession ()

isSession

[const]

Check if the content disposition is session XEP-0166: true if disposition is missing

Returns: True if this content should be processed at session level

inline bool  isEarlyMedia ()

isEarlyMedia

[const]

Check if the content disposition is early media

Returns: True if this content is an early media one

inline void  setEarlyMedia ()

setEarlyMedia

Set this content's disposition to early media

XMLElement*  toXml (bool minimum, bool addDesc, bool addTrans, bool addCandidates, bool addAuth)

toXml

[const]

Build a 'content' XML element from this object

Parameters:
minimumMinimum data (only creator and name)
addDescTrue to add the description child
addTransTrue to add the transport child
addCandidatesTrue to add the transport candidate children
addAuthRtpIceUdp only: add auth data

Returns: Valid XMLElement pointer

JGSessionContent*  fromXml (XMLElement* xml, XMPPError::Type& err, String& error)

fromXml

[static]

Decode 'content' element attributes

Parameters:
xmlThe XML element
errThe error on failure
errorError text to be sent on failure

Returns: Valid JGSessionContent pointer on success

static TokenDict s_senders[]

s_senders[]

static TokenDict s_creator[]

s_creator[]

JGRtpMediaList m_rtpMedia

m_rtpMedia

JGRtpCandidates m_rtpLocalCandidates

m_rtpLocalCandidates

JGRtpCandidates m_rtpRemoteCandidates

m_rtpRemoteCandidates

NamedList m_fileTransfer

m_fileTransfer


Generated by: paulc on bussard on Wed Oct 21 01:57:30 2009, using kdoc 2.0a54.