PayloadFormat Class Reference

Base payload format class. More...

#include <formats.h>

Inheritance diagram for PayloadFormat:

Collaboration diagram for PayloadFormat:

Public Member Functions
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
	PayloadFormat ()
	PayloadFormat must not be used but as base class. More...
virtual	~PayloadFormat ()
	PayloadFormat must not be used but as base class. More...
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 = 8000

Private Attributes
PayloadType	payloadType
	Numeric identifier. More...
uint32	RTPClockRate
	Rate in Hz. More...

Detailed Description

Base payload format class.

The properties of a payload format that, as an RTP stack, ccRTP takes into account are the payload type (numeric identifier) and the RTP clock rate.

This is a base class for both StaticPayloadFormat and DynamicPayloadFormat.

Author

Federico Montesino Pouzols fedem.nosp@m.p@al.nosp@m.tern..nosp@m.org

Definition at line 129 of file formats.h.

Constructor & Destructor Documentation

PayloadFormat::PayloadFormat ( )

inlineprotected

PayloadFormat must not be used but as base class.

Definition at line 155 of file formats.h.

virtual PayloadFormat::~PayloadFormat ( )

inlineprotectedvirtual

PayloadFormat must not be used but as base class.

Definition at line 161 of file formats.h.

Member Function Documentation

PayloadType PayloadFormat::getPayloadType ( ) const

inline

Get payload type numeric identifier carried in RTP packets.

Returns

payload type numeric identifier.

Definition at line 137 of file formats.h.

uint32 PayloadFormat::getRTPClockRate ( ) const

inline

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.

Returns

RTP clock rate in Hz.

Definition at line 148 of file formats.h.

void PayloadFormat::setPayloadType ( PayloadType  pt )

inlineprotected

Set payload type numeric identifier carried in RTP packets.

Parameters

pt	payload type number.

Definition at line 169 of file formats.h.

void PayloadFormat::setRTPClockRate ( uint32  rate )

inlineprotected

Set RTP clock rate.

Parameters

rate	RTP clock rate in Hz.

Definition at line 177 of file formats.h.

Field Documentation

NAMESPACE_COMMONCPP const uint32 PayloadFormat::defaultRTPClockRate = 8000

staticprotected

Definition at line 181 of file formats.h.

PayloadType PayloadFormat::payloadType

private

Numeric identifier.

Definition at line 184 of file formats.h.

uint32 PayloadFormat::RTPClockRate

private

Rate in Hz.

Definition at line 185 of file formats.h.

---

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

• formats.h
• rtppkt.cpp