sipxmedialib  Version 3.3
Functions
ISenderReport.h File Reference
#include "rtcp/RtcpConfig.h"
#include "IBaseClass.h"
Include dependency graph for ISenderReport.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

virtual bool WasMediaSent (void)=0
 
virtual unsigned long FormatSenderReport (unsigned char *puchReportBuffer, unsigned long ulBufferSize)=0
 
virtual unsigned long ParseSenderReport (unsigned char *puchReportBuffer)=0
 

Function Documentation

virtual bool WasMediaSent ( void  )
pure virtual

Method Name: WasMediaSent

Inputs: None

Outputs: None

Returns: bool

Description: A method to determine whether media has been sent out since the last reporting period. This will determine whether a Sender Report or Receiver Report is in order.

Usage Notes:

virtual unsigned long FormatSenderReport ( unsigned char *  puchReportBuffer,
unsigned long  ulBufferSize 
)
pure virtual

Method Name: FormatSenderReport

Inputs: uint32_t ulBufferSize - Optional size defining the length allocated for the buffer

Outputs: unsigned char *puchReportBuffer - Buffer used to store the contents of the Sender Report

Returns: uint32_t - Returns the number of octets written into the buffer.

Description: Constructs a Sender report using the buffer passed in by the caller. The Sender Report object shall keep track of the reporting periods that have passed an which information should be used to populate the report.

Usage Notes: The header of the RTCP Report shall be formatted by delegating to the base class.

virtual unsigned long ParseSenderReport ( unsigned char *  puchReportBuffer)
pure virtual

Method Name: ParseSenderReport

Inputs: unsigned char *puchReportBuffer - Buffer containing the contents of the Sender Report

Outputs: None

Returns: None

Description: Extracts the contents of an Sender report using the buffer passed in by the caller. The Sender Report object shall store the content and length of data fields extracted from the Sender Report.

Usage Notes: The header of the RTCP Report shall be parsed by delegating to the base class.