RRtpSendPacket Class Reference

#include <mw/rtp.h>

Link against: rtp.lib

class RRtpSendPacket : public RRtpPacket

Inherits from

RRtpSendPacket
- RRtpPacket

Public Member Functions
IMPORT_C void	Close()
IMPORT_C void	Send()
IMPORT_C TInt	SendSync()
IMPORT_C void	SetFlags(TUint)
IMPORT_C void	SetMarker(TBool)
IMPORT_C void	SetPayloadType(TUint)
IMPORT_C void	SetTimestamp(TUint)
IMPORT_C TDes8 &	WritePayload()

Inherited Attributes
	RRtpPacket::iPtr

Inherited Functions
	RRtpPacket::CSRCs()const
	RRtpPacket::Extension()const
	RRtpPacket::ExtensionPresent()const
	RRtpPacket::Flags()const
	RRtpPacket::IsOpen()const
	RRtpPacket::Marker()const
	RRtpPacket::Payload()const
	RRtpPacket::PayloadType()const
	RRtpPacket::RRtpPacket()
	RRtpPacket::SSRC()const
	RRtpPacket::SequenceNumber()const
	RRtpPacket::Timestamp()const
	RRtpPacket::operator!=(RRtpPacket)const
	RRtpPacket::operator==(RRtpPacket)const

Detailed Description

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

Member Function Documentation

Close ( )

IMPORT_C void

(

)

Reimplemented from RRtpPacket::Close()

Closes the RTP packet.

Send ( )

IMPORT_C void

Send

(

)

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: 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.

SendSync ( )

IMPORT_C TInt

SendSync

(

)

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: 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.

SetFlags ( TUint )

IMPORT_C void

SetFlags

(

TUint

aFlags

)

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.

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.

Parameter	Description
aFlags	The 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 \| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

SetMarker ( TBool )

IMPORT_C void

SetMarker

(

TBool

aMark

)

Sets or unsets the RTP packet's marker bit.

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.

Parameter	Description
aMark	ETrue, if the market bit is to be set, EFalse, if the marker bit is to be unset.

SetPayloadType ( TUint )

IMPORT_C void

SetPayloadType

(

TUint

aPayloadType

)

Sets the RTP packet's payload type.

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 2 if the specified payload type value is greater than or equal to 128.

Parameter	Description
aPayloadType	The 7-bit payload type.

SetTimestamp ( TUint )

IMPORT_C void

SetTimestamp

(

TUint

aTimestamp

)

Sets the RTP packet's timestamp

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.

Parameter	Description
aTimestamp	The RTP packet timestamp

WritePayload ( )

IMPORT_C TDes8 &

WritePayload

(

)

Gets a modifiable descriptor into which the client can write 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: A reference to the modifiable descriptor.