Bayonne2 / Common C++ 2 Framework: DynamicPayloadFormat Class Reference

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 237 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: type payload type numeric identifier.

rate RTP clock rate.

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 140 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 151 of file formats.h.

void PayloadFormat::setPayloadType ( PayloadType pt )

inlineprotectedinherited

Set payload type numeric identifier carried in RTP packets.

Parameters: pt payload type number.

Definition at line 172 of file formats.h.

void PayloadFormat::setRTPClockRate ( uint32 rate )

inlineprotectedinherited

Set RTP clock rate.

Parameters: rate RTP clock rate in Hz.

Definition at line 180 of file formats.h.

Field Documentation

const uint32 PayloadFormat::defaultRTPClockRate

staticprotectedinherited

Definition at line 184 of file formats.h.

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

formats.h

Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by doxygen 1.8.6