RRtpSendPacket Class Reference

#include <mw/rtp.h>

Link against: rtpremoved.lib

class RRtpSendPacket : public RRtpPacket

Inherits from

Detailed Description

A handle to an RTP packet to be sent (an RTP send packet).

See also: RRtpSendSource

Member Function Documentation

Close ( )

IMPORT_C voidClose()

Reimplemented from RRtpPacket::Close()

Closes the RTP packet.

Send ( )

IMPORT_C voidSend()

Sends the RTP packet.

The packet must be correctly initialised, apart from the sequence number and the SSRC (the 32-bit numeric synchronisation source identifier).

The packet must continue to exist until it has been sent, i.e. until an ERtpSendSucceeded or an ERtpSendFailed event has been received on the RRtpSendSource.

Panic Codes
RTP1 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.

SendSync ( )

IMPORT_C TIntSendSync()

Sends the RTP packet.

The packet must be correctly initialised, apart from the sequence number and the SSRC (the 32-bit numeric synchronisation source identifier).

Sends the RTP data Synchronously.

Panic Codes
RTP1 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.

SetFlags ( TUint )

IMPORT_C voidSetFlags(TUintaFlags)

Sets the first 32 bits of the packet header.

This function may be useful for profiles that do unusual things such as combining the payload type and marker bits, but should be used with extreme caution as no validity checking is done on the values passed in.

Note that the number passed in is in opposite endianess to that required by the packet. The function does not correct the endianess.

See also: RRtpPacket::Flags()

Parameters
aFlagsThe 32 bits. aFlags expected in this format.... V is most significant bit in aFlags 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 Codes
RTP1 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.

SetMarker ( TBool )

IMPORT_C voidSetMarker(TBoolaMark)

Sets or unsets the RTP packet's marker bit.

See also: RRtpPacket::Marker()

Parameters
aMarkETrue, if the market bit is to be set, EFalse, if the marker bit is to be unset.
Panic Codes
RTP1 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.

SetPayloadType ( TUint )

IMPORT_C voidSetPayloadType(TUintaPayloadType)

Sets the RTP packet's payload type.

Sets the RTP packet's payload type.
Parameters
aPayloadTypeThe 7-bit payload type.
Panic Codes
RTP1 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.
RTP2 if the specified payload type value is greater than or equal to 256.
RTP1 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.
RTP2 if the specified payload type value is greater than or equal to 128.

SetTimestamp ( TUint )

IMPORT_C voidSetTimestamp(TUintaTimestamp)

Sets the RTP packet's timestamp

See also: RRtpPacket::Timestamp()

Parameters
aTimestampThe RTP packet timestamp
Panic Codes
RTP1 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.

WritePayload ( )

IMPORT_C TDes8 &WritePayload()

Gets a modifiable descriptor into which the client can write the packet's payload.

Return Value
A reference to the modifiable descriptor.
Panic Codes
RTP1 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.