RTPPacket - A base class for both IncomingRTPPkt and OutgoingRTPPkt.

       Generated automatically by Doxygen for ccRTP from the source code.

                                                      ccRTP                                         RTPPacket(3)

RTPPacket::RTPPacket(constunsignedchar*constblock,size_tlen,boolduplicate=false)
       Constructor, construct a packet object given the memory zone its content (header and payload) is stored.
       Commonly used to build RTPPacket objects from incoming data.

       Parametersblock whole packet
           len total length (header + payload + padding) of the packet
           duplicate whether to memcopy the packet. At present, this feature is not used.

       Note
           used in IncomingRTPPkt.

   RTPPacket::RTPPacket(size_thdrlen,size_tplen,uint8paddinglen,CryptoContext*pcc=NULL)
       Construct a packet object without specifying its real content yet. Commonly used for outgoing packets.
       Header fields and payload must be filled in by another methods or by a derived constructor.

       Parametershdrlen length of the header (including CSRC and extension).
           plen payload length.
           paddinglen pad packet to a multiple of paddinglen

       Note
           used in OutgoingRTPPkt.

   virtualRTPPacket::~RTPPacket()[inline],[protected],[virtual]
       Destructor, free the buffer provided in the constructor.

       A base class for both IncomingRTPPkt and OutgoingRTPPkt.

       Provides common low level header structures and related methods. This class provides an interface that
       allows for partial and generic manipulation of RTP data packets. Values are returned in host order,
       except raw structures, which are returned as they are sent through the network.

       Author
           David Sugar dyfet@ostel.com

uint16RTPPacket::cachedSeqNum[protected]
       Packet sequence number in host order.

   uint32RTPPacket::cachedTimestamp[protected]
       Packet timestamp in host order (includes initial shift).

   uint32RTPPacket::payloadSize[protected]
       note: payload (not full packet) size.

   uint32RTPPacket::srtpDataOffset[protected]
       Offset into packet memory pointing to area for SRTP data. This offset points to the memory where the SRTP
       protect will store the authentication and MKI data.

   int32RTPPacket::srtpLength[protected]
       Lebgth of additional SRTP data. Covers the SRTP authentication and MKI data.

   uint32RTPPacket::total[protected]
       total length, including header, payload and padding

