RRtpSession Class Reference

#include <mw/rtp.h>

Link against: rtpremoved.lib

class RRtpSession

Public Member Enumerations
enum	TRtpSendPacketType { ERtcpPacketCNAME, ERtcpPacketNAME, ERtcpPacketEMAIL, ERtcpPacketPHONE, ..., ERtcpPacketPRIV }

Public Member Functions
	RRtpSession()
IMPORT_C void	Close()
IMPORT_C void	DisableNonRtpData()
IMPORT_C void	DontReceive(TInt)
IMPORT_C RRtcpRRPart	GetRRs()
IMPORT_C TInt	GetSDES(const TInt, TDes8 &)
TBool	IsOpen()
IMPORT_C TInt	MaxRXSize()
IMPORT_C RRtpReceiveSource	NewReceiveSourceL()
IMPORT_C RRtpReceiveSource	NewReceiveSourceLC()
IMPORT_C RRtpSendSource	NewSendSourceL()
IMPORT_C TPtr8	NonRtcpDataL()
IMPORT_C const TDesC8 &	NonRtpDataL()
IMPORT_C void	OpenL(RSocketServ &, TSockAddr &, TSockAddr &, TInt, RConnection &, TInt, const TDesC8 &)
IMPORT_C void	OpenL(RSocketServ &, TSockAddr &, TSockAddr &, TInt, TInt, const TDesC8 &)
IMPORT_C void	OpenL(RSocket &, TInt, RSocket &, TInt, const TDesC8 &)
IMPORT_C void	OpenL(RSocket &, TInt, TInt)
IMPORT_C void	OpenL(RSocketServ &, TSockAddr &, TSockAddr &, TInt, RSubConnection &, TInt, const TDesC8 &)
IMPORT_C void	PrivRegisterEventCallbackL(TUint, TRtpCallbackFunction, TAny *, TInt)
IMPORT_C void	PrivRegisterEventCallbackL(TUint, TRtpCallbackFunction, TAny *)
IMPORT_C TBool	RTCPAutoSend()
void	RegisterEventCallbackL(TRtpEventType, void()(T , const TRtpEvent &), T *, TRtpOneShotness, TInt)
void	RegisterEventCallbackL(TRtpEventType, void()(T , const TRtpEvent &), T *, TRtpOneShotness)
IMPORT_C RSocket *	RtcpSocket()
IMPORT_C TInt	RtcpStatistics(TUint32, TRtcpStatistics &)
IMPORT_C RSocket *	RtpSocket()
IMPORT_C void	SendAPPL(const TDesC8 &, const TDesC8 &, TUint8)
IMPORT_C void	SendDataL(TBool, const TDesC8 &, TRequestStatus &)
IMPORT_C void	SendRTCPPacketL(TDesC8 &)
IMPORT_C RRtpSendSource	SendSource()
IMPORT_C void	SetBandwidth(TUint)
IMPORT_C void	SetMaxRXSize(TInt)
IMPORT_C TInt	SetPRIVL(const TDesC8 &, const TDesC8 &)
IMPORT_C void	SetPrePostProcessingRegisterCallback(MPrePostProcessingCallback *)
IMPORT_C void	SetRTCPAutoSend(TBool)
IMPORT_C void	SetRTPTimeConversion(TUint, TUint)
IMPORT_C void	SetRemoteAddress(const TSockAddr &)
IMPORT_C void	SetRemoteRtcpPort(TUint)
IMPORT_C void	SetRtcpInterval(TTimeIntervalMicroSeconds32 &)
IMPORT_C void	SetRtpStreamParameters(TInt, TInt, TInt)
IMPORT_C TInt	SetSDESL(TInt, const TDesC8 &)
IMPORT_C TInt	SetSamplingRate(TInt, TUint)
TBool	operator!=(RRtpSession)
TBool	operator==(RRtpSession)

Detailed Description

A handle to an RTP session.

This is the interface to the socket-level RTP service, and provides additional facilities such as header parsing, re-ordering out-of-order packets, demultiplexing multiple sources etc.

The class abstracts all RTP information going to/from a RTP socket, and its corresponding RTCP data.

Each RTP endpoint on a device needs its own RTP session.

Multiple hosts streaming to a port on this device correspond to different RRtpReceiveSource objects associated with the session.

The class behaviour assumes that an active scheduler has already been created and started; the class does not function correctly if not.

