RRtpPacket Class Reference

#include <mw/rtp.h>

Link against: rtpremoved.lib

class RRtpPacket
Protected Attributes
TRtpPacket *iPtr
Public Member Functions
RRtpPacket()
IMPORT_C RRtpCSRCsCSRCs()
IMPORT_C voidClose()
IMPORT_C RRtpHeaderExtensionExtension()
IMPORT_C TBoolExtensionPresent()
IMPORT_C TUintFlags()
TBool IsOpen()
IMPORT_C TBoolMarker()
IMPORT_C TPtrC8Payload()
IMPORT_C TUintPayloadType()
IMPORT_C TUintSSRC()
IMPORT_C TUintSequenceNumber()
IMPORT_C TUintTimestamp()
TBool operator!=(RRtpPacket)
TBool operator==(RRtpPacket)

Detailed Description

A handle to an RTP packet.

The packet is accessed through the interface provided by this handle.

Member Attribute Documentation

iPtr

TRtpPacket *iPtr[protected]

Constructor & Destructor Documentation

RRtpPacket ( )

RRtpPacket()[inline]

Default constructor.

Member Function Documentation

CSRCs ( )

IMPORT_C RRtpCSRCsCSRCs()const

Gets a handle to a list of CSRCs (contributing sources).

If there are no CSRCs, then the list is empty.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: A handle encapsulating the list of CSRCs. Callers can access the list through this returned handle.

Close ( )

IMPORT_C voidClose()

Closes the RTP packet.

Extension ( )

IMPORT_C RRtpHeaderExtensionExtension()const

Gets the packet's header extension.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.
panic
RTP 5 if there is no header extension.

See also: RRtpPacket::ExtensionPresent()

Returns: The header extension.

ExtensionPresent ( )

IMPORT_C TBoolExtensionPresent()const

Tests whether the packet has a header extension.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: True, if a header extension is present, false otherwise.

Flags ( )

IMPORT_C TUintFlags()const

Gets the first 32 bits of the packet header.

This may be useful for profiles that do things such as using a different number of marker bits.

Flags returned in this format.... V is most significant bit in flags 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |V=2|P|X| CC |M| PT | sequence number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: The first 32 bits of the header as an integer.

IsOpen ( )

TBool IsOpen()const [inline]

Tests whether this packet object is open.

Returns: ETrue, if the packet is open, false otherwise.

Marker ( )

IMPORT_C TBoolMarker()const

Tests whether the marker bit is set in the packet header.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: True, if the marker bit is set, false otherwise.

Payload ( )

IMPORT_C TPtrC8Payload()const

Gets a pointer descriptor representing the packet's payload.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: The pointer descriptor representing the payload.

PayloadType ( )

IMPORT_C TUintPayloadType()const

Gets the type of payload carried by the packet.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: The 7-bit payload type.

SSRC ( )

IMPORT_C TUintSSRC()const

Gets the SSRC, the 32-bit numeric synchronisation source identifier.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: The 32-bit SSRC identifier.

SequenceNumber ( )

IMPORT_C TUintSequenceNumber()const

Gets the packet's sequence number.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: The packet's sequence number.

Timestamp ( )

IMPORT_C TUintTimestamp()const

Gets the packet's timestamp.

This is a monotonic linear time representation, but the resolution and zero point are profile dependent.

panic
RTP 1 if the packet has not been opened. Note that this panic is raised in debug mode only; in release mode, calling this function when the packet has not been opened is likely to raise panics such as KERN-EXEC 3.

Returns: The packet's timestamp.

operator!= ( RRtpPacket )

TBool operator!=(RRtpPacketaThat)const [inline]

Tests whether this packet handle represents a different packet to the one represented by the specified handle.

ParameterDescription
aThatThe handle of the packet to be compared.

Returns: ETrue, if the represented packets are different, false otherwise.

operator== ( RRtpPacket )

TBool operator==(RRtpPacketaThat)const [inline]

Tests whether this packet handle represents the same packet as the one represented by the specified handle.

ParameterDescription
aThatThe handle of the packet to be compared.

Returns: ETrue, if the represented packets are the same, false otherwise.