Main Page   Class Hierarchy   Compound List   Compound Members  

sdpMedia Class Reference

#include <sdpElements.h>

Inheritance diagram for sdpMedia:

sdpElement List of all members.

Public Methods

int addFormat (const char *a_Format)
 Adds a Media Format value.

int deleteFormat (const char *a_Format)
 Deletes a Media Format value.

const char * getFormat (int a_Index)
 Returns the Media Format value.

const char * getMedia ()
 Returns the Media Type value.

int getNumFormat ()
 Returns the Number of Media Formats.

int getNumPorts ()
 Returns the Number of Ports.

long getPort ()
 Returns the Port.

const char * getTransport ()
 Returns the Transport.

void setMedia (const char *a_Media)
 Sets the Media Type value.

void setNumPorts (int a_NumPorts)
 Sets the Number of Ports.

void setPort (long a_Port)
 Sets the Port.

void setTransport (const char *a_Transport)
 Sets the Transport.

void clear ()
 Clears value.


Friends

class sdpSessionDescription

Detailed Description

Associated with a 'm=' entry in the media description.


Member Function Documentation

int sdpMedia::addFormat const char *    a_Format
 

Adds a Media Format value.

This method adds a new Media Format value to the sdpMedia object

Parameters:
a_Format  - new media format to add to the m= line
Returns:
int - total number of media formats now included in the sdpMedia object

void sdpMedia::clear  
 

Clears value.

This method clears the values stored in the corresponding object.

Returns:
void

Reimplemented from sdpElement.

int sdpMedia::deleteFormat const char *    a_Format
 

Deletes a Media Format value.

This method deletes a Media Format value from the sdpMedia object

Parameters:
a_Format  - existing media format to delete from the sdpMedia object
Returns:
int - total number of media formats now included in the sdpMedia object

const char * sdpMedia::getFormat int    a_Index
 

Returns the Media Format value.

This method returns the Media Format portion of the sdpMedia object

Parameters:
a_Index  - index of the media format to return. Index is 0 based.
Returns:
const char* - media format from the m= line

const char * sdpMedia::getMedia  
 

Returns the Media Type value.

This method returns the Media Type portion of the sdpMedia object

Returns:
const char* - media type from the m= line

int sdpMedia::getNumFormat  
 

Returns the Number of Media Formats.

This method returns the Number of Media Formats contained in the 'm=' line

Returns:
int - number of media formats include in the m= line

int sdpMedia::getNumPorts  
 

Returns the Number of Ports.

This method returns the Number of Ports defined in the 'm=' line

Returns:
int - number of ports defined in the m= line

long sdpMedia::getPort  
 

Returns the Port.

Returns the Port contained in the 'm=' line

Returns:
long - port defined in the m= line

const char * sdpMedia::getTransport  
 

Returns the Transport.

This method returns the Transport contained in the 'm=' line

Returns:
const char* - transport defined in the m= line

void sdpMedia::setMedia const char *    a_Media
 

Sets the Media Type value.

This method sets the Media Type portion of the sdpMedia object

Parameters:
a_Media  - media type for the m= line
Returns:
void

void sdpMedia::setNumPorts int    a_NumPorts
 

Sets the Number of Ports.

This method sets the Number of Ports contained in the 'm=' line

Parameters:
a_NumPorts  - number of ports for the m= line in a media description
Returns:
void

void sdpMedia::setPort long    a_Port
 

Sets the Port.

This method sets the Port contained in the 'm=' line

Parameters:
a_Port  - port used in the m= line in a media description
Returns:
void

void sdpMedia::setTransport const char *    a_Transport
 

Sets the Transport.

This method sets the Transport contained in the 'm=' line

Parameters:
a_Transport  - media transport for the m= line in a media description
Returns:
void


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