Member Enumeration Documentation

Enum TRtpSendPacketType

A set of bit values passed as a parameter to RRtpSession::SendRTCPPacketL() to specify the SDES (Source Description) items that are to be sent with the packet. One or more of these may be set.

Enumerator	Value	Description
ERtcpPacketCNAME	1	Canonical End-Point Identifier SDES Item.
ERtcpPacketNAME	2	User Name SDES Item.
ERtcpPacketEMAIL	4	Electronic Mail Address SDES Item.
ERtcpPacketPHONE	8	Phone Number SDES Item.
ERtcpPacketLOC	16	Geographic User Location SDES Item.
ERtcpPacketTOOL	32	Application or Tool Name SDES Item
ERtcpPacketNOTE	64	Notice/Status SDES Item
ERtcpPacketPRIV	128	Private Extensions SDES Item

Constructor & Destructor Documentation

RRtpSession ( )

RRtpSession

(

)

[inline]

Member Function Documentation

Close ( )

IMPORT_C void

(

)

Closes the session.

All RRtpSendSource and RRtpReceiveSource objects associated with this session are closed.

DisableNonRtpData ( )

IMPORT_C void

DisableNonRtpData

(

)

Disables the receipt of non RTP data

DontReceive ( TInt )

IMPORT_C void

DontReceive

(

TInt

aRtpOrRtcp

)

Enables Receive only option for rtp or rtcp

Parameters
aRtpOrRtcp	Takes the values from the enum TPacketType

GetRRs ( )

IMPORT_C RRtcpRRPart

GetRRs

(

)

Gets an array contining the most recent RR (Receiver Report) from all hosts who are reporting on our send stream.

Return Value: The array of RRs.The array of RRs.

GetSDES ( const TInt, TDes8 & )

IMPORT_C TInt	GetSDES	(	const TInt	aType,
			TDes8 &	aValue
		)

Gets the data associated with the specified RTCP SDES (Source Description) item.

Note a that the PRIV (Private Extensions) SDES item is not supported by this mechanism.

Gets the data associated with the specified RTCP SDES (Source Description) item.

Note a that the PRIV (Private Extensions) SDES item is not supported by this mechanism.

Parameters
aType	The value identifying the RTCP SDES item.
aValue	A descriptor reference to the SDES item data.

Return Value: KErrNotFound if the item type was not found in the most recent RTCP packet KErrNone if the operation is successfulKErrNotFound if the item type was not found in the most recent RTCP packet KErrNone if the operation is successful

IsOpen ( )

TBool

IsOpen

(

)

const [inline]

Tests whether the RTP session represented by this handle is open.

Return Value: ETrue, if the session is open, false otherwise.

MaxRXSize ( )

IMPORT_C TInt

MaxRXSize

(

)

Gets the current expected maximum size of a received packet.

Return Value: The current expected maximum receive size.

Panic Codes
RTP	3 if the session has not been opened and initialised. Note that this panic is raised in debug mode only.

NewReceiveSourceL ( )

IMPORT_C RRtpReceiveSource

NewReceiveSourceL

(

)

Creates a new receive stream, and returns the receive stream handle.

This function should only be called in response to an ERtpNewSource event.

NewReceiveSourceLC ( )

IMPORT_C RRtpReceiveSource

NewReceiveSourceLC

(

)

Creates a new receive stream, puts a pointer to the receive stream object onto the cleanup stack, and returns the receive stream handle.

This function should only be called in response to an ERtpNewSource event.

Note that the function does not put a pointer to the RRtpReceiveSource object onto the cleanup stack as you might normally expect, but puts a pointer to the receive stream object for which the returned RRtpReceiveSource is the handle.

Note also that the API does not give you access to the receive stream object for which the returned RRtpReceiveSource is the handle.

NewSendSourceL ( )

IMPORT_C RRtpSendSource

NewSendSourceL

(

)

Creates a new send stream, and returns the send stream handle.

Only one send stream per session is permitted, which means that you must not call this function if the send stream has already been created.

As the send stream is an active object, it cannot handle request completion events until control returns to the active scheduler. Typically, clients will want to add event registrations before that.

The Code panics if the SendSource has alredy been opened.

This function may leave if memory is not enough.

Creates a new send stream, and returns the send stream handle.

Only one send stream per session is permitted, which means that you must not call this function if the send stream has already been created.

