Main Page   Class Hierarchy   Compound List   Compound Members  

sdpSessionDescription Class Reference

#include <sdpContainers.h>

List of all members.

Public Methods

 sdpSessionDescription ()
 sdpSessionDescription constructor.

sdpAttributeListattributeList ()
 Returns the sdpAttributeList object.

sdpBandwidthbandwidth ()
 Returns the sdpBandwidth object.

void clear ()
 Clears value.

sdpConnectionconnection ()
 Returns the sdpConnection object.

sdpEmailAddressListemailAddressList ()
 Returns the sdpEmailAddressList object.

sdpEncryptionKeyencryptionKey ()
 Returns the sdpEncryptionKey object.

int exportSDP (char *a_SDP, int a_MaxLen, bool a_Debug=false)
 Exports a fully qualified SDP to a string.

void importSDP (const char *a_SDP, bool a_Debug)
 Imports a fully qualified SDP from a string.

sdpMediaDescriptionListmediaDescriptionList ()
 Returns the sdpMediaDescriptionList object.

sdpOriginorigin ()
 Returns the sdpOrigin object.

sdpPhoneNumberListphoneNumberList ()
 Returns the sdpPhoneNumberList object.

sdpSessionInformationsessionInformation ()
 Returns the sdpSessionInformation object.

sdpSessionNamesessionName ()
 Returns the sdpSessionName object.

sdpTimeDescriptionListtimeDescriptionList ()
 Returns the sdpTimeDescriptionList object.

sdpTimezoneAdjustmenttimezoneAdjustment ()
 Returns the sdpTimezoneAdjustment object.

sdpURIuri ()
 Returns the sdpURI object.

sdpVersionversion ()
 Returns the sdpVersion object.


Detailed Description

Contains sdpAttribute, sdpBandwidth, sdpConnection, sdpEmailAddress, sdpEncryptionKey, sdpMediaDescription, sdpOrigin, sdpPhoneNumber, sdpSessionInformation, sdpSessionName, sdpTimeDescription, sdpTimezoneAdjustment, sdpURI, and sdpVersion objects.


Constructor & Destructor Documentation

sdpSessionDescription::sdpSessionDescription  
 

sdpSessionDescription constructor.

Creates a blank sdpSessionDescription object


Member Function Documentation

sdpAttributeList * sdpSessionDescription::attributeList  
 

Returns the sdpAttributeList object.

This method returns the sdpAttributeList object contained in the sdpSessionDescription object

Returns:
sdpAttributeList* - pointer to the sdpAttributeList contained in sdpSessionDescription

sdpBandwidth * sdpSessionDescription::bandwidth  
 

Returns the sdpBandwidth object.

This method returns the sdpBandwidth object contained in the sdpSessionDescription object

Returns:
sdpBandwidth* - pointer to the sdpBandwidth contained in the sdpSessionDescription

void sdpSessionDescription::clear  
 

Clears value.

This method clears the sdpSessionDescription object and all of the objects it contains.

sdpConnection * sdpSessionDescription::connection  
 

Returns the sdpConnection object.

This method returns the sdpConnection object contained in the sdpSessionDescription object

Returns:
sdpConnection* - pointer to the sdpConnection contained in the sdpSessionDescription

sdpEmailAddressList * sdpSessionDescription::emailAddressList  
 

Returns the sdpEmailAddressList object.

This method returns the sdpEmailAddressList object contained in the sdpSessionDescription object

Returns:
sdpEmailAddressList* - pointer to the sdpEmailAddressList contained in sdpSessionDescription

sdpEncryptionKey * sdpSessionDescription::encryptionKey  
 

Returns the sdpEncryptionKey object.

This method returns the sdpEncryptionKey object contained in the sdpSessionDescription object

Returns:
sdpEncryptionKey* - pointer to the sdpEncryptionKey contained in the sdpSessionDescription

int sdpSessionDescription::exportSDP char *    a_SDP,
int    a_MaxLen,
bool    a_Debug = false
 

Exports a fully qualified SDP to a string.

This method exports a fully qualified SDP string based on the values of the contained objects.

Parameters:
a_SDP  - a preallocated buffer to store the generated SDP
a_MaxLen  - size of allocated buffer
a_Debug  - true for debug mode which will generate stdout debug information
Returns:
returns 0 for success, -1 for failure if input buffer size is not large enough.

void sdpSessionDescription::importSDP const char *    a_SDP,
bool    a_Debug
 

Imports a fully qualified SDP from a string.

This method imports a fully qualified SDP from a string initializes the contains of the objects appropriately.

Parameters:
a_SDP  - a buffer containing the fully qualified SDP
a_Debug  - true for debug mode which will generate stdout debug information
Returns:
returns 0 for success, -1 for failure if input buffer size is not large enough.

sdpMediaDescriptionList * sdpSessionDescription::mediaDescriptionList  
 

Returns the sdpMediaDescriptionList object.

This method returns the sdpMediaDescriptionList object contained in the sdpSessionDescription object

Returns:
sdpAttributeList* - pointer to the sdpMediaDescriptionList contained in sdpSessionDescription

sdpOrigin * sdpSessionDescription::origin  
 

Returns the sdpOrigin object.

This method returns the sdpOrigin object contained in the sdpSessionDescription object

Returns:
int - number of sdpOrigins contained in the sdpSessionDescription

sdpPhoneNumberList * sdpSessionDescription::phoneNumberList  
 

Returns the sdpPhoneNumberList object.

This method returns the sdpPhoneNumberList object contained in the sdpSessionDescription object

Returns:
sdpAttributeList* - pointer to the sdpPhoneNumberList contained in sdpSessionDescription

sdpSessionInformation * sdpSessionDescription::sessionInformation  
 

Returns the sdpSessionInformation object.

This method returns the sdpSessionInformation object contained in the sdpSessionDescription object

Returns:
sdpSessionInformation* - pointer to the sdpSessionInformation contained in the sdpSessionDescription

sdpSessionName * sdpSessionDescription::sessionName  
 

Returns the sdpSessionName object.

This method returns the sdpName object contained in the sdpSessionDescription object

Returns:
sdpSessionName* - pointer to the sdpSessionName contained in the sdpSessionDescription

sdpTimeDescriptionList * sdpSessionDescription::timeDescriptionList  
 

Returns the sdpTimeDescriptionList object.

This method returns the sdpTimeDescriptionList object contained in the sdpSessionDescription object

Returns:
sdpAttributeList* - pointer to the sdpTimeDescriptionList contained in sdpSessionDescription

sdpTimezoneAdjustment * sdpSessionDescription::timezoneAdjustment  
 

Returns the sdpTimezoneAdjustment object.

This method returns the sdpTimezoneAdjustment object contained in the sdpSessionDescription object

Returns:
sdpTimezoneAdjustment* - pointer to the sdpTimezoneAdjustment contained in the sdpSessionDescription

sdpURI * sdpSessionDescription::uri  
 

Returns the sdpURI object.

This method returns the sdpURI object contained in the sdpSessionDescription object

Returns:
sdpURI* - pointer to the sdpURI contained in the sdpSessionDescription

sdpVersion * sdpSessionDescription::version  
 

Returns the sdpVersion object.

This method returns the sdpVersion object contained in the sdpSessionDescription object

Returns:
sdpVersion* - pointer to the sdpVersion contained in the sdpSessionDescription


The documentation for this class was generated from the following files:
Generated on Fri Feb 17 18:18:12 2006 for SDP API by doxygen1.2.18