#include <mw/rtp.h>
Link against: rtpremoved.lib
| class TRtpEvent |
| Public Member Functions | |
|---|---|
| TRtpEvent(TRtpEventType, TInt, TAny *) | |
| IMPORT_C TBool | IsReceiveSourceEvent() |
| IMPORT_C TBool | IsSendSourceEvent() |
| IMPORT_C TBool | IsSessionEvent() |
| IMPORT_C RRtpReceiveSource | ReceiveSource() |
| IMPORT_C RRtpSendSource | SendSource() |
| IMPORT_C RRtpSession | Session() |
| TInt | Status() |
| TRtpEventType | Type() |
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.
See also: RRtpSession RRtpSendSource RRtpReceiveSource
| IMPORT_C | TRtpEvent | ( | TRtpEventType | aType, |
| TInt | aStatus, | |||
| TAny * | aData | |||
| ) | ||||
Constructor.
| Parameters | |
|---|---|
| aType | The event type. |
| aStatus | The event status. |
| aData | Additional data that is dependent on the event type. |
| IMPORT_C TBool | IsReceiveSourceEvent | ( | ) | const |
Tests whether this event is associated with a receive stream.
| IMPORT_C TBool | IsSendSourceEvent | ( | ) | const |
Tests whether this event is associated with a send stream.
| IMPORT_C TBool | IsSessionEvent | ( | ) | const |
Tests whether this event is associated with an RTP session.
| IMPORT_C RRtpReceiveSource | ReceiveSource | ( | ) | const |
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.
See also: TRtpEvent::IsReceiveSourceEvent()
| 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. |
| IMPORT_C RRtpSendSource | SendSource | ( | ) | const |
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.
See also: TRtpEvent::IsSendSourceEvent()
| 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. |
| IMPORT_C RRtpSession | Session | ( | ) | const |
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.
See also: TRtpEvent::IsSessionEvent()
| 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. |