As the send stream is an active object, it cannot handle request completion events until control returns to the active scheduler. Typically, clients will want to add event registrations before that.

Return Value: The send stream handle.The send stream handle.

NonRtcpDataL ( )

IMPORT_C TPtr8

NonRtcpDataL

(

)

Gets the last received non RTCP data, If no data found function leaves

Return Value: Returns the last received non RTCP dataReturns the last received non RTCP data

NonRtpDataL ( )

IMPORT_C const TDesC8 &

NonRtpDataL

(

)

Gets the last received non RTP data, If no data found function leaves

Return Value: Returns the last received non RTP dataReturns the last received non RTP data

OpenL ( RSocketServ &, TSockAddr &, TSockAddr &, TInt, RConnection &, TInt, const TDesC8 & )

IMPORT_C void	OpenL	(	RSocketServ &	aServer,
			TSockAddr &	aLocalAddr,
			TSockAddr &	aRemoteAddr,
			TInt	aMaxRXSize,
			RConnection &	aConnection,
			TInt	aPriority = EPriorityNormal,
			const TDesC8 &	aCNAME = KNullDesC8
		)

Opens the RTP session and initialises it.

No events will be generated until after control returns to the active scheduler. After successfully opening the session, the client has the opportunity to initialise the object by adding the event callbacks, that it requires.

See also: CActive

Parameters
aServer	An already opened socket server session
aLocalAddr	The socket address to bind to at this end.
aRemoteAddr	The remote socket address.
aMaxRXSize	The maximum expected size of a received packet. Note that this includes the packet header (as it is profile dependent).
aConnection	A started RConnection for the interface to open this session on.
aPriority	The priority to be used for internal active objects.
aCNAME	The CNAME (Canonical End-Point Identifier).

OpenL ( RSocketServ &, TSockAddr &, TSockAddr &, TInt, TInt, const TDesC8 & )

IMPORT_C void	OpenL	(	RSocketServ &	aServer,
			TSockAddr &	aLocalAddr,
			TSockAddr &	aRemoteAddr,
			TInt	aMaxRXSize,
			TInt	aPriority = EPriorityNormal,
			const TDesC8 &	aCNAME = KNullDesC8
		)

Opens the RTP session and initialises it.

See also: CActive

Parameters
aServer	An already opened socket server session
aLocalAddr	The socket address to bind to at this end.
aRemoteAddr	The remote socket address.
aMaxRXSize	The maximum expected size of a received packet. Note that this includes the packet header (as it is profile dependent).
aPriority	The priority to be used for internal active objects.
aCNAME	The CNAME (Canonical End-Point Identifier). RTCP is used only if CNAME is provided

OpenL ( RSocket &, TInt, RSocket &, TInt, const TDesC8 & )

IMPORT_C void	OpenL	(	RSocket &	aSocket,
			TInt	aMaxRXSize,
			RSocket &	aRtcpSocket,
			TInt	aPriority = EPriorityNormal,
			const TDesC8 &	aCNAME = KNullDesC8
		)

Opens the session and initialises it.

No events will be generated until after control returns to the active scheduler. The client has this time to initialise the object by adding event callbacks.

Opens the session and initialises it with RTCP.

See also: CActive

Parameters
aSocket	An already connected Socket.
aMaxRXSize	The maximum expected size of a received packet. Note that this includes the packet header (as it is profile dependent).
aRtcpSocket	The RTCP socket.
aPriority	The priority to be used for internal active objects.
aCNAME	The CNAME. A sensible default is supplied if none is provided.

OpenL ( RSocket &, TInt, TInt )

IMPORT_C void	OpenL	(	RSocket &	aSocket,
			TInt	aMaxRXSize,
			TInt	aPriority = EPriorityNormal
		)

Opens the session and initialises it without RTCP.

See also: CActive

Parameters
aSocket	An already connected socket.
aMaxRXSize	The maximum expected size of a received packet. Note that this includes the packet header (as it is profile dependent).
aPriority	The priority to be used for internal active objects.

OpenL ( RSocketServ &, TSockAddr &, TSockAddr &, TInt, RSubConnection &, TInt, const TDesC8 & )

IMPORT_C void	OpenL	(	RSocketServ &	aServer,
			TSockAddr &	aLocalAddr,
			TSockAddr &	aRemoteAddr,
			TInt	aMaxRXSize,
			RSubConnection &	aSubConnection,
			TInt	aPriority = EPriorityNormal,
			const TDesC8 &	aCNAME = KNullDesC8
		)

