jrtplib  3.6.0
Public Member Functions | List of all members
RTPSourceData Class Reference

Describes an entry in the RTPSources source table. More...

#include <rtpsourcedata.h>

Inherits RTPMemoryObject.

Inherited by RTPInternalSourceData.

Collaboration diagram for RTPSourceData:
Collaboration graph
[legend]

Public Member Functions

RTPPacketGetNextPacket ()
 Extracts the first packet of this participants RTP packet queue. More...
 
void FlushPackets ()
 Clears the participant's RTP packet list. More...
 
bool HasData () const
 Returns true if there are RTP packets which can be extracted. More...
 
uint32_t GetSSRC () const
 Returns the SSRC identifier for this member. More...
 
bool IsOwnSSRC () const
 Returns true if the participant was added using the RTPSources member function CreateOwnSSRC and returns false otherwise.
 
bool IsCSRC () const
 Returns true if the source identifier is actually a CSRC from an RTP packet. More...
 
bool IsSender () const
 Returns true if this member is marked as a sender and false if not. More...
 
bool IsValidated () const
 Returns true if the participant is validated, which is the case if a number of consecutive RTP packets have been received or if a CNAME item has been received for this participant.
 
bool IsActive () const
 Returns true if the source was validated and had not yet sent a BYE packet. More...
 
void SetProcessedInRTCP (bool v)
 This function is used by the RTCPPacketBuilder class to mark whether this participant's information has been processed in a report block or not.
 
bool IsProcessedInRTCP () const
 This function is used by the RTCPPacketBuilder class and returns whether this participant has been processed in a report block or not.
 
bool IsRTPAddressSet () const
 Returns true if the address from which this participant's RTP packets originate has already been set.
 
bool IsRTCPAddressSet () const
 Returns true if the address from which this participant's RTCP packets originate has already been set.
 
const RTPAddressGetRTPDataAddress () const
 Returns the address from which this participant's RTP packets originate. More...
 
const RTPAddressGetRTCPDataAddress () const
 Returns the address from which this participant's RTCP packets originate. More...
 
bool ReceivedBYE () const
 Returns true if we received a BYE message for this participant and false otherwise. More...
 
uint8_t * GetBYEReason (size_t *len) const
 Returns the reason for leaving contained in the BYE packet of this participant. More...
 
RTPTime GetBYETime () const
 Returns the time at which the BYE packet was received. More...
 
void SetTimestampUnit (double tsu)
 Sets the value for the timestamp unit to be used in jitter calculations for data received from this participant. More...
 
double GetTimestampUnit () const
 Returns the timestamp unit used for this participant. More...
 
bool SR_HasInfo () const
 Returns true if an RTCP sender report has been received from this participant. More...
 
RTPNTPTime SR_GetNTPTimestamp () const
 Returns the NTP timestamp contained in the last sender report. More...
 
uint32_t SR_GetRTPTimestamp () const
 Returns the RTP timestamp contained in the last sender report. More...
 
uint32_t SR_GetPacketCount () const
 Returns the packet count contained in the last sender report. More...
 
uint32_t SR_GetByteCount () const
 Returns the octet count contained in the last sender report. More...
 
RTPTime SR_GetReceiveTime () const
 Returns the time at which the last sender report was received. More...
 
bool SR_Prev_HasInfo () const
 Returns true if more than one RTCP sender report has been received. More...
 
RTPNTPTime SR_Prev_GetNTPTimestamp () const
 Returns the NTP timestamp contained in the second to last sender report. More...
 
uint32_t SR_Prev_GetRTPTimestamp () const
 Returns the RTP timestamp contained in the second to last sender report. More...
 
uint32_t SR_Prev_GetPacketCount () const
 Returns the packet count contained in the second to last sender report. More...
 
uint32_t SR_Prev_GetByteCount () const
 Returns the octet count contained in the second to last sender report. More...
 
RTPTime SR_Prev_GetReceiveTime () const
 Returns the time at which the second to last sender report was received. More...
 
bool RR_HasInfo () const
 Returns true if this participant sent a receiver report with information about the reception of our data. More...
 
double RR_GetFractionLost () const
 Returns the fraction lost value from the last report. More...
 
int32_t RR_GetPacketsLost () const
 Returns the number of lost packets contained in the last report. More...
 
uint32_t RR_GetExtendedHighestSequenceNumber () const
 Returns the extended highest sequence number contained in the last report. More...
 
uint32_t RR_GetJitter () const
 Returns the jitter value from the last report. More...
 
uint32_t RR_GetLastSRTimestamp () const
 Returns the LSR value from the last report. More...
 
uint32_t RR_GetDelaySinceLastSR () const
 Returns the DLSR value from the last report. More...
 
RTPTime RR_GetReceiveTime () const
 Returns the time at which the last report was received. More...
 
bool RR_Prev_HasInfo () const
 Returns true if this participant sent more than one receiver report with information about the reception of our data.
 
double RR_Prev_GetFractionLost () const
 Returns the fraction lost value from the second to last report. More...
 
int32_t RR_Prev_GetPacketsLost () const
 Returns the number of lost packets contained in the second to last report. More...
 
uint32_t RR_Prev_GetExtendedHighestSequenceNumber () const
 Returns the extended highest sequence number contained in the second to last report. More...
 
uint32_t RR_Prev_GetJitter () const
 Returns the jitter value from the second to last report. More...
 
uint32_t RR_Prev_GetLastSRTimestamp () const
 Returns the LSR value from the second to last report. More...
 
uint32_t RR_Prev_GetDelaySinceLastSR () const
 Returns the DLSR value from the second to last report. More...
 
RTPTime RR_Prev_GetReceiveTime () const
 Returns the time at which the second to last report was received. More...
 
bool INF_HasSentData () const
 Returns true if validated RTP packets have been received from this participant. More...
 
int32_t INF_GetNumPacketsReceived () const
 Returns the total number of received packets from this participant. More...
 
uint32_t INF_GetBaseSequenceNumber () const
 Returns the base sequence number of this participant. More...
 
uint32_t INF_GetExtendedHighestSequenceNumber () const
 Returns the extended highest sequence number received from this participant. More...
 
uint32_t INF_GetJitter () const
 Returns the current jitter value for this participant. More...
 
RTPTime INF_GetLastMessageTime () const
 Returns the time at which something was last heard from this member. More...
 
RTPTime INF_GetLastRTPPacketTime () const
 Returns the time at which the last RTP packet was received. More...
 
double INF_GetEstimatedTimestampUnit () const
 Returns the estimated timestamp unit, calculated from two consecutive sender reports. More...
 
uint32_t INF_GetNumPacketsReceivedInInterval () const
 Returns the number of packets received since a new interval was started with INF_StartNewInterval. More...
 
uint32_t INF_GetSavedExtendedSequenceNumber () const
 Returns the extended sequence number which was stored by the INF_StartNewInterval call. More...
 
void INF_StartNewInterval ()
 Starts a new interval to count received packets in; this also stores the current extended highest sequence number to be able to calculate the packet loss during the interval.
 
RTPTime INF_GetRoundtripTime () const
 Estimates the round trip time by using the LSR and DLSR info from the last receiver report. More...
 
RTPTime INF_GetLastSDESNoteTime () const
 Returns the time at which the last SDES NOTE item was received. More...
 
uint8_t * SDES_GetCNAME (size_t *len) const
 Returns a pointer to the SDES CNAME item of this participant and stores its length in len. More...
 
uint8_t * SDES_GetName (size_t *len) const
 Returns a pointer to the SDES name item of this participant and stores its length in len. More...
 
uint8_t * SDES_GetEMail (size_t *len) const
 Returns a pointer to the SDES e-mail item of this participant and stores its length in len. More...
 
uint8_t * SDES_GetPhone (size_t *len) const
 Returns a pointer to the SDES phone item of this participant and stores its length in len. More...
 
uint8_t * SDES_GetLocation (size_t *len) const
 Returns a pointer to the SDES location item of this participant and stores its length in len. More...
 
uint8_t * SDES_GetTool (size_t *len) const
 Returns a pointer to the SDES tool item of this participant and stores its length in len. More...
 
uint8_t * SDES_GetNote (size_t *len) const
 Returns a pointer to the SDES note item of this participant and stores its length in len. More...
 
void SDES_GotoFirstPrivateValue ()
 Starts the iteration over the stored SDES private item prefixes and their associated values. More...
 
bool SDES_GetNextPrivateValue (uint8_t **prefix, size_t *prefixlen, uint8_t **value, size_t *valuelen)
 If available, returns true and stores the next SDES private item prefix in prefix and its length in prefixlen; the associated value and its length are then stored in value and valuelen.
 
bool SDES_GetPrivateValue (uint8_t *prefix, size_t prefixlen, uint8_t **value, size_t *valuelen) const
 Looks for the entry which corresponds to the SDES private item prefix prefix with length prefixlen; if found, the function returns true and stores the associated value and its length in value and valuelen respectively.
 

Detailed Description

Member Function Documentation

void RTPSourceData::FlushPackets ( )
inline
uint8_t* RTPSourceData::GetBYEReason ( size_t *  len) const
inline

Returns the reason for leaving contained in the BYE packet of this participant. The length of the reason is stored in len.

RTPTime RTPSourceData::GetBYETime ( ) const
inline
RTPPacket * RTPSourceData::GetNextPacket ( )
inline
const RTPAddress* RTPSourceData::GetRTCPDataAddress ( ) const
inline

Returns the address from which this participant's RTCP packets originate. If the address has been set and the returned value is NULL, this indicates that it originated from the local participant.

const RTPAddress* RTPSourceData::GetRTPDataAddress ( ) const
inline

Returns the address from which this participant's RTP packets originate. If the address has been set and the returned value is NULL, this indicates that it originated from the local participant.

uint32_t RTPSourceData::GetSSRC ( ) const
inline
double RTPSourceData::GetTimestampUnit ( ) const
inline
bool RTPSourceData::HasData ( ) const
inline
uint32_t RTPSourceData::INF_GetBaseSequenceNumber ( ) const
inline
double RTPSourceData::INF_GetEstimatedTimestampUnit ( ) const
uint32_t RTPSourceData::INF_GetExtendedHighestSequenceNumber ( ) const
inline
uint32_t RTPSourceData::INF_GetJitter ( ) const
inline
RTPTime RTPSourceData::INF_GetLastMessageTime ( ) const
inline
RTPTime RTPSourceData::INF_GetLastRTPPacketTime ( ) const
inline
RTPTime RTPSourceData::INF_GetLastSDESNoteTime ( ) const
inline
int32_t RTPSourceData::INF_GetNumPacketsReceived ( ) const
inline
uint32_t RTPSourceData::INF_GetNumPacketsReceivedInInterval ( ) const
inline
RTPTime RTPSourceData::INF_GetRoundtripTime ( ) const
uint32_t RTPSourceData::INF_GetSavedExtendedSequenceNumber ( ) const
inline
bool RTPSourceData::INF_HasSentData ( ) const
inline
bool RTPSourceData::IsActive ( ) const
inline
bool RTPSourceData::IsCSRC ( ) const
inline
bool RTPSourceData::IsSender ( ) const
inline
bool RTPSourceData::ReceivedBYE ( ) const
inline
uint32_t RTPSourceData::RR_GetDelaySinceLastSR ( ) const
inline
uint32_t RTPSourceData::RR_GetExtendedHighestSequenceNumber ( ) const
inline
double RTPSourceData::RR_GetFractionLost ( ) const
inline
uint32_t RTPSourceData::RR_GetJitter ( ) const
inline
uint32_t RTPSourceData::RR_GetLastSRTimestamp ( ) const
inline
int32_t RTPSourceData::RR_GetPacketsLost ( ) const
inline
RTPTime RTPSourceData::RR_GetReceiveTime ( ) const
inline
bool RTPSourceData::RR_HasInfo ( ) const
inline
uint32_t RTPSourceData::RR_Prev_GetDelaySinceLastSR ( ) const
inline
uint32_t RTPSourceData::RR_Prev_GetExtendedHighestSequenceNumber ( ) const
inline
double RTPSourceData::RR_Prev_GetFractionLost ( ) const
inline
uint32_t RTPSourceData::RR_Prev_GetJitter ( ) const
inline
uint32_t RTPSourceData::RR_Prev_GetLastSRTimestamp ( ) const
inline
int32_t RTPSourceData::RR_Prev_GetPacketsLost ( ) const
inline
RTPTime RTPSourceData::RR_Prev_GetReceiveTime ( ) const
inline
uint8_t* RTPSourceData::SDES_GetCNAME ( size_t *  len) const
inline
uint8_t* RTPSourceData::SDES_GetEMail ( size_t *  len) const
inline
uint8_t* RTPSourceData::SDES_GetLocation ( size_t *  len) const
inline
uint8_t* RTPSourceData::SDES_GetName ( size_t *  len) const
inline
uint8_t* RTPSourceData::SDES_GetNote ( size_t *  len) const
inline
uint8_t* RTPSourceData::SDES_GetPhone ( size_t *  len) const
inline
uint8_t* RTPSourceData::SDES_GetTool ( size_t *  len) const
inline
void RTPSourceData::SDES_GotoFirstPrivateValue ( )
inline
void RTPSourceData::SetTimestampUnit ( double  tsu)
inline

Sets the value for the timestamp unit to be used in jitter calculations for data received from this participant. If not set, the library uses an approximation for the timestamp unit which is calculated from two consecutive RTCP sender reports. The timestamp unit is defined as a time interval divided by the corresponding timestamp interval. For 8000 Hz audio this would be 1/8000. For video, often a timestamp unit of 1/90000 is used.

uint32_t RTPSourceData::SR_GetByteCount ( ) const
inline
RTPNTPTime RTPSourceData::SR_GetNTPTimestamp ( ) const
inline
uint32_t RTPSourceData::SR_GetPacketCount ( ) const
inline
RTPTime RTPSourceData::SR_GetReceiveTime ( ) const
inline
uint32_t RTPSourceData::SR_GetRTPTimestamp ( ) const
inline
bool RTPSourceData::SR_HasInfo ( ) const
inline
uint32_t RTPSourceData::SR_Prev_GetByteCount ( ) const
inline
RTPNTPTime RTPSourceData::SR_Prev_GetNTPTimestamp ( ) const
inline
uint32_t RTPSourceData::SR_Prev_GetPacketCount ( ) const
inline
RTPTime RTPSourceData::SR_Prev_GetReceiveTime ( ) const
inline
uint32_t RTPSourceData::SR_Prev_GetRTPTimestamp ( ) const
inline
bool RTPSourceData::SR_Prev_HasInfo ( ) const
inline

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