![Symbian Developer Library](../../../../a_stock/images/mainheading.gif)
![]() |
![]() |
|
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.
Defined in RRtpSendSource
:
Alignment()const
Gets the alignment value.Cancel()
Cancels the outstanding send on the send StreamClose()
Closes the send stream.GetLocalSSRC()
IsOpen()const
Tests whether the send stream represented by this handle is open.IsSending()
Tests whether the send stream is currently sending an RTP packet.NewSendPacketL(TInt,TInt)
Creates a new RTP send packet, and returns the RTP send packet handle.NewSendPacketLC(TInt,TInt)
Creates a new RTP send packet, puts a pointer to the RTP send packet object onto...RRtpSendSource()
Default constructor RegisterEventCallbackL(TRtpEventType,void(*)(T *, const TRtpEvent &),T *,TRtpOneShotness)
RegisterEventCallbackL(TRtpEventType,void(*)(T *, const TRtpEvent &),T *,TRtpOneShotness,TInt)
SetAlignment(TInt)
Sets the alignment required for padding.SetDefaultPayloadSize(TInt)
Sets the default payload size for packets that are to be sent.SetPayloadType(TUint)
Sets the default payload type for packets that are to be sent.operator!=(RRtpSendSource)const
Tests whether this send stream handle represents a different send stream to the ...operator==(RRtpSendSource)const
Tests whether this send stream handle represents the same send stream as the one...inline TBool IsOpen() const;
Tests whether the send stream represented by this handle is open.
|
IMPORT_C void Close();
Closes the send stream.
The send 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 void Cancel();
Cancels the outstanding send on the send Stream
The send object must be cancelled if a send request is outstanding
inline void RegisterEventCallbackL(TRtpEventType aType, void(*aCallback)(T *, const TRtpEvent &), T *aPtr, TRtpOneShotness
aOneShot, TInt aParameter);
|
inline void RegisterEventCallbackL(TRtpEventType aType, void(*aCallback)(T *, const TRtpEvent &), T *aPtr, TRtpOneShotness
aOneShot=ERtpNotOneShot);
|
IMPORT_C RRtpSendPacket NewSendPacketL(TInt aPayloadSize=0, TInt aHeaderExtensionSize=KRtpNoExtension);
Creates a new RTP send packet, and returns the RTP send packet handle.
On return from this call, the packet is open but uninitialised, except for the payload type which is set to the default value
set by a previous call to RRtpSendSource::SetPayloadType(TUint)
The returned packet is owned by the caller of this function; it is not owned by the send stream. It must be explicitly closed
by a call to RRtpPacket::Close()
|
|
RRtpSendPacket::SetPayloadType(TUint)
Sets the RTP packet's payload type.RRtpPacket::Close()
Closes the RTP packet. KRtpNoExtension
...IMPORT_C RRtpSendPacket NewSendPacketLC(TInt aPayloadSize=0, TInt aHeaderExtensionSize=KRtpNoExtension);
Creates a new RTP send packet, puts a pointer to the RTP send packet object onto the cleanup stack, and returns the RTP send packet handle.
On return from this call, the packet is open but uninitialised, except for the payload type which is set to the default value
set by a previous call to RRtpSendSource::SetPayloadType(TUint)
The returned packet is owned by the caller of this function; it is not owned by the send stream. It must be explicitly closed
by a call to RRtpPacket::Close()
.
Note that the function does not put a pointer to the RRtpSendPacket
object onto the cleanup stack as you might normally expect, but puts a pointer to the RTP send packet object for which the
returned RRtpSendPacket
is the handle.
|
|
RRtpSendPacket::SetPayloadType(TUint)
Sets the RTP packet's payload type.RRtpPacket::Close()
Closes the RTP packet. KRtpNoExtension
...IMPORT_C TBool IsSending();
Tests whether the send stream is currently sending an RTP packet.
|
IMPORT_C void SetPayloadType(TUint aPayloadType);
Sets the default payload type for packets that are to be sent.
This is the payload type used when a new RTP send packet is created in calls to: RRtpSendSource::NewSendPacketL(TInt,TInt)
and RRtpSendSource::NewSendPacketLC(TInt,TInt)
.
|
RRtpSendSource::NewSendPacketLC(TInt,TInt)
Creates a new RTP send packet, puts a pointer to the RTP send packet object onto...RRtpSendSource::NewSendPacketL(TInt,TInt)
Creates a new RTP send packet, and returns the RTP send packet handle.IMPORT_C void SetDefaultPayloadSize(TInt aPayloadSize);
Sets the default payload size for packets that are to be sent.
This is the default payload size used when a new RTP send packet is created in calls to: RRtpSendSource::NewSendPacketL(TInt,TInt)
and RRtpSendSource::NewSendPacketLC(TInt,TInt)
.
|
RRtpSendSource::NewSendPacketLC(TInt,TInt)
Creates a new RTP send packet, puts a pointer to the RTP send packet object onto...RRtpSendSource::NewSendPacketL(TInt,TInt)
Creates a new RTP send packet, and returns the RTP send packet handle.IMPORT_C void SetAlignment(TInt aAlignment);
Sets the alignment required for padding.
After padding, all blocks will be a multiple of this length.
|
RRtpSendSource::Alignment()const
Gets the alignment value.IMPORT_C TInt Alignment() const;
Gets the alignment value.
|
RRtpSendSource::SetAlignment(TInt)
Sets the alignment required for padding.inline TBool operator==(RRtpSendSource aThat) const;
Tests whether this send stream handle represents the same send stream as the one represented by the specified handle.
|
|
inline TBool operator!=(RRtpSendSource aThat) const;
Tests whether this send stream handle represents a different send stream to the one represented by the specified handle.
|
|