voidRTPPacket::endPacket()[protected]
       Free memory allocated for the packet.

   uint16RTPPacket::get2833Duration(void)[inline]
       Fetch 2833 duration field.

       Returns
           2833 duration in native host machine byte order.

   constuint32*RTPPacket::getCSRCs()const[inline]
       Get the 32-bit identifiers of the contributing sources for the packet as an array, of length
       getCSRCsCount().

       Returns
           An array of CSRC identifiers as they are in the packet (in network order).

   uint16RTPPacket::getCSRCsCount()const[inline]
       Get the number of contributing sources specified in the packet header.

   constunsignedchar*RTPPacket::getHdrExtContent()const[inline]
       Get the content of the header extension.

       Returns
           NULL if the packet has no header extension, otherwise a pointer to the packet header extension
           content.

   uint32RTPPacket::getHdrExtSize()const[inline]
       Get the length (in octets) of the data contained in the header extension. Note that this length does not
       include the four octets at the beginning of the header extension.

       Returns
           0 if the packet has no header extension, otherwise the length.

       Note
           0 is a valid value for this field, so RTPPacket::isExtended() should be used.

   uint16RTPPacket::getHdrExtUndefined()const[inline]
       Get the first 16 bits (in network order) of the header of the RTP header extension. Its meaning is
       undefined at this level.

       Returns
           0 if the packet has no header extension, otherwise the first 16 bits of the header extension, in
           network order.

       Note
           0 could be a valid value for the first 16 bits, in that case RTPPacket::isExtended() should be use.

   RTPFixedHeader*RTPPacket::getHeader()const[inline],[protected]
       Return low level structure for the header of the packet.

       Returns
           RTPFixedHeader pointer to the header of the packet.

   constRTPHeaderExt*RTPPacket::getHeaderExt()const[inline],[protected]
       Get a pointer to RTPHeaderExt pointing after the RTP header (fixed part plus contributing sources). No
       check for for the X bit is done.

       Returns
           header extension if present, garbage if not.

   uint32RTPPacket::getHeaderSize()const[inline]
       Get the length of the header, including contributing sources identifiers and header extension, if
       present.

       Returns
           number of octets.

   uint8RTPPacket::getPaddingSize()const[inline]
       Get the number of octets padding the end of the payload section.

       Returns
           Padding length in octets.

   constuint8*constRTPPacket::getPayload()const[inline]Returns
           pointer to the payload section of the packet.

   uint32RTPPacket::getPayloadSize()const[inline]Returns
           length of the payload section, in octets.

   PayloadTypeRTPPacket::getPayloadType()const[inline]Returns
           value of the PT header field.

   uint8RTPPacket::getProtocolVersion()const[inline]Returns
           RTP protocol version of packet.

   structRFC2833Payload*RTPPacket::getRaw2833Payload(void)[inline]
       Fetch a raw 2833 packet.

       Returns
           low level 2833 data structure.

   constunsignedchar*constRTPPacket::getRawPacket()const[inline]
       Get the raw packet as it will be sent through the network.

       Returns
           memory zone where the raw packet structure is stored in.

   uint32RTPPacket::getRawPacketSize()const[inline]
       Get the raw packet length, including header, extension, payload and padding.

       Returns
           size of the raw packet structure.

   uint32RTPPacket::getRawPacketSizeSrtp()const[inline]uint32RTPPacket::getRawTimestamp()const[inline],[protected]
       Obtain the absolute timestamp carried in the packet header.

       Returns
           32-bit timestamp in host order.

   uint16RTPPacket::getSeqNum()const[inline]Returns
           value of the sequence number header field, in host order.

   size_tRTPPacket::getSizeOfFixedHeader()const[inline]uint32RTPPacket::getTimestamp()const[inline]Returns
           packet timestamp in host order.

   boolRTPPacket::isExtended()const[inline]
       Ask whether the packet contains header extensions.

       Returns
           true if the header extension bit is 1.

   boolRTPPacket::isMarked()const[inline]
       Ask whether the packet is marked (for isntance, is a new talk spurt in some audio profiles).

       Returns
           true is the header marker bit is 1.

   boolRTPPacket::isPadded()const[inline]
       Ask whether the packet contains padding bytes at the end.

       Returns
           true if the header padding bit is 1.

   voidRTPPacket::reComputePayLength(boolpadding)
       Re-compute payload length. This recomputation may be necessary in case of SRTP. We need to decrypt the
       packet before we can handle padding. See takeInDataPacket in incqueue.cpp

       Parameterspadding If true then set padding flag in RTP header and re-compute payloadSize.

   voidRTPPacket::set2833Duration(uint16timestamp)[inline]
       Set 2833 duration field.

       Parameterstimestamp to use, native host machine byte order.

   voidRTPPacket::setbuffer(constvoid*src,size_tlen,size_tpos)[inline],[protected]voidRTPPacket::setExtension(boole)[inline],[protected]

       RTPPacket - A base class for both IncomingRTPPkt and OutgoingRTPPkt.

       #include <rtppkt.h>

       Inherited by IncomingRTPPkt, and OutgoingRTPPkt.

   Classes
       struct RFC2833Payload
           a structure defining RFC2833 Telephony events.

   PublicMemberFunctionsRTPPacket (const unsigned char *const block, size_t len, bool duplicate=false)
           Constructor, construct a packet object given the memory zone its content (header and payload) is
           stored.
       RTPPacket (size_t hdrlen, size_t plen, uint8 paddinglen, CryptoContext *pcc=NULL)
           Construct a packet object without specifying its real content yet.
       uint32 getHeaderSize () const
           Get the length of the header, including contributing sources identifiers and header extension, if
           present.
       const uint8 *const getPayload () const
       uint32 getPayloadSize () const
       PayloadTypegetPayloadType () const
       uint16 getSeqNum () const
       uint32 getTimestamp () const
       uint8 getProtocolVersion () const
       bool isPadded () const
           Ask whether the packet contains padding bytes at the end.
       uint8 getPaddingSize () const
           Get the number of octets padding the end of the payload section.
       bool isMarked () const
           Ask whether the packet is marked (for isntance, is a new talk spurt in some audio profiles).
       bool isExtended () const
           Ask whether the packet contains header extensions.
       uint16 getCSRCsCount () const
           Get the number of contributing sources specified in the packet header.
       const uint32 * getCSRCs () const
           Get the 32-bit identifiers of the contributing sources for the packet as an array, of length
           getCSRCsCount().
       uint16 getHdrExtUndefined () const
           Get the first 16 bits (in network order) of the header of the RTP header extension.
       uint32 getHdrExtSize () const
           Get the length (in octets) of the data contained in the header extension.
       const unsigned char * getHdrExtContent () const
           Get the content of the header extension.
       const unsigned char *const getRawPacket () const
           Get the raw packet as it will be sent through the network.
       uint32 getRawPacketSize () const
           Get the raw packet length, including header, extension, payload and padding.
       uint32 getRawPacketSizeSrtp () const
       size_t getSizeOfFixedHeader () const
       void reComputePayLength (bool padding)
           Re-compute payload length.
       struct RFC2833Payload * getRaw2833Payload (void)
           Fetch a raw 2833 packet.
       uint16 get2833Duration (void)
           Fetch 2833 duration field.
       void set2833Duration (uint16 timestamp)
           Set 2833 duration field.

   ProtectedMemberFunctions
       virtual ~RTPPacket ()
           Destructor, free the buffer provided in the constructor.
       void endPacket ()
           Free memory allocated for the packet.
       RTPFixedHeader * getHeader () const
           Return low level structure for the header of the packet.
       void setExtension (bool e)
       const RTPHeaderExt * getHeaderExt () const
           Get a pointer to RTPHeaderExt pointing after the RTP header (fixed part plus contributing sources).
       uint32 getRawTimestamp () const
           Obtain the absolute timestamp carried in the packet header.
       void setbuffer (const void *src, size_t len, size_t pos)

   ProtectedAttributes
       uint16 cachedSeqNum
           Packet sequence number in host order.
       uint32 cachedTimestamp
           Packet timestamp in host order (includes initial shift).
       uint32 srtpDataOffset
           Offset into packet memory pointing to area for SRTP data.
       int32 srtpLength
           Lebgth of additional SRTP data.
       uint32 total
           total length, including header, payload and padding
       uint32 payloadSize
           note: payload (not full packet) size.