logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

RTPQueueBase - A virtual base class for RTP queue hierarchies.

Author

       Generated automatically by Doxygen for ccRTP from the source code.

                                                      ccRTP                                      RTPQueueBase(3)

Constructor & Destructor Documentation

RTPQueueBase::RTPQueueBase(uint32*ssrc=NULL)[protected]Parametersssrc If not null, the local SSRC identifier for this session.

   virtualRTPQueueBase::~RTPQueueBase()[inline],[protected],[virtual]

Detailed Description

       A virtual base class for RTP queue hierarchies.

       Author
           Federico Montesino Pouzols fedemp@altern.org

Member Function Documentation

virtualsize_tRTPQueueBase::dispatchBYE(conststd::string&)[inline],[protected],[virtual]
       A plugin point for posting of BYE messages.

       Parameters- reason to leave the RTP session.

       Returns
           number of octets sent.

       Reimplemented in QueueRTCPManager, TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>,
       TRTPSessionBase<DualRTPUDPIPv4Channel,DualRTPUDPIPv4Channel,AVPQueue>, and SingleThreadRTPSession<RTPDataChannel,RTCPChannel,ServiceQueue>.

   PayloadTypeRTPQueueBase::getCurrentPayloadType()const[inline]uint32RTPQueueBase::getCurrentRTPClockRate()const[inline]
       Get the clock rate in RTP clock units (for instance, 8000 units per second for PCMU, or 90000 units per
       second for MP2T). This value depends on what payload format has been selected using setPayloadFormat().

       Returns
           clock rate in RTP clock units.

       Examplesccrtptest.cpp, rtphello.cpp, and rtpsend.cpp.

   timevalRTPQueueBase::getInitialTime()const[inline]uint32RTPQueueBase::getLocalSSRC()const[inline]Examplesrtphello.cpp, rtplisten.cpp, and rtpsend.cpp.

   uint32RTPQueueBase::getLocalSSRCNetwork()const[inline],[protected]virtualvoidRTPQueueBase::renewLocalSSRC()[inline],[protected],[virtual]
       Reimplemented in RTPDataQueue, and IncomingDataQueue.

   voidRTPQueueBase::setLocalSSRC(uint32ssrc)[inline],[protected]boolRTPQueueBase::setPayloadFormat(constPayloadFormat&pf)[inline]
       Set the payload format in use, for timing and payload type identification purposes.

       Parameterspf payload format to use from now on.

       Returns
           whether the payload format has been successfully set.

       Examplesaudiorx.cpp, audiotx.cpp, ccrtptest.cpp, rtpduphello.cpp, rtphello.cpp, rtplisten.cpp, and
           rtpsend.cpp.

Name

       RTPQueueBase - A virtual base class for RTP queue hierarchies.

Synopsis

       #include <queuebase.h>

       Inherited by IncomingDataQueueBase [virtual], and OutgoingDataQueueBase [virtual].

   PublicMemberFunctions
       bool setPayloadFormat (const PayloadFormat &pf)
           Set the payload format in use, for timing and payload type identification purposes.
       uint32 getLocalSSRC () const
       uint32 getCurrentRTPClockRate () const
           Get the clock rate in RTP clock units (for instance, 8000 units per second for PCMU, or 90000 units
           per second for MP2T).
       PayloadTypegetCurrentPayloadType () const
       timeval getInitialTime () const

   ProtectedMemberFunctionsRTPQueueBase (uint32 *ssrc=NULL)
       void setLocalSSRC (uint32 ssrc)
       uint32 getLocalSSRCNetwork () const
       virtual ~RTPQueueBase ()
       virtual size_t dispatchBYE (const std::string &)
           A plugin point for posting of BYE messages.
       virtual void renewLocalSSRC ()

See Also