Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]

Location: rtp.h

Class RRtpPacket

class RRtpPacket;

Description

A handle to an RTP packet.

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

Members

Defined in RRtpPacket:
CSRCs(), Close(), Extension(), ExtensionPresent(), Flags(), IsOpen(), Marker(), Payload(), PayloadType(), RRtpPacket(), SSRC(), SequenceNumber(), Timestamp(), iPtr, operator!=(), operator==()

Construction and destruction

RRtpPacket()

inline RRtpPacket();

Description

Default constructor.

[Top]

Member functions

IsOpen()

inline TBool IsOpen() const;

Description

Tests whether this packet object is open.

Return value

TBool

ETrue, if the packet is open, false otherwise.

Close()

IMPORT_C void Close();

Description

Closes the RTP packet.

Payload()

IMPORT_C TPtrC8 Payload() const;

Description

Gets a pointer descriptor representing the packet's payload.

Return value

TPtrC8

The pointer descriptor representing the payload.

Panic codes

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;

Description

Gets the packet's sequence number.

Return value

TUint

The packet's sequence number.

Panic codes

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;

Description

Gets the packet's timestamp.

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

Return value

TUint

The packet's timestamp.

Panic codes

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;

Description

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

Return value

TUint

The 32-bit SSRC identifier.

Panic codes

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.

CSRCs()

IMPORT_C RRtpCSRCs CSRCs() const;

Description

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

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

Return value

RRtpCSRCs

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

Panic codes

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.

ExtensionPresent()

IMPORT_C TBool ExtensionPresent() const;

Description

Tests whether the packet has a header extension.

Return value

TBool

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

Panic codes

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.

Extension()

IMPORT_C RRtpHeaderExtension Extension() const;

Description

Gets the packet's header extension.

Return value

RRtpHeaderExtension

The header extension.

Panic codes

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.

RTP

5 if there is no header extension.

See also:

Marker()

IMPORT_C TBool Marker() const;

Description

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

Return value

TBool

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

Panic codes

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;

Description

Gets the type of payload carried by the packet.

Return value

TUint

The 7-bit payload type.

Panic codes

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;

Description

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 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Return value

TUint

The first 32 bits of the header as an integer.

Panic codes

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.

operator==()

inline TBool operator==(RRtpPacket aThat) const;

Description

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

Parameters

RRtpPacket aThat

The handle of the packet to be compared.

Return value

TBool

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

operator!=()

inline TBool operator!=(RRtpPacket aThat) const;

Description

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

Parameters

RRtpPacket aThat

The handle of the packet to be compared.

Return value

TBool

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

[Top]

Member data

iPtr

protected: TRtpPacket * iPtr;

Description

[Previous] [Top] [Next]