Collapse all Symbian^3 Product Developer Library

RRtpPacket Class Reference

class RRtpPacket

A handle to an RTP packet.

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

Public Member Functions
	RRtpPacket()
IMPORT_C RRtpCSRCs	CSRCs()
IMPORT_C void	Close()
IMPORT_C RRtpHeaderExtension	Extension()
IMPORT_C TBool	ExtensionPresent()
IMPORT_C TUint	Flags()
TBool	IsOpen()
IMPORT_C TBool	Marker()
IMPORT_C TPtrC8	Payload()
IMPORT_C TUint	PayloadType()
IMPORT_C TUint	SSRC()
IMPORT_C TUint	SequenceNumber()
IMPORT_C TUint	Timestamp()
TBool	operator!=(RRtpPacket)
TBool	operator==(RRtpPacket)

Protected Attributes
TRtpPacket *	iPtr

Constructor & Destructor Documentation

RRtpPacket()

RRtpPacket

(

)

[inline]

Default constructor.

Member Functions Documentation

CSRCs()

IMPORT_C RRtpCSRCs

CSRCs

(

)

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.

Close()

IMPORT_C void

(

)

Closes the RTP packet.

Extension()

IMPORT_C RRtpHeaderExtension

Extension

(

)

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.

RRtpPacket::ExtensionPresent()

ExtensionPresent()

IMPORT_C TBool

ExtensionPresent

(

)

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.

Flags()

IMPORT_C TUint

Flags

(

)

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.

IsOpen()

TBool

IsOpen

(

)

const [inline]

Tests whether this packet object is open.

Marker()

IMPORT_C TBool

Marker

(

)

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.

Payload()

IMPORT_C TPtrC8

Payload

(

)

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.

PayloadType()

IMPORT_C TUint

PayloadType

(

)

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.

SSRC()

IMPORT_C TUint

SSRC

(

)

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.

SequenceNumber()

IMPORT_C TUint

SequenceNumber

(

)

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.

Timestamp()

IMPORT_C TUint

Timestamp

(

)

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.