Opens the session and initialises it.

No events will be generated until after control returns to the active scheduler. The client has this time to initialise the object by adding event callbacks.

This API uses the RTP Stack implemented as a CF Prorotocol. The SubConnection which is passed to the API should be initialised with the RTP Params.

Opens the RTP session and initialises it.

See also: CActive

Parameters
aServer	An already opened socket server session
aLocalAddr	The socket address to bind to at this end.
aRemoteAddr	The remote socket address.
aMaxRXSize	The maximum expected size of a received packet. Note that this includes the packet header (as it is profile dependent).
aSubConnection	The subconnection with RTP Parametrs set on it.
aPriority	The priority to be used for internal active objects.
aCNAME	The CNAME (Canonical End-Point Identifier). RTCP is used only if CNAME is provided

PrivRegisterEventCallbackL ( TUint, TRtpCallbackFunction, TAny *, TInt )

IMPORT_C void	PrivRegisterEventCallbackL	(	TUint	aType,
			TRtpCallbackFunction	aCallback,
			TAny *	aPtr,
			TInt	aParameter
		)

The event manager contains a number of callback registrations, each of which binds a function and pointer (normally an object) to a particular kind of event. Registrations can be bound to all events on a stream.

If a function is registered for a particular event, it will be called when that event occurs. One callback function can be associated with more than 1 callback registration. Callback functions take a pointer argument which was supplied as part of the registration

Parameters
aType	Event type
aCallback	Callback object
aPtr	Pointer to data that needs to be passed to the callback function
aParameter	Parameter to be passed to internal callback subsystem

PrivRegisterEventCallbackL ( TUint, TRtpCallbackFunction, TAny * )

IMPORT_C void	PrivRegisterEventCallbackL	(	TUint	aType,
			TRtpCallbackFunction	aCallback,
			TAny *	aPtr
		)

Parameters
aType	Event type
aCallback	Callback object
aPtr	Pointer to data that needs to be passed to the callback function

RTCPAutoSend ( )

IMPORT_C TBool

RTCPAutoSend

(

)

const

Gets the RTCP Auto Send status.

Return Value: True, if RTCP SR, RR and SDES packets are automatically sent, false otherwiseTrue, if RTCP SR, RR and SDES packets are automatically sent, false otherwise

RegisterEventCallbackL ( TRtpEventType, void()(T , const TRtpEvent &), T *, TRtpOneShotness, TInt )

void	RegisterEventCallbackL	(	TRtpEventType	aType,
			void()(T , const TRtpEvent &)	aCallback,
			T *	aPtr,
			TRtpOneShotness	aOneShot,
			TInt	aParameter
		)	[inline]

Registers a callback for the specified event.

Some compilers may not support templated member functions. A static version of this function is available that offers the same behaviour: RegisterEventCallbackL(RRtpSession,TRtpEventType,void (*aCallback)(T*, const TRtpEvent&),T*,TRtpOneShotness,TInt)

Parameters
aType	The type of event.
aCallback	The callback function. The function is templated, and is prototyped to take a pointer to an object of the template type and a const reference to a TRtpEvent. The function returns void.
aPtr	A pointer that is passed to the callback function when that function is called.
aOneShot	Indicates whether the callback function is only called once, or can be called more than once.
aParameter	A parameter to be passed to the registration function. The meaning of this depends entirely on the event type. The parameter is optional - the other overload of this function is available for registrations that don't need to pass a parameter.

RegisterEventCallbackL ( TRtpEventType, void()(T , const TRtpEvent &), T *, TRtpOneShotness )

void	RegisterEventCallbackL	(	TRtpEventType	aType,
			void()(T , const TRtpEvent &)	aCallback,
			T *	aPtr,
			TRtpOneShotness	aOneShot = ERtpNotOneShot
		)	[inline]

Registers a callback for the specified event.

Parameters
aType	The type of event.
aCallback	The callback function. The function is templated, and is prototyped to take a pointer to an object of the template type and a const reference to a TRtpEvent. The function returns void.
aPtr	A pointer that is passed to the callback function when that function is called.
aOneShot	Indicates whether the callback function is only called once, or can be called more than once. If not specified, the default is to allow the callback function to be called more than once.

RtcpSocket ( )

IMPORT_C RSocket *

RtcpSocket

(

)

