#include <mw/rtp.h>
| class RRtpReceiveSource |
| Public Member Functions | |
|---|---|
| RRtpReceiveSource() | |
| IMPORT_C void | Close() |
| IMPORT_C TDesC8 & | GetByeReason() |
| IMPORT_C void | GetLastApp(TPtrC8 &, TPtrC8 &, TUint &) |
| IMPORT_C TInt | GetSDES(const TInt, TDes8 &) |
| IMPORT_C RRtcpSRPart | GetSR() |
| TBool | IsOpen() |
| IMPORT_C RRtpReceivePacket | Packet() |
| IMPORT_C TUint | PayLoadTypeL() |
| IMPORT_C void | PrivRegisterEventCallbackL(TUint, TRtpCallbackFunction, TAny *, TInt) |
| IMPORT_C void | PrivRegisterEventCallbackL(TUint, TRtpCallbackFunction, TAny *) |
| void | RegisterEventCallbackL(TRtpEventType, void(*)(T *, const TRtpEvent &), T *, TRtpOneShotness, TInt) |
| void | RegisterEventCallbackL(TRtpEventType, void(*)(T *, const TRtpEvent &), T *, TRtpOneShotness) |
| IMPORT_C TUint | SSRC() |
| TBool | operator!=(RRtpReceiveSource) |
| TBool | operator==(RRtpReceiveSource) |
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.
| IMPORT_C void | Close | ( | ) |
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.
| IMPORT_C TDesC8 & | GetByeReason | ( | ) |
Gets the reason for a BYE packet.
Returns: A descriptor contaning the BYE message. This is KNullDesC if the source has not sent a BYE packet.
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.
| Parameter | Description |
|---|---|
| aType | The value identifying the RTCP SDES item. |
Returns: A descriptor reference to the SDES item data.
| IMPORT_C RRtcpSRPart | GetSR | ( | ) |
Gets the most recent SR ((Sender Report) from this SSRC.
Returns: A handle to the SR.
| TBool | IsOpen | ( | ) | const [inline] |
Tests whether the receive stream represented by this handle is open.
Returns: ETrue, if the receive stream is open, false otherwise.
| IMPORT_C RRtpReceivePacket | Packet | ( | ) |
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.
Returns: A received RTP packet.
| IMPORT_C TUint | PayLoadTypeL | ( | ) |
Returns the payloadtype of the newly arrived packet. Should be called before the packet() function. If an open Packet is not present the function will leave with KErrNotFound.
| 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
| Parameter | Description |
|---|---|
| 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 |
| IMPORT_C void | PrivRegisterEventCallbackL | ( | TUint | aType, |
| TRtpCallbackFunction | aCallback, | |||
| TAny * | aPtr | |||
| ) | ||||
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
| Parameter | Description |
|---|---|
| aType | Event type |
| aCallback | Callback object |
| aPtr | Pointer to data that needs to be passed to the callback function |
| void | RegisterEventCallbackL | ( | TRtpEventType | aType, |
| void(*)(T *, const TRtpEvent &) | aCallback, | |||
| T * | aPtr, | |||
| TRtpOneShotness | aOneShot, | |||
| TInt | aParameter | |||
| ) | [inline] | |||
| void | RegisterEventCallbackL | ( | TRtpEventType | aType, |
| void(*)(T *, const TRtpEvent &) | aCallback, | |||
| T * | aPtr, | |||
| TRtpOneShotness | aOneShot = ERtpNotOneShot | |||
| ) | [inline] | |||
| IMPORT_C TUint | SSRC | ( | ) | const |
Gets the SSRC of the remote end
Gets the SSRC, the 32-bit numeric synchronisation source identifier.
Returns: The SSRC of the remote endThe 32-bit SSRC identifier.
| TBool | operator!= | ( | RRtpReceiveSource | aThat | ) | const [inline] |
Tests whether this receive stream handle represents a different receive stream to the one represented by the specified handle.
| Parameter | Description |
|---|---|
| aThat | The handle of the receive stream to be compared. |
Returns: ETrue, if the represented receive streams are different, false otherwise.
| TBool | operator== | ( | RRtpReceiveSource | aThat | ) | const [inline] |
Tests whether this receive stream handle represents the same receive stream as the one represented by the specified handle.
| Parameter | Description |
|---|---|
| aThat | The handle of the receive stream to be compared. |
Returns: ETrue, if the represented receive streams are the same, false otherwise.