ccRTP
Public Member Functions | Protected Member Functions | List of all members
RTPQueueBase Class Reference

A virtual base class for RTP queue hierarchies. More...

#include <queuebase.h>

Inheritance diagram for RTPQueueBase:
IncomingDataQueueBase OutgoingDataQueueBase IncomingDataQueue OutgoingDataQueue RTPDataQueue RTPDataQueue QueueRTCPManager RTPDuplex QueueRTCPManager RTPDuplex AVPQueue AVPQueue TRTPSessionBase< DualRTPUDPIPv4Channel, DualRTPUDPIPv4Channel, AVPQueue > TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue > TRTPSessionBase< DualRTPUDPIPv4Channel, DualRTPUDPIPv4Channel, AVPQueue > TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue > SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue > SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >

Public Member Functions

bool setPayloadFormat (const PayloadFormat &pf)
 Set the payload format in use, for timing and payload type identification purposes. More...
 
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). More...
 
PayloadType getCurrentPayloadType () const
 
timeval getInitialTime () const
 

Protected Member Functions

 RTPQueueBase (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. More...
 
virtual void renewLocalSSRC ()
 

Detailed Description

A virtual base class for RTP queue hierarchies.

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

Constructor & Destructor Documentation

◆ RTPQueueBase()

RTPQueueBase::RTPQueueBase ( uint32 *  ssrc = NULL)
protected
Parameters
ssrcIf not null, the local SSRC identifier for this session.

◆ ~RTPQueueBase()

virtual RTPQueueBase::~RTPQueueBase ( )
inlineprotectedvirtual

Member Function Documentation

◆ dispatchBYE()

virtual size_t RTPQueueBase::dispatchBYE ( const std::string &  )
inlineprotectedvirtual

A plugin point for posting of BYE messages.

Parameters
-reason to leave the RTP session.
Returns
number of octets sent.

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

◆ getCurrentPayloadType()

PayloadType RTPQueueBase::getCurrentPayloadType ( ) const
inline

◆ getCurrentRTPClockRate()

uint32 RTPQueueBase::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.
Examples
ccrtptest.cpp, and rtphello.cpp.

◆ getInitialTime()

timeval RTPQueueBase::getInitialTime ( ) const
inline

◆ getLocalSSRC()

uint32 RTPQueueBase::getLocalSSRC ( ) const
inline
Examples
rtphello.cpp.

◆ getLocalSSRCNetwork()

uint32 RTPQueueBase::getLocalSSRCNetwork ( ) const
inlineprotected

◆ renewLocalSSRC()

virtual void RTPQueueBase::renewLocalSSRC ( )
inlineprotectedvirtual

Reimplemented in IncomingDataQueue, and RTPDataQueue.

◆ setLocalSSRC()

void RTPQueueBase::setLocalSSRC ( uint32  ssrc)
inlineprotected

◆ setPayloadFormat()

bool RTPQueueBase::setPayloadFormat ( const PayloadFormat pf)
inline

Set the payload format in use, for timing and payload type identification purposes.

Parameters
pfpayload format to use from now on.
Returns
whether the payload format has been successfully set.
Examples
audiorx.cpp, audiotx.cpp, ccrtptest.cpp, rtpduphello.cpp, and rtphello.cpp.

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