Gets a handle to the RTCP socket; it provides a direct access to the functionality of RTCP socket.

Return Value: The RTCP socket for the current sessionThe RTCP socket for the current session

RtcpStatistics ( TUint32, TRtcpStatistics & )

IMPORT_C TInt	RtcpStatistics	(	TUint32	aSsrc,
			TRtcpStatistics &	aRtcpStatistics
		)

Gets the remote RTCP Statistics for the current RTP session

Gets the remote RTCP Staistics for the current RTP session

RtpSocket ( )

IMPORT_C RSocket *

RtpSocket

(

)

Gets a handle to the RTP socket; it provides a direct access to the functionality of RTP socket.

Return Value: The RTP socket for the current sessionThe RTP socket for the current session

SendAPPL ( const TDesC8 &, const TDesC8 &, TUint8 )

IMPORT_C void	SendAPPL	(	const TDesC8 &	aName,
			const TDesC8 &	aAppData = KNullDesC8,
			TUint8	aSubType = 0
		)

Sends an APP (Application Defined) RTCP Packet.

The packet is sent immediately.

If used with RTCP auto-send, the function disrupts the auto-send intervals. Note however that Symbian reserves the right to fix this.

Sends an RTCP APP packet.

Parameters
aName	Application name(4-bytes)
aAppData	Application specific data
aSubType	Application defined subtype

SendDataL ( TBool, const TDesC8 &, TRequestStatus & )

IMPORT_C void	SendDataL	(	TBool	aSocketType,
			const TDesC8 &	aData,
			TRequestStatus &	aStatus
		)

Send a non-RTP (control) data packet asynchronously

Parameters
aSocketType	SocketType that tells whether non RTP data has to go through RTP or RTCP socket
aData	Non RTP data that has to be sent
aStatus	Tells whether the data has been sent successfully

SendRTCPPacketL ( TDesC8 & )

IMPORT_C void

SendRTCPPacketL

(

TDesC8 &

aPacket

)

Sends an RTCP packet now.

Calling this function doesn't make much sense if auto-send is on, as it will result in packets being sent at rather incoherent intervals.

Example:

If every report has go with CNAME,LOC and PRIV... then set flags as fallows..

SDES Flags: 1 2 3 4 5 6 7 8 1 0 0 0 1 0 0 1

Parameters
aPacket	The RTCP packet to be sent

SendSource ( )

IMPORT_C RRtpSendSource

SendSource

(

)

Gets the handle to the send stream object associated with this session.

The send stream object is the one created in a previous call to NewSendSourceL(). If the send stream object has not been created, then the returned handle will refer to a closed send stream.

Returns the existing send stream handle.

As the send stream is an active object, it cannot handle request completion events until control returns to the active scheduler. Typically, clients will want to add event registrations before that.

Return Value: The handle to the send stream object.The send stream handle.

SetBandwidth ( TUint )

IMPORT_C void

SetBandwidth

(

TUint

aBandwidth

)

Sets the estimated bandwidth used by the session.

This is used to decide when to send RTCP status packets. The default value is read from a resource file and should be a reasonably sensible default based on the maximum bandwidth of the handset.

Sets the estimated bandwidth used by the session.

This is used to decide when to send RTCP status packets. The default value is read from a resource file and should be a reasonably sensible default based on the maximum bandwidth of the handset.

Parameters
aBandwidth	The bandwidth in bps.

SetMaxRXSize ( TInt )

IMPORT_C void

SetMaxRXSize

(

TInt

aMaxRXSize

)

Sets the expected maximum size of a received packet.

This does not affect the packet that is being downloaded or is being waited for, so it is entirely possible that the first packet received after correctly setting the receive packet size will still overflow.

Parameters
aMaxRXSize	The new expected maximum size.

Panic Codes
RTP	3 if the session has not been opened and initialised. Note that this panic is raised in debug mode only.

SetPRIVL ( const TDesC8 &, const TDesC8 & )

IMPORT_C TInt	SetPRIVL	(	const TDesC8 &	aPrefix,
			const TDesC8 &	aValue
		)

Sets the data associated with the PRIV (Private Extensions) SDES item.

Stores an SDES PRIV packet information to be sent in the impending timer-exprity event.

Parameters
aPrefix	The prefix name
aValue	The prefix value. This must be less than 256 - length of prefix string, else the function returns KErrTooBig error.

