Class RRtpSendPacket

class RRtpSendPacket : public RRtpPacket;

Description

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

Derivation

• RRtpPacket - A handle to an RTP packet.

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

Members

Defined in RRtpSendPacket:

• Send()Sends the RTP packet.
• SetFlags(TUint)Sets the first 32 bits of the packet header.
• SetMarker(TBool)Sets or unsets the RTP packet's marker bit.
• SetPayloadType(TUint)Sets the RTP packet's payload type.
• SetTimestamp(TUint)Sets the RTP packet's timestamp
• WritePayload()Gets a modifiable descriptor into which the client can write the packet's payloa...

Inherited from RRtpPacket:

• CSRCs()constGets a handle to a list of CSRCs (contributing sources).
• Close()Closes the RTP packet.
• Extension()constGets the packet's header extension.
• ExtensionPresent()constTests whether the packet has a header extension.
• Flags()constGets the first 32 bits of the packet header.
• IsOpen()constTests whether this packet object is open.
• Marker()constTests whether the marker bit is set in the packet header.
• Payload()constGets a pointer descriptor representing the packet's payload.
• PayloadType()constGets the type of payload carried by the packet.
• SSRC()constGets the SSRC, the 32-bit numeric synchronisation source identifier.
• SequenceNumber()constGets the packet's sequence number.
• Timestamp()constGets the packet's timestamp.
• iPtr
• operator!=(RRtpPacket)constTests whether this packet handle represents a different packet to the one repres...
• operator==(RRtpPacket)constTests whether this packet handle represents the same packet as the one represent...

IMPORT_C void Send();

Description

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

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.

IMPORT_C TDes8& WritePayload();

Description

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

Return value

TDes8 & A reference to the modifiable descriptor.

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.

IMPORT_C void SetTimestamp(TUint aTimestamp);

Description

Sets the RTP packet's timestamp

Parameters

TUint aTimestamp The RTP packet 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.

See also:

• RRtpPacket::Timestamp()constGets the packet's timestamp.

IMPORT_C void SetMarker(TBool aMark);

Description

Sets or unsets the RTP packet's marker bit.

Parameters

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

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.

See also:

• RRtpPacket::Marker()constTests whether the marker bit is set in the packet header.

IMPORT_C void SetPayloadType(TUint aPayloadType);

Description

Sets the RTP packet's payload type.

Parameters

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

IMPORT_C void SetFlags(TUint aFlags);

Description

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.

Parameters

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

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.

See also:

• RRtpPacket::Flags()constGets the first 32 bits of the packet header.