PayloadFormat - Base payload format class.

Author

       Generated automatically by Doxygen for ccRTP from the source code.

                                                      ccRTP                                     PayloadFormat(3)

Constructor & Destructor Documentation

PayloadFormat::PayloadFormat()[inline],[protected]PayloadFormat must not be used but as base class.

   virtualPayloadFormat::~PayloadFormat()[inline],[protected],[virtual]PayloadFormat must not be used but as base class.

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 fedemp@altern.org

Member Data Documentation

constuint32PayloadFormat::defaultRTPClockRate[static],[protected]

Member Function Documentation

PayloadTypePayloadFormat::getPayloadType()const[inline]
       Get payload type numeric identifier carried in RTP packets.

       Returns
           payload type numeric identifier.

   uint32PayloadFormat::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.

   voidPayloadFormat::setPayloadType(PayloadTypept)[inline],[protected]
       Set payload type numeric identifier carried in RTP packets.

       Parameterspt payload type number.

   voidPayloadFormat::setRTPClockRate(uint32rate)[inline],[protected]
       Set RTP clock rate.

       Parametersrate RTP clock rate in Hz.

Name

       PayloadFormat - Base payload format class.

Synopsis

       #include <formats.h>

       Inherited by DynamicPayloadFormat, and StaticPayloadFormat.

   PublicMemberFunctionsPayloadTypegetPayloadType () const
           Get payload type numeric identifier carried in RTP packets.
       uint32 getRTPClockRate () const
           Get RTP clock rate for this payload format.

   ProtectedMemberFunctionsPayloadFormat ()
           PayloadFormat must not be used but as base class.
       virtual ~PayloadFormat ()
           PayloadFormat must not be used but as base class.
       void setPayloadType (PayloadType pt)
           Set payload type numeric identifier carried in RTP packets.
       void setRTPClockRate (uint32 rate)
           Set RTP clock rate.

   StaticProtectedAttributes
       static const uint32 defaultRTPClockRate