Return Value: KErrTooBig if the length of the aValue and aPrefix combined is more than KMaxSdesItemLength(=255) KErrNone if the operation is successfulKErrTooBig If the size of aValue is more than 255- length of prefix string KErrNone Successful operation

SetPrePostProcessingRegisterCallback ( MPrePostProcessingCallback * )

IMPORT_C void

SetPrePostProcessingRegisterCallback

(

MPrePostProcessingCallback *

aPrePostProcessingCallback

)

Pre and Post processing function for RTP and RTCP packets

SetRTCPAutoSend ( TBool )

IMPORT_C void

SetRTCPAutoSend

(

TBool

aAutoSend

)

Enables or disables the automatic sending of RTCP SR (Sender Report), RR (Receiver Report), and SDES (Source Description) packets.

Note that if automatic sending is not enabled and RTCP sending is required, then explicit calls to SendRTCPPacketL() will be required.

Enables or disables the automatic sending of RTCP SR (Sender Report), RR (Receiver Report), and SDES (Source Description) packets.

Note that if automatic sending is not enabled and RTCP sending is required, then explicit calls to SendRTCPPacketL() will be required.

Parameters
aAutoSend	ETrue, if RTCP packets need to be send automatically EFalse otherwise.

SetRTPTimeConversion ( TUint, TUint )

IMPORT_C void	SetRTPTimeConversion	(	TUint	aNow,
			TUint	aConversion
		)

Supplies information about the profile-specific RTP timestamps.

This is used to generate the RTP timestamps in RTCP packets. It is not used to generate timestamps in RTP packets as they must accurately relate to the time of the sample.

Supplies information about the profile-specific RTP timestamps.

This is used to generate the RTP timestamps in RTCP packets. It is not used to generate timestamps in RTP packets as they must accurately relate to the time of the sample.

Parameters
aNow	The time now in RTP format
aConversion	The number of nanoseconds per RTP timer tick.

SetRemoteAddress ( const TSockAddr & )

IMPORT_C void

SetRemoteAddress

(

const TSockAddr &

aRemoteAddr

)

Sets the remote RTP address for the current RTP session

Sets the remote RTP address for the current active session

Parameters
aRemoteAddr	Remote RTP address to be set

SetRemoteRtcpPort ( TUint )

IMPORT_C void

SetRemoteRtcpPort

(

TUint

aPort

)

Sets the remote RTCP port for the current active RTP session

SetRtcpInterval ( TTimeIntervalMicroSeconds32 & )

IMPORT_C void

SetRtcpInterval

(

TTimeIntervalMicroSeconds32 &

aInterval

)

Sets the RTCP Auto Send interval. This disables the RFC based calculation of RTCP intervals. To re-enable auto calculation, set the interval to zero.

Parameters
aInterval	Time interval after which an RTCP auto-send will take place

SetRtpStreamParameters ( TInt, TInt, TInt )

IMPORT_C void	SetRtpStreamParameters	(	TInt	aMinSequential,
			TInt	aMaxMisorder,
			TInt	aMaxDropout
		)

Sets the number of sequential packets that must be received before a stream is considered good.

Sets the maximum number of dropped packets to be considered a dropout, as opposed to an ended and restarted stream.

Sets the maximum number of packets by which a packet can be delayed before it is considered dropped.

Post-condition: The session will be 'restarted', i.e. it resets the sequence number sequence and resets all RTCP statistics.

Sets the number of sequential packets that must be received before a stream is considered good.

Sets the maximum number of dropped packets to be considered a dropout, as opposed to an ended and restarted stream.

Sets the maximum number of packets by which a packet can be delayed before it is considered dropped.

Post-condition: The session will be 'restarted', i.e. it resets the sequence number sequence and resets all RTCP statistics.

Parameters
aMinSequential	The number of sequential packets.
aMaxMisorder	The maximum number of packets.
aMaxDropout	The number of sequential packets.

SetSDESL ( TInt, const TDesC8 & )

IMPORT_C TInt	SetSDESL	(	TInt	aType,
			const TDesC8 &	aValue
		)

Sets the data associated with the specified RTCP SDES (Source Description) item for sending in the next SDES packet only.

The function Leaves if duplicate values are set for the same CNAME.

The SDES Items set by this API is valid only till the stack sends the next RTCP Packet. The list of items(except CNAME and NONE) is flushed after every RTCP report is sent

