Class RRtpReceiveSource

class RRtpReceiveSource;

Description

A handle to a receive stream.

An object of this type represents the stream of data on a single SSRC and delivers the RTP packets and RTCP information in the order they arrive.

Note that RTP does not guarantee the order of delivery, which means that the client may want to buffer the data.

Members

Defined in RRtpReceiveSource:
Close(), IsOpen(), Packet(), RRtpReceiveSource(), RegisterEventCallbackL(), RegisterEventCallbackL(), operator!=(), operator==()

inline RRtpReceiveSource();

Description

Default constructor

inline TBool IsOpen() const;

Description

Tests whether the receive stream represented by this handle is open.

Return value

TBool ETrue, if the receive stream is open, false otherwise.

IMPORT_C void Close();

Description

Closes the receive stream releases all associated resources.

This includes closing all RRtpReceivePacket objects that have not already been closed.

The receive stream object cannot be closed if an event is currently being handled, i.e. a call back into client code is currently in progress.

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

Description

Parameters

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

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

Description

Parameters

TRtpEventType aType void(*)(T *, const TRtpEvent &) aCallback T *aPtr TRtpOneShotness aOneShot

IMPORT_C RRtpReceivePacket Packet();

Description

Gets the packet that has just arrived, or a closed packet if there isn't one.

Ownership of the packet is transferred to the caller of this function.

Note that if this function is called twice in quick succession, then it will return a closed packet the second time.

Return value

RRtpReceivePacket A received RTP packet.

inline TBool operator==(RRtpReceiveSource aThat) const;

Description

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

Parameters

RRtpReceiveSource aThat The handle of the receive stream to be compared.

Return value

TBool ETrue, if the represented receive streams are the same, false otherwise.

inline TBool operator!=(RRtpReceiveSource aThat) const;

Description

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

Parameters

RRtpReceiveSource aThat The handle of the receive stream to be compared.

Return value

TBool ETrue, if the represented receive streams are different, false otherwise.