class RtpPacket

Data struture for RTP data packet

Public Fields

bool sequenceSet
flags

Public Methods

void eventDTMF( int a, int b )
(what does this do?)
void eventDTMF( int a, int b )
(what does this do?)
RtpSrc getCSRC(unsigned int index)
index value less range 1 to csrc_count
RtpHeader* getHeader()
Pointer to packet header
int getPacketAlloc()
Entire size of RTP packet including header, unused, and padbyte
char* getPacketData()
Pointer to packet data
char* getPadbyteLoc()
Pointer to begnning of padbyte (Not implemented)
int getPadbyteSize()
Size of padbyte (Not fully implemented)
char* getPayloadLoc()
Pointer to beginning of payload
int getPayloadSize()
Maximum payload size
RtpPayloadType getPayloadType()
int getPayloadUsage()
Size of payload stored
RtpTime getRtpTime()
RtpSeqNumber getSequence()
RtpSrc getSSRC()
int getTotalUsage()
Size of RTP packet not including unused memory
int getUnused()
Size of unused memory
void printPacket()
Print packet contents
void recvEvent( RtpPacket* p )
calls the registered callback fucntion
void recvEvent( RtpPacket* p )
calls the registered callback fucntion
RtpEvent()
RtpEventReceiver()
RtpEventTransmitter( RtpTransmitter* rtpTran )
RtpPacket(int newpayloadSize, int npadSize = 0, int csrc_count = 0)
Constructor that allocates RTP packetData
RtpPacket(RtpPacket* clonePacket, int newpayloadSize)
clones an existing packet to a new size
void sendEvent( const DTMFEvent event )
send out a DTMFEvent in RTP
void sendEvent( const DTMFEvent event )
send out a DTMFEvent in RTP
void setCSRC(RtpSrc src, unsigned int index)
void setCSRCcount(int i)
Gets number of contributing sources
void setDTMFInterface( DTMFInterface* t )
set DTMF callback function
void setDTMFInterface( DTMFInterface* t )
set DTMF callback function
void setDTMFType( const RtpPayloadType DTMFType )
changes type of DTMF in rtp to send
void setDTMFType( const RtpPayloadType DTMFType )
changes type of DTMF in rtp to send
void setExtFlag(int i)
void setMarkerFlag(int i)
void setPadbyteSize(int size)
Sets size of payload (Not implemented)
void setPaddingFlag(int i)
void setPayloadType(RtpPayloadType payloadType)
void setPayloadUsage(int size)
Sets payload usage
void setRtpTime(RtpTime time)
void setSequence(RtpSeqNumber newseq)
void setSSRC(RtpSrc src)
void setTotalUsage(int size)
Sets size of RTP packet including header and padbyte Extra memory will be set as unused memory
void setVersion(int i)
void unsetDTMFInterface( DTMFInterface* t )
unset DTMF callback function
void unsetDTMFInterface( DTMFInterface* t )
unset DTMF callback function
virtual ~RtpEvent()
virtual ~RtpEventReceiver()
virtual ~RtpEventTransmitter()
~RtpPacket()
Destructor that deallocates RTP packetData memory

Public

receives DTMFEvent from RTP
Constructor that uses already allocated memory as packetData
receives DTMFEvent from RTP

Private Fields

RtpHeader* header
Easy access to header information
int packetAlloc
Allocated packet size
char* packetData
Pointer to raw memory allocation
int unusedSize
Size of unused memory

Documentation

Data struture for RTP data packet
RtpEvent()

virtual ~RtpEvent()

void sendEvent( const DTMFEvent event )
send out a DTMFEvent in RTP

receives DTMFEvent from RTP

void recvEvent( RtpPacket* p )
calls the registered callback fucntion

void setDTMFInterface( DTMFInterface* t )
set DTMF callback function

void unsetDTMFInterface( DTMFInterface* t )
unset DTMF callback function

void setDTMFType( const RtpPayloadType DTMFType )
changes type of DTMF in rtp to send

void eventDTMF( int a, int b )
(what does this do?)

RtpEventReceiver()

virtual ~RtpEventReceiver()

receives DTMFEvent from RTP

void recvEvent( RtpPacket* p )
calls the registered callback fucntion

void setDTMFInterface( DTMFInterface* t )
set DTMF callback function

void unsetDTMFInterface( DTMFInterface* t )
unset DTMF callback function

void eventDTMF( int a, int b )
(what does this do?)

RtpEventTransmitter( RtpTransmitter* rtpTran )

virtual ~RtpEventTransmitter()

void sendEvent( const DTMFEvent event )
send out a DTMFEvent in RTP

void setDTMFType( const RtpPayloadType DTMFType )
changes type of DTMF in rtp to send

RtpPacket(int newpayloadSize, int npadSize = 0, int csrc_count = 0)
Constructor that allocates RTP packetData
Parameters:
newpayloadSize - Payload size not including RTP header
npadSize - Number of pad bytes (not implemented)
csrc_count - Number of contributing sources in packet

Constructor that uses already allocated memory as packetData
Parameters:
memory - already allocatd memory
size - includes rtpHeader and padbytes

RtpPacket(RtpPacket* clonePacket, int newpayloadSize)
clones an existing packet to a new size

~RtpPacket()
Destructor that deallocates RTP packetData memory

char* getPacketData()
Pointer to packet data

RtpHeader* getHeader()
Pointer to packet header

char* getPayloadLoc()
Pointer to beginning of payload

int getPayloadSize()
Maximum payload size

void setPayloadUsage(int size)
Sets payload usage
Parameters:
size - doesn't include RTP header

int getPayloadUsage()
Size of payload stored

char* getPadbyteLoc()
Pointer to begnning of padbyte (Not implemented)

void setPadbyteSize(int size)
Sets size of payload (Not implemented)

int getPadbyteSize()
Size of padbyte (Not fully implemented)

int getPacketAlloc()
Entire size of RTP packet including header, unused, and padbyte

int getUnused()
Size of unused memory

void setTotalUsage(int size)
Sets size of RTP packet including header and padbyte Extra memory will be set as unused memory

int getTotalUsage()
Size of RTP packet not including unused memory

void setPayloadType(RtpPayloadType payloadType)

RtpPayloadType getPayloadType()

void setSequence(RtpSeqNumber newseq)

RtpSeqNumber getSequence()

RtpTime getRtpTime()

void setRtpTime(RtpTime time)

void setSSRC(RtpSrc src)

RtpSrc getSSRC()

void setCSRCcount(int i)
Gets number of contributing sources

void setCSRC(RtpSrc src, unsigned int index)

RtpSrc getCSRC(unsigned int index)
index value less range 1 to csrc_count
Parameters:
index - value less range 1 to csrc_count

void setVersion(int i)

void setPaddingFlag(int i)

void setExtFlag(int i)

void setMarkerFlag(int i)

bool sequenceSet
flags

void printPacket()
Print packet contents

char* packetData
Pointer to raw memory allocation

int packetAlloc
Allocated packet size

int unusedSize
Size of unused memory

RtpHeader* header
Easy access to header information


This class has no child classes.

alphabetic index hierarchy of classes


generated by doc++