Note a that the PRIV (Private Extensions) SDES item is not supported by this mechanism.

NOTE - This call cannot be used to set a different CNAME for this session. The default CNAME is send with every SDES packets.

Stores an SDES packet information to be sent in the impending timer-exprity event.

Parameters
aType	The item type
aValue	The item value. This must be less than 256 else the function returns KErrTooBig error.

Return Value: KErrTooBig if the length of the aValue is more than KMaxSdesItemLength(=255) KErrNone if the operation is successfulKErrTooBig If the size of aValue is more than 255 KErrNone Successful operation

SetSamplingRate ( TInt, TUint )

IMPORT_C TInt	SetSamplingRate	(	TInt	aPayloadType,
			TUint	aSamplingRate
		)

Sets the sampling rate for a Particular Payloadtype Sets the sampling rate for a Particular Payloadtype

Parameters
aPayloadType	PayloadType ( Should be between 96-127 ) see RFC 3551

operator!= ( RRtpSession )

TBool

operator!=

(

RRtpSession

aThat

)

const [inline]

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

Parameters
aThat	The handle of the session to be compared.

Return Value: ETrue, if the represented sessions are different, false otherwise.

operator== ( RRtpSession )

TBool

operator==

(

RRtpSession

aThat

)

const [inline]

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

Parameters
aThat	The handle of the session to be compared.

Return Value: ETrue, if the represented sessions are the same, false otherwise.

RRtpSession Class Reference

Detailed Description

Member Enumeration Documentation

Enum TRtpSendPacketType

Constructor & Destructor Documentation

RRtpSession ( )

Member Function Documentation

Close ( )

DisableNonRtpData ( )

DontReceive ( TInt )

GetRRs ( )

GetSDES ( const TInt, TDes8 & )

IsOpen ( )

MaxRXSize ( )

NewReceiveSourceL ( )

NewReceiveSourceLC ( )

NewSendSourceL ( )

NonRtcpDataL ( )

NonRtpDataL ( )

OpenL ( RSocketServ &, TSockAddr &, TSockAddr &, TInt, RConnection &, TInt, const TDesC8 & )

OpenL ( RSocketServ &, TSockAddr &, TSockAddr &, TInt, TInt, const TDesC8 & )

OpenL ( RSocket &, TInt, RSocket &, TInt, const TDesC8 & )

OpenL ( RSocket &, TInt, TInt )

OpenL ( RSocketServ &, TSockAddr &, TSockAddr &, TInt, RSubConnection &, TInt, const TDesC8 & )

PrivRegisterEventCallbackL ( TUint, TRtpCallbackFunction, TAny *, TInt )

PrivRegisterEventCallbackL ( TUint, TRtpCallbackFunction, TAny * )

RTCPAutoSend ( )

RegisterEventCallbackL ( TRtpEventType, void(*)(T *, const TRtpEvent &), T *, TRtpOneShotness, TInt )

RegisterEventCallbackL ( TRtpEventType, void(*)(T *, const TRtpEvent &), T *, TRtpOneShotness )

RtcpSocket ( )

RtcpStatistics ( TUint32, TRtcpStatistics & )

RtpSocket ( )

SendAPPL ( const TDesC8 &, const TDesC8 &, TUint8 )

SendDataL ( TBool, const TDesC8 &, TRequestStatus & )

SendRTCPPacketL ( TDesC8 & )

SendSource ( )

SetBandwidth ( TUint )

SetMaxRXSize ( TInt )

SetPRIVL ( const TDesC8 &, const TDesC8 & )

SetPrePostProcessingRegisterCallback ( MPrePostProcessingCallback * )

SetRTCPAutoSend ( TBool )

SetRTPTimeConversion ( TUint, TUint )

SetRemoteAddress ( const TSockAddr & )

SetRemoteRtcpPort ( TUint )

SetRtcpInterval ( TTimeIntervalMicroSeconds32 & )

SetRtpStreamParameters ( TInt, TInt, TInt )

SetSDESL ( TInt, const TDesC8 & )

SetSamplingRate ( TInt, TUint )

operator!= ( RRtpSession )

operator== ( RRtpSession )

RegisterEventCallbackL ( TRtpEventType, void()(T , const TRtpEvent &), T *, TRtpOneShotness, TInt )

RegisterEventCallbackL ( TRtpEventType, void()(T , const TRtpEvent &), T *, TRtpOneShotness )