Class TRtpEvent

class TRtpEvent;

Description

An RTP event.

An event is generated when anything happens that a client might want to know about. The class encapulates two pieces of information: 1. An event type as defined by a TRtpEventType value. 2. Additional information whose meaning is dependent on the event type.

Additional information may be implicitly associated with the event, but still needs to be fetched from another object, for example, when processing an ERtpPacketReceived event, the packet (represented by a RRtpReceivePacket handle) must be obtained from the receive stream (represented by a RRtpReceiveStream handle).

Events are always associated with either an RTP session, a send stream or a receive stream, and this class has functions for getting the corresponding handle.

Members

Defined in TRtpEvent:
IsReceiveSourceEvent(), IsSendSourceEvent(), IsSessionEvent(), ReceiveSource(), SendSource(), Session(), Status(), TRtpEvent(), Type()

See also:

• RRtpSession
• RRtpSendSource
• RRtpReceiveSource

IMPORT_C TRtpEvent(TRtpEventType aType, TInt aStatus, TAny *aData);

Description

Constructor.

Parameters

TRtpEventType aType The event type. TInt aStatus The event status. TAny *aData Additional data that is dependent on the event type.

IMPORT_C RRtpSession Session() const;

Description

Gets a handle to the session associated with this event.

This function should only be called for events that are associated with an RTP session, otherwise it raises a panic.

Return value

RRtpSession

Panic codes

RTP 8 if the event is not associated with an RTP session. Note that this panic is raised in debug mode only; in release mode, calling this function on in inappropriate event is likely to raise panics such as KERN-EXEC 3.

See also:

• TRtpEvent::IsSessionEvent()

IMPORT_C RRtpSendSource SendSource() const;

Description

Gets a handle to the send stream associated with this event.

This function should only be called for events that are associated with a send stream, otherwise it raises a panic.

Return value

RRtpSendSource

Panic codes

RTP 8 if the event is not associated with a send stream. Note that this panic is raised in debug mode only; in release mode, calling this function on in inappropriate event is likely to raise panics such as KERN-EXEC 3.

See also:

• TRtpEvent::IsSendSourceEvent()

IMPORT_C RRtpReceiveSource ReceiveSource() const;

Description

Gets a handle to the receive stream associated with this event.

This function should only be called for events that are associated with a receive stream, otherwise it raises a panic.

Return value

RRtpReceiveSource

Panic codes

RTP 8 if the event is not associated with a receive stream. Note that this panic is raised in debug mode only; in release mode, calling this function on in inappropriate event is likely to raise panics such as KERN-EXEC 3.

See also:

• TRtpEvent::IsReceiveSourceEvent()

IMPORT_C TBool IsSessionEvent() const;

Description

Tests whether this event is associated with an RTP session.

Return value

TBool True, if this event is associated with an RTP session, false otherwise.

IMPORT_C TBool IsSendSourceEvent() const;

Description

Tests whether this event is associated with a send stream.

Return value

TBool True, if this event is associated with a send stream, false otherwise.

IMPORT_C TBool IsReceiveSourceEvent() const;

Description

Tests whether this event is associated with a receive stream.

Return value

TBool True, if this event is associated with a receive stream, false otherwise.

inline TRtpEventType Type() const;

Description

Gets the type of this event.

Return value

TRtpEventType The event type.

inline TInt Status() const;

Description

Gets the event status.

The meaning of this depends on the event type.

Return value

TInt

See also:

• TRtpEventType