OPAL Version 3.10.4

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Public Types | Public Member Functions | Protected Attributes
RTP_DataFrame Class Reference

`#include <rtp.h>`

Inheritance diagram for RTP_DataFrame:

## Public Types

enum | { ProtocolVersion = 2, MinHeaderSize = 12, MaxMtuPayloadSize = (576-20-16-12) }
enum | PayloadTypes { PCMU, FS1016, G721, G726 = G721, GSM, G7231, DVI4_8k, DVI4_16k, LPC, PCMA, G722, L16_Stereo, L16_Mono, G723, CN, MPA, G728, DVI4_11k, DVI4_22k, G729, Cisco_CN, CelB = 25, JPEG, H261 = 31, MPV, MP2T, H263, T38 = 38, LastKnownPayloadType, DynamicBase = 96, MaxPayloadType = 127, IllegalPayloadType }

## Public Member Functions

| RTP_DataFrame (PINDEX payloadSize=0, PINDEX bufferSize=0)
| RTP_DataFrame (const BYTE *data, PINDEX len, PBoolean dynamic=true)
unsigned | GetVersion () const
PBoolean | GetExtension () const
void | SetExtension (PBoolean ext)
PBoolean | GetMarker () const
void | SetMarker (PBoolean m)
bool | GetPadding () const
void | SetPadding (bool v)
BYTE * | GetPaddingPtr () const
unsigned | GetPaddingSize () const
bool | SetPaddingSize (PINDEX sz)
PayloadTypes | GetPayloadType () const
void | SetPayloadType (PayloadTypes t)
WORD | GetSequenceNumber () const
void | SetSequenceNumber (WORD n)
DWORD | GetTimestamp () const
void | SetTimestamp (DWORD t)
DWORD | GetSyncSource () const
void | SetSyncSource (DWORD s)
PINDEX | GetContribSrcCount () const
DWORD | GetContribSource (PINDEX idx) const
void | SetContribSource (PINDEX idx, DWORD src)
PINDEX | GetHeaderSize () const
int | GetExtensionType () const
void | SetExtensionType (int type)
PINDEX | GetExtensionSizeDWORDs () const
bool | SetExtensionSizeDWORDs (PINDEX sz)
BYTE * | GetExtensionPtr () const
PINDEX | GetPayloadSize () const
bool | SetPayloadSize (PINDEX sz)
BYTE * | GetPayloadPtr () const
virtual PObject * | Clone () const
virtual void | PrintOn (ostream &strm) const
bool | SetPacketSize (PINDEX sz)

## Protected Attributes

PINDEX | m_headerSize
PINDEX | m_payloadSize
PINDEX | m_paddingSize

## Detailed Description

An RTP data frame encapsulation.

## Member Enumeration Documentation

anonymous enum

Enumerator:

  ProtocolVersion |
  MinHeaderSize |
  MaxMtuPayloadSize |

enum RTP_DataFrame::PayloadTypes

Enumerator:

  PCMU |
  FS1016 |
  G721 |
  G726 |
  GSM |
  G7231 |
  DVI4_8k |
  DVI4_16k |
  LPC |
  PCMA |
  G722 |
  L16_Stereo |
  L16_Mono |
  G723 |
  CN |
  MPA |
  G728 |
  DVI4_11k |
  DVI4_22k |
  G729 |
  Cisco_CN |
  CelB |
  JPEG |
  H261 |
  MPV |
  MP2T |
  H263 |
  T38 |
  LastKnownPayloadType |
  DynamicBase |
  MaxPayloadType |
  IllegalPayloadType |

## Constructor & Destructor Documentation

RTP_DataFrame::RTP_DataFrame | ( | PINDEX | payloadSize = `0`,
|  | PINDEX | bufferSize = `0`
| ) |  |

Referenced by Clone().

RTP_DataFrame::RTP_DataFrame | ( | const BYTE * | data,
|  | PINDEX | len,
|  | PBoolean | dynamic = `true`
| ) |  |

## Member Function Documentation

virtual PObject* RTP_DataFrame::Clone | ( |  | ) | const

inline virtual

References RTP_DataFrame().

DWORD RTP_DataFrame::GetContribSource | ( | PINDEX | idx | ) | const

PINDEX RTP_DataFrame::GetContribSrcCount | ( |  | ) | const

inline

PBoolean RTP_DataFrame::GetExtension | ( |  | ) | const

inline

BYTE* RTP_DataFrame::GetExtensionPtr | ( |  | ) | const

PINDEX RTP_DataFrame::GetExtensionSizeDWORDs | ( |  | ) | const

int RTP_DataFrame::GetExtensionType | ( |  | ) | const

PINDEX RTP_DataFrame::GetHeaderSize | ( |  | ) | const

inline

References m_headerSize.

PBoolean RTP_DataFrame::GetMarker | ( |  | ) | const

inline

bool RTP_DataFrame::GetPadding | ( |  | ) | const

inline

BYTE* RTP_DataFrame::GetPaddingPtr | ( |  | ) | const

inline

References m_headerSize, and m_payloadSize.

unsigned RTP_DataFrame::GetPaddingSize | ( |  | ) | const

inline

References m_paddingSize.

BYTE* RTP_DataFrame::GetPayloadPtr | ( |  | ) | const

inline

References m_headerSize.

Referenced by RTP_IMFrame::AsString().

PINDEX RTP_DataFrame::GetPayloadSize | ( |  | ) | const

inline

References m_payloadSize.

Referenced by RTP_IMFrame::AsString().

PayloadTypes RTP_DataFrame::GetPayloadType | ( |  | ) | const

inline

WORD RTP_DataFrame::GetSequenceNumber | ( |  | ) | const

inline

DWORD RTP_DataFrame::GetSyncSource | ( |  | ) | const

inline

DWORD RTP_DataFrame::GetTimestamp | ( |  | ) | const

inline

unsigned RTP_DataFrame::GetVersion | ( |  | ) | const

inline

virtual void RTP_DataFrame::PrintOn | ( | ostream & | strm | ) | const

virtual

void RTP_DataFrame::SetContribSource | ( | PINDEX | idx,
|  | DWORD | src
| ) |  |

void RTP_DataFrame::SetExtension | ( | PBoolean | ext | ) |

bool RTP_DataFrame::SetExtensionSizeDWORDs | ( | PINDEX | sz | ) |

void RTP_DataFrame::SetExtensionType | ( | int | type | ) |

void RTP_DataFrame::SetMarker | ( | PBoolean | m | ) |

bool RTP_DataFrame::SetPacketSize | ( | PINDEX | sz | ) |

void RTP_DataFrame::SetPadding | ( | bool | v | ) |

inline

bool RTP_DataFrame::SetPaddingSize | ( | PINDEX | sz | ) |

bool RTP_DataFrame::SetPayloadSize | ( | PINDEX | sz | ) |

void RTP_DataFrame::SetPayloadType | ( | PayloadTypes | t | ) |

void RTP_DataFrame::SetSequenceNumber | ( | WORD | n | ) |

inline

void RTP_DataFrame::SetSyncSource | ( | DWORD | s | ) |

inline

void RTP_DataFrame::SetTimestamp | ( | DWORD | t | ) |

inline

## Field Documentation

PINDEX RTP_DataFrame::m_headerSize

protected

Referenced by GetHeaderSize(), GetPaddingPtr(), and GetPayloadPtr().

PINDEX RTP_DataFrame::m_paddingSize

protected

Referenced by GetPaddingSize().

PINDEX RTP_DataFrame::m_payloadSize

protected

Referenced by GetPaddingPtr(), and GetPayloadSize().

The documentation for this class was generated from the following file:

- rtp.h