RTP_ControlFrame Class Reference

#include <rtp.h>

List of all members.

Public Types

 e_SenderReport = 200
 e_ReceiverReport
 e_SourceDescription
 e_Goodbye
 e_ApplDefined
 e_END
 e_CNAME
 e_NAME
 e_EMAIL
 e_PHONE
 e_LOC
 e_TOOL
 e_NOTE
 e_PRIV
 NumDescriptionTypes
enum  PayloadTypes {
  e_SenderReport = 200, e_ReceiverReport, e_SourceDescription, e_Goodbye,
  e_ApplDefined
}
enum  DescriptionTypes {
  e_END, e_CNAME, e_NAME, e_EMAIL,
  e_PHONE, e_LOC, e_TOOL, e_NOTE,
  e_PRIV, NumDescriptionTypes
}

Public Member Functions

 RTP_ControlFrame (PINDEX compoundSize=2048)
unsigned GetVersion () const
unsigned GetCount () const
void SetCount (unsigned count)
unsigned GetPayloadType () const
void SetPayloadType (unsigned t)
PINDEX GetPayloadSize () const
void SetPayloadSize (PINDEX sz)
BYTE * GetPayloadPtr () const
BOOL ReadNextCompound ()
BOOL WriteNextCompound ()
PINDEX GetCompoundSize () const
SourceDescriptionAddSourceDescription (DWORD src)
SourceDescription::ItemAddSourceDescriptionItem (SourceDescription &sdes, unsigned type, const PString &data)

Protected Attributes

PINDEX compoundOffset
PINDEX compoundSize

Classes

struct  ReceiverReport
struct  SenderReport
struct  SourceDescription


Detailed Description

An RTP control frame encapsulation.


Member Enumeration Documentation

enum RTP_ControlFrame::DescriptionTypes

Enumerator:
e_END 
e_CNAME 
e_NAME 
e_EMAIL 
e_PHONE 
e_LOC 
e_TOOL 
e_NOTE 
e_PRIV 
NumDescriptionTypes 

enum RTP_ControlFrame::PayloadTypes

Enumerator:
e_SenderReport 
e_ReceiverReport 
e_SourceDescription 
e_Goodbye 
e_ApplDefined 


Constructor & Destructor Documentation

RTP_ControlFrame::RTP_ControlFrame ( PINDEX  compoundSize = 2048  ) 


Member Function Documentation

SourceDescription& RTP_ControlFrame::AddSourceDescription ( DWORD  src  ) 

Parameters:
src  SSRC/CSRC identifier

SourceDescription::Item& RTP_ControlFrame::AddSourceDescriptionItem ( SourceDescription sdes,
unsigned  type,
const PString &  data 
)

Parameters:
sdes  SDES record to add item to
type  Description type
data  Data for description

PINDEX RTP_ControlFrame::GetCompoundSize (  )  const [inline]

unsigned RTP_ControlFrame::GetCount (  )  const [inline]

BYTE* RTP_ControlFrame::GetPayloadPtr (  )  const [inline]

PINDEX RTP_ControlFrame::GetPayloadSize (  )  const [inline]

unsigned RTP_ControlFrame::GetPayloadType (  )  const [inline]

unsigned RTP_ControlFrame::GetVersion (  )  const [inline]

BOOL RTP_ControlFrame::ReadNextCompound (  ) 

void RTP_ControlFrame::SetCount ( unsigned  count  ) 

void RTP_ControlFrame::SetPayloadSize ( PINDEX  sz  ) 

void RTP_ControlFrame::SetPayloadType ( unsigned  t  ) 

BOOL RTP_ControlFrame::WriteNextCompound (  ) 


Member Data Documentation

PINDEX RTP_ControlFrame::compoundOffset [protected]

PINDEX RTP_ControlFrame::compoundSize [protected]


The documentation for this class was generated from the following file:
Generated on Mon Sep 25 16:21:53 2006 for OPAL by  doxygen 1.4.7