OPAL Version 3.10.4

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Public Member Functions | Protected Attributes
RTP_JitterBuffer Class Reference

`#include <jitter.h>`

Inheritance diagram for RTP_JitterBuffer:

## Public Member Functions

| RTP_JitterBuffer (RTP_Session &session, unsigned minJitterDelay, unsigned maxJitterDelay, unsigned timeUnits=8, PINDEX packetSize=2048)
| ~RTP_JitterBuffer ()
virtual PBoolean | OnReadPacket (RTP_DataFrame &frame)
Public Member Functions inherited from OpalJitterBufferThread
| OpalJitterBufferThread (unsigned minJitterDelay, unsigned maxJitterDelay, unsigned timeUnits=8, PINDEX packetSize=2048)
| ~OpalJitterBufferThread ()
virtual PBoolean | ReadData (RTP_DataFrame &frame)
Public Member Functions inherited from OpalJitterBuffer
| OpalJitterBuffer (unsigned minJitterDelay, unsigned maxJitterDelay, unsigned timeUnits=8, PINDEX packetSize=2048)
virtual | ~OpalJitterBuffer ()
void | PrintOn (ostream &strm) const
void | SetDelay (unsigned minJitterDelay, unsigned maxJitterDelay, PINDEX packetSize=2048)
void | Reset ()
virtual PBoolean | WriteData (const RTP_DataFrame &frame, const PTimeInterval &tick=0)
virtual PBoolean | ReadData (RTP_DataFrame &frame, const PTimeInterval &tick=0)
DWORD | GetCurrentJitterDelay () const
DWORD | GetMinJitterDelay () const
DWORD | GetMaxJitterDelay () const
unsigned | GetTimeUnits () const
DWORD | GetPacketsTooLate () const
DWORD | GetBufferOverruns () const
DWORD | GetMaxConsecutiveMarkerBits () const
void | SetMaxConsecutiveMarkerBits (DWORD max)

## Protected Attributes

RTP_Session & | m_session
Protected Attributes inherited from OpalJitterBufferThread
PThread * | m_jitterThread
bool | m_running
Protected Attributes inherited from OpalJitterBuffer
unsigned | m_timeUnits
PINDEX | m_packetSize
DWORD | m_minJitterDelay
| Minimum jitter delay in timestamp units.
DWORD | m_maxJitterDelay
| Maximum jitter delay in timestamp units.
int | m_jitterGrowTime
| Amaint to increase jitter delay by when get "late" packet.
DWORD | m_jitterShrinkPeriod
int | m_jitterShrinkTime
| Amount to shrink jitter delay by if consistently filled.
DWORD | m_silenceShrinkPeriod
| Reduce jitter delay is silent for this long.
int | m_silenceShrinkTime
| Amount to shrink jitter delay by if consistently silent.
DWORD | m_jitterDriftPeriod
int | m_currentJitterDelay
DWORD | m_packetsTooLate
DWORD | m_bufferOverruns
DWORD | m_consecutiveMarkerBits
DWORD | m_maxConsecutiveMarkerBits
DWORD | m_consecutiveLatePackets
DWORD | m_averageFrameTime
DWORD | m_lastTimestamp
DWORD | m_bufferFilledTime
DWORD | m_bufferLowTime
DWORD | m_bufferEmptiedTime
int | m_timestampDelta
enum OpalJitterBuffer:: { ... } | m_synchronisationState
FrameMap | m_frames
PMutex | m_bufferMutex
RTP_JitterBufferAnalyser * | m_analyser

## Additional Inherited Members

Protected Member Functions inherited from OpalJitterBufferThread
| PDECLARE_NOTIFIER (PThread, OpalJitterBufferThread, JitterThreadMain)
void | StartThread ()
| Internal function to be called from derived class constructor.
void | WaitForThreadTermination ()
| Internal function to be called from derived class destructor.
Protected Member Functions inherited from OpalJitterBuffer
DWORD | CalculateRequiredTimestamp (DWORD playOutTimestamp) const
bool | AdjustCurrentJitterDelay (int delta)

## Detailed Description

A descendant of the OpalJitterBuffer that reads RTP_DataFrame instances from the RTP_Sessions

## Constructor & Destructor Documentation

RTP_JitterBuffer::RTP_JitterBuffer | ( | RTP_Session & | session,
|  | unsigned | minJitterDelay,
|  | unsigned | maxJitterDelay,
|  | unsigned | timeUnits = `8`,
|  | PINDEX | packetSize = `2048`
| ) |  |

Parameters:

  session | Associated RTP session tor ead data from
  minJitterDelay | Minimum delay in RTP timestamp units
  maxJitterDelay | Maximum delay in RTP timestamp units
  timeUnits | Time units, usually 8 or 16
  packetSize | Max RTP packet size

RTP_JitterBuffer::~RTP_JitterBuffer | ( |  | ) |

## Member Function Documentation

virtual PBoolean RTP_JitterBuffer::OnReadPacket | ( | RTP_DataFrame & | frame | ) |

virtual

This class instance collects data from the outside world in this method.

Returns:
  true on successful read, false on faulty read.

Parameters:

  frame | Frame read from the RTP session

Implements OpalJitterBufferThread.

## Field Documentation

RTP_Session& RTP_JitterBuffer::m_session

protected

This class extracts data from the outside world by reading from this session variable

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

- jitter.h