Main Page   Class Hierarchy   Compound List   Compound Members  

sdpTimezoneAdjustment Class Reference

#include <sdpElements.h>

Inheritance diagram for sdpTimezoneAdjustment:

sdpElement List of all members.

Public Methods

int addAdjustment (const char *a_AdjustmentTime, const char *a_Offset)
 Adds a Timezone Adjustment value.

int deleteAdjustment (const char *a_AdjustmentTime, const char *a_Offset)
 Deletes a Timezone Adjustment value.

const char * getAdjustmentTime (int a_Index)
 Returns the Adjustment Time.

int getNumAdjustment ()
 Returns the Number of Timezone Adjustments.

const char * getOffset (int a_Index)
 Returns the Offset value.

void clear ()
 Clears value.


Friends

class sdpSessionDescription

Detailed Description

Associated with a 'z=' entry in the session description.


Member Function Documentation

int sdpTimezoneAdjustment::addAdjustment const char *    a_AdjustmentTime,
const char *    a_Offset
 

Adds a Timezone Adjustment value.

This method adds a new Timezone Adjustment value to the sdpTimezoneAdjustment object

Parameters:
a_AdjustmentTime  - new time to add to the z= line
a_Offset  - new offset to add to the z= line
Returns:
int - total number of timezone adjustments now included in the sdpMedia object

void sdpTimezoneAdjustment::clear  
 

Clears value.

This method clears the values stored in the corresponding object.

Returns:
void

Reimplemented from sdpElement.

int sdpTimezoneAdjustment::deleteAdjustment const char *    a_AdjustmentTime,
const char *    a_Offset
 

Deletes a Timezone Adjustment value.

This method deletes a Timezone Adjustment value from the sdpMedia object

Parameters:
a_AdjustmentTime  - existing adjustment time to delete from the sdpMedia object
a_Offset  - existing offset to delete from the sdpMedia object
Returns:
int - total number of timezone adjustments now included in the sdpMedia object

const char * sdpTimezoneAdjustment::getAdjustmentTime int    a_Index
 

Returns the Adjustment Time.

This method returns the Adjustment Time portion of the sdpTimezoneAdjustment object

Parameters:
a_Index  - index of adjustment time to retrieve. The index is 0 based.
Returns:
const char* - adjustment time from the z= line

int sdpTimezoneAdjustment::getNumAdjustment  
 

Returns the Number of Timezone Adjustments.

This method returns the Number of Timezone Adjustments contained in the 'z=' line

Returns:
int - number of timezone adjustments include in the z= line

const char * sdpTimezoneAdjustment::getOffset int    a_Index
 

Returns the Offset value.

This method returns the Offset value portion of the sdpTimezoneAdjustment object

Parameters:
a_Index  - index of offset to retrieve. The index is 0 based.
Returns:
const char* - offset from the z= line


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