Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Static Protected Attributes | Static Private Attributes
StaticPayloadFormat Class Reference

Static payload format objects. More...

#include <formats.h>

Inheritance diagram for StaticPayloadFormat:
Inheritance graph
Collaboration diagram for StaticPayloadFormat:
Collaboration graph

Public Member Functions

 StaticPayloadFormat (StaticPayloadType type)
 Constructor. More...
PayloadType getPayloadType () const
 Get payload type numeric identifier carried in RTP packets. More...
uint32 getRTPClockRate () const
 Get RTP clock rate for this payload format. More...

Protected Member Functions

void setPayloadType (PayloadType pt)
 Set payload type numeric identifier carried in RTP packets. More...
void setRTPClockRate (uint32 rate)
 Set RTP clock rate. More...

Static Protected Attributes

static const uint32 defaultRTPClockRate

Static Private Attributes

static uint32 staticAudioTypesRates [lastStaticAudioPayloadType-firstStaticPayloadType+1]
 RTP clock rate for static payload types. More...

Detailed Description

Static payload format objects.

Class of payload formats objects for payload types statically assigned. Because these payloads have an RTP clock rate assigned, it is not specified to the constructor. A call to StaticPayloadFormat(sptPCMU) will set the proper clock rate and any other parameters for that static payload type.

Federico Montesino Pouzols

Definition at line 203 of file formats.h.

Constructor & Destructor Documentation

StaticPayloadFormat::StaticPayloadFormat ( StaticPayloadType  type)


Builds a payload format from a static payload binding identifier, assigning the numeric identifier and RTP clock rate statically bounded.

typeNumeric identifier in the range 0-96.
some identifiers are reserved.

Member Function Documentation

PayloadType PayloadFormat::getPayloadType ( ) const

Get payload type numeric identifier carried in RTP packets.

payload type numeric identifier.

Definition at line 140 of file formats.h.

uint32 PayloadFormat::getRTPClockRate ( ) const

Get RTP clock rate for this payload format.

Note this method provides the RTP clock rate (for the timestamp in RTP data packets headers), which is not necessarily the same as the codec clock rate.

RTP clock rate in Hz.

Definition at line 151 of file formats.h.

void PayloadFormat::setPayloadType ( PayloadType  pt)

Set payload type numeric identifier carried in RTP packets.

ptpayload type number.

Definition at line 172 of file formats.h.

void PayloadFormat::setRTPClockRate ( uint32  rate)

Set RTP clock rate.

rateRTP clock rate in Hz.

Definition at line 180 of file formats.h.

Field Documentation

const uint32 PayloadFormat::defaultRTPClockRate

Definition at line 184 of file formats.h.

uint32 StaticPayloadFormat::staticAudioTypesRates[lastStaticAudioPayloadType-firstStaticPayloadType+1]

RTP clock rate for static payload types.

There is no need for a table like this for video types, since they all have 90000 Khz rate.

Definition at line 223 of file formats.h.

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