JRTPLIB  3.9.0
Public Member Functions | List of all members
jrtplib::RTCPBYEPacket Class Reference

Describes an RTCP BYE packet. More...

#include <rtcpbyepacket.h>

Inheritance diagram for jrtplib::RTCPBYEPacket:
Inheritance graph
[legend]
Collaboration diagram for jrtplib::RTCPBYEPacket:
Collaboration graph
[legend]

Public Member Functions

 RTCPBYEPacket (uint8_t *data, size_t datalen)
 Creates an instance based on the data in data with length datalen. More...
 
int GetSSRCCount () const
 Returns the number of SSRC identifiers present in this BYE packet. More...
 
uint32_t GetSSRC (int index) const
 Returns the SSRC described by index which may have a value from 0 to GetSSRCCount()-1 (note that no check is performed to see if index is valid).
 
bool HasReasonForLeaving () const
 Returns true if the BYE packet contains a reason for leaving. More...
 
size_t GetReasonLength () const
 Returns the length of the string which describes why the source(s) left. More...
 
uint8_t * GetReasonData ()
 Returns the actual reason for leaving data. More...
 
- Public Member Functions inherited from jrtplib::RTCPPacket
bool IsKnownFormat () const
 Returns true if the subclass was able to interpret the data and false otherwise. More...
 
PacketType GetPacketType () const
 Returns the actual packet type which the subclass implements. More...
 
uint8_t * GetPacketData ()
 Returns a pointer to the data of this RTCP packet. More...
 
size_t GetPacketLength () const
 Returns the length of this RTCP packet. More...
 

Additional Inherited Members

- Public Types inherited from jrtplib::RTCPPacket
enum  PacketType {
  SR, RR, SDES, BYE,
  APP, Unknown
}
 Identifies the specific kind of RTCP packet. More...
 

Detailed Description

Constructor & Destructor Documentation

jrtplib::RTCPBYEPacket::RTCPBYEPacket ( uint8_t *  data,
size_t  datalen 
)

Creates an instance based on the data in data with length datalen. Since the data pointer is referenced inside the class (no copy of the data is made) one must make sure that the memory it points to is valid as long as the class instance exists.

Member Function Documentation

uint8_t * jrtplib::RTCPBYEPacket::GetReasonData ( )
inline
size_t jrtplib::RTCPBYEPacket::GetReasonLength ( ) const
inline
int jrtplib::RTCPBYEPacket::GetSSRCCount ( ) const
inline
bool jrtplib::RTCPBYEPacket::HasReasonForLeaving ( ) const
inline

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