| class RRtpSendSource |
A handle to a send stream.
Use this class to manage the creation and sending of packets. A session can have only one send stream.
Only one packet can be sent at any one time. Once a packet has been sent, the packet cannot be closed and no further packets can be sent until an event signalling the completion of the send operation has occurred. This will be one of the events defined by the enum values: ERtpSendSucceeded and ERtpSendFail.
A client must monitor these events so that it can schedule the sending of subsequent packets. It does this by implementing and registering callback functions that handle these events.
| Public Member Functions | |
|---|---|
| RRtpSendSource() | |
| IMPORT_C TInt | Alignment() |
| IMPORT_C void | ByeL(TDesC8 &) |
| IMPORT_C void | Cancel() |
| IMPORT_C void | Close() |
| IMPORT_C TUint32 | GetLocalSSRC() |
| TBool | IsOpen() |
| IMPORT_C TBool | IsSending() |
| IMPORT_C RRtpSendPacket | NewSendPacketL(TInt, TInt) |
| IMPORT_C RRtpSendPacket | NewSendPacketLC(TInt, TInt) |
| 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 void | SetAlignment(TInt) |
| IMPORT_C void | SetDefaultPayloadSize(TInt) |
| IMPORT_C void | SetPayloadType(TUint) |
| TBool | operator!=(RRtpSendSource) |
| TBool | operator==(RRtpSendSource) |
| Private Attributes | |
|---|---|
| CRtpSendSource * | iPtr |
| IMPORT_C void | ByeL | ( | TDesC8 & | aReason | ) |
Sends a Bye RTCP packet.
| TDesC8 & aReason | The reason for sending the Bye RTCP packet. |
| TBool | IsOpen | ( | ) | const [inline] |
Tests whether the send stream represented by this handle is open.
ETrue, if the send stream is open, false otherwise.
| IMPORT_C RRtpSendPacket | NewSendPacketL | ( | TInt | aPayloadSize = 0, |
| TInt | aHeaderExtensionSize = KRtpNoExtension | |||
| ) | ||||
| TInt aPayloadSize = 0 | |
| TInt aHeaderExtensionSize = KRtpNoExtension |
| IMPORT_C RRtpSendPacket | NewSendPacketLC | ( | TInt | aPayloadSize = 0, |
| TInt | aHeaderExtensionSize = KRtpNoExtension | |||
| ) | ||||
| TInt aPayloadSize = 0 | |
| TInt aHeaderExtensionSize = KRtpNoExtension |
| 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
| TUint aType | Event type |
| TRtpCallbackFunction aCallback | Callback object |
| TAny * aPtr | Pointer to data that needs to be passed to the callback function |
| TInt 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
| TUint aType | Event type |
| TRtpCallbackFunction aCallback | Callback object |
| TAny * 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] | |||
| TRtpEventType aType | |
| void(*)(T *, const TRtpEvent &) aCallback | |
| T * aPtr | |
| TRtpOneShotness aOneShot | |
| TInt aParameter |
| void | RegisterEventCallbackL | ( | TRtpEventType | aType, |
| void(*)(T *, const TRtpEvent &) | aCallback, | |||
| T * | aPtr, | |||
| TRtpOneShotness | aOneShot = ERtpNotOneShot | |||
| ) | [inline] | |||
| TRtpEventType aType | |
| void(*)(T *, const TRtpEvent &) aCallback | |
| T * aPtr | |
| TRtpOneShotness aOneShot = ERtpNotOneShot |
| IMPORT_C void | SetDefaultPayloadSize | ( | TInt | aPayloadSize | ) |
| TInt aPayloadSize |
| TBool | operator!= | ( | RRtpSendSource | aThat | ) | const [inline] |
Tests whether this send stream handle represents a different send stream to the one represented by the specified handle.
ETrue, if the represented send streams are different, false otherwise.
| RRtpSendSource aThat | The handle of the send stream to be compared. |
| TBool | operator== | ( | RRtpSendSource | aThat | ) | const [inline] |
Tests whether this send stream handle represents the same send stream as the one represented by the specified handle.
ETrue, if the represented send streams are the same, false otherwise.
| RRtpSendSource aThat | The handle of the send stream to be compared. |