ccRTP 2.1.2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Static Protected Attributes
DynamicPayloadFormat Class Reference

Dynamic payload format objects. More...

#include <formats.h>

Inheritance diagram for DynamicPayloadFormat:
Inheritance graph
[legend]
Collaboration diagram for DynamicPayloadFormat:
Collaboration graph
[legend]

Public Member Functions

 DynamicPayloadFormat (PayloadType type, uint32 rate)
 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 = 8000
 

Detailed Description

Dynamic payload format objects.

Class of payload formats objects for payload types dynamically negotiated. Because these payloads do not have a fix RTP clock rate assigned, it must be specified to the constructor. This class will be used by applications that support dynamic payload negotiation.

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

Definition at line 234 of file formats.h.

Constructor & Destructor Documentation

DynamicPayloadFormat::DynamicPayloadFormat ( PayloadType  type,
uint32  rate 
)

Constructor.

Builds a dynamic payload format from payload numeric identifier and the corresponding RTP clock rate.

Parameters
typepayload type numeric identifier.
rateRTP clock rate.

Definition at line 102 of file rtppkt.cpp.

Member Function Documentation

PayloadType PayloadFormat::getPayloadType ( ) const
inlineinherited

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
inlineinherited

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)
inlineprotectedinherited

Set payload type numeric identifier carried in RTP packets.

Parameters
ptpayload type number.

Definition at line 169 of file formats.h.

void PayloadFormat::setRTPClockRate ( uint32  rate)
inlineprotectedinherited

Set RTP clock rate.

Parameters
rateRTP clock rate in Hz.

Definition at line 177 of file formats.h.

Field Documentation

NAMESPACE_COMMONCPP const uint32 PayloadFormat::defaultRTPClockRate = 8000
staticprotectedinherited

Definition at line 181 of file formats.h.


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