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

Go to the source code of this file.

Functions

virtual unsigned long FormatRTPHeader (unsigned char *puchRTPBuffer, unsigned long ulPacketLength)=0
 
virtual unsigned long GetHeaderLength (void)=0
 
virtual unsigned long GetVersion (void)=0
 
virtual unsigned long GetPadding (void)=0
 
virtual unsigned long GetExtension (void)=0
 
virtual unsigned long GetMarker (void)=0
 
virtual unsigned long GetPayload (void)=0
 
virtual unsigned long GetSequenceNo (void)=0
 
virtual void GetRTPTimestamp (uint32_t *pulTimestamp)=0
 
virtual void GetRecvTimestamp (uint32_t *pulTimestamp)=0
 
virtual ssrc_t GetSSRC (void)=0
 
virtual unsigned long GetCSRC (ssrc_t *paulCSRC, bool bNBO)=0
 

Function Documentation

virtual unsigned long FormatRTPHeader ( unsigned char *  puchRTPBuffer,
unsigned long  ulPacketLength 
)
pure virtual

Method Name: FormatRTPHeader

Inputs: unsigned char *puchRTPBuffer - Character Buffer containing RTP Packet unsigned long ulPacketLength - Optional length of buffer content passed

Outputs: None

Returns: unsigned long

Description: Constructs an RTP Report header using information passed in the RTP character buffer. Some basic check will be performed to determine whether the packet is valid.

Usage Notes: A buffer of sufficient size should be allocated and passed to this formatting method.

virtual unsigned long GetHeaderLength ( void  )
pure virtual

Method Name: GetHeaderLength

Inputs: None

Outputs: None

Returns: unsigned long - Returns the size of the RTP Header

Description: Returns the size of the RTP Header that preceeds the payload.

Usage Notes:

virtual unsigned long GetVersion ( void  )
pure virtual

Method Name: GetVersion

Inputs: None

Outputs: None

Returns: unsigned long - Returns the Version

Description: Retrieves the Version attribute stored within the object.

Usage Notes:

virtual unsigned long GetPadding ( void  )
pure virtual

Method Name: GetPadding

Inputs: None

Outputs: None

Returns: unsigned long - Padding Flag

Description: Returns the padding flag value associated with the RTP packet.

Usage Notes:

virtual unsigned long GetExtension ( void  )
pure virtual

Method Name: GetExtension

Inputs: None

Outputs: None

Returns: unsigned long - Header Extension Flag

Description: Returns the header extension flag from the RTP packet header.

Usage Notes:

virtual unsigned long GetMarker ( void  )
pure virtual

Method Name: GetMarker

Inputs: None

Outputs: None

Returns: unsigned long - Marker Flag

Description: Returns the marker flag value associated with the RTP packet.

Usage Notes:

virtual unsigned long GetPayload ( void  )
pure virtual

Method Name: GetPayload

Inputs: None

Outputs: None

Returns: unsigned long - Returns the Payload Type

Description: Retrieves the payload type associated with this RTP report.

Usage Notes:

virtual unsigned long GetSequenceNo ( void  )
pure virtual

Method Name: GetSequenceNo

Inputs: None

Outputs: None

Returns: unsigned long - Packet Sequence Number

Description: Returns the sequence number from the RTP packet.

Usage Notes:

virtual void GetRTPTimestamp ( uint32_t *  pulTimestamp)
pure virtual

Method Name: GetRTPTimestamp

Inputs: None

Outputs: unsigned long *pulTimestamp - RTP Packet Timestamp

Returns: void

Description: Returns the timestamp value associated with the RTP packet.

Usage Notes:

virtual void GetRecvTimestamp ( uint32_t *  pulTimestamp)
pure virtual

Method Name: GetRecvTimestamp

Inputs: None

Outputs: unsigned long *pulTimestamp - Packet TReceive Timestamp

Returns: void

Description: Returns the timestamp value associated with the RTP packet. The Received Timestamp is the time of reception of the RTP Packet.

Usage Notes:

virtual ssrc_t GetSSRC ( void  )
pure virtual

Method Name: GetSSRC

Inputs: None

Outputs: None

Returns: unsigned long - Packet Source Identifier

Description: Returns the SSRC value associated with the RTP packet.

Usage Notes:

virtual unsigned long GetCSRC ( ssrc_t paulCSRC,
bool  bNBO 
)
pure virtual

Method Name: GetCSRC

Inputs: bool bNBO - Flag specifying whether data should be represented in Network Byte order format

Outputs: unsigned long *paulCSRC - Contributing Source Identifier(s) Array pointer

Returns: unsigned long - Number of Contributing Source Identifier(s)

Description: Returns the contributing source values from the RTP packet.

Usage Notes: