CMceRtpSource Class Reference

class CMceRtpSource : public CMceMediaSource

Class representing incoming RTP stream in MCE.

CMceRtpSource can be used to receive media data from network. It can be configured with stream specific values to avoid jitter generated by network. It may also be configured to recognize separate media bursts instead of just receiving continuous flow of data.

Events from this class can be received through class MMceRtpObserver.

Enable and Disable operations to it are considered to be local, so they are not signalled to remote terminal.

One CMceRTPSource may contain several RTP streams which are identified with synchronization source (SSRC) values. Disabling or enabling CMceRtpSource will affect to all SSRCs but streaming from specific SSRC can be also controlled with EnableSSRCL and Disable SSRCL methods. These are also local operations, thus not signalled to remote terminal.

mceclient.lib

Inherits from

Public Member Functions
~CMceRtpSource()
IMPORT_C voidDisableInactivityTimerL()
IMPORT_C voidDisableL()
IMPORT_C voidDisableSsrcL(TUint)
IMPORT_C voidEnableInactivityTimerL(TUint32)
IMPORT_C voidEnableL()
IMPORT_C voidEnableSsrcL(TUint)
TInt EventReceivedL(TMceEvent &)
IMPORT_C TBoolIsSsrcEnabledL(TUint)
IMPORT_C CMceRtpSource *NewL(TUint, TUint, TUint32, HBufC8 *)
IMPORT_C CMceRtpSource *NewLC(TUint, TUint, TUint32, HBufC8 *)
IMPORT_C voidSendRRL()
IMPORT_C TUint32Ssrc()
IMPORT_C const RArray< TUint > &Ssrcs()
IMPORT_C voidUpdateL(TUint, TUint, TUint32, HBufC8 *)
Private Member Functions
CMceRtpSource()
voidConstructL(TUint, TUint, TUint32, HBufC8 *, HBufC8 *)
voidDoITCSendL(TUint8)
TInt HandleEvent(TMceEvent &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CMceMediaSource::CMceMediaSource()
CMceMediaSource::CancelDtmfToneSequenceL()
CMceMediaSource::ConstructL(CMceComMediaSource *)
CMceMediaSource::DoDisableL()
CMceMediaSource::DoEnableL()
CMceMediaSource::DtmfActive()
CMceMediaSource::DtmfAvailable()
CMceMediaSource::Enabled(TBool)
CMceMediaSource::ExternalizeFlatL(RWriteStream &)
CMceMediaSource::ExternalizeL(MMceComSerializationContext &)
CMceMediaSource::Factory()
CMceMediaSource::Id()const
CMceMediaSource::InitializeL(CMceManager *)
CMceMediaSource::InitializeL(CMceMediaStream &)
CMceMediaSource::InternalizeFlatL(RReadStream &)
CMceMediaSource::InternalizeL(MMceComSerializationContext &)
CMceMediaSource::IsEnabled()const
CMceMediaSource::ReferenceCount()
CMceMediaSource::SendDtmfToneL(const TChar &,TTimeIntervalMicroSeconds32)
CMceMediaSource::SendDtmfToneSequenceL(const TDesC &)
CMceMediaSource::SerializationId()const
CMceMediaSource::StartDtmfToneL(const TChar &)
CMceMediaSource::StopDtmfToneL()
CMceMediaSource::StreamAddedL(CMceMediaStream &)
CMceMediaSource::Type()const
CMceMediaSource::UnInitialize(CMceMediaStream &)
CMceMediaSource::UpdateL(CMceMediaSource &)
CMceMediaSource::Updated()
CMceMediaSource::~CMceMediaSource()
Inherited Attributes
CMceMediaSource::iFlatData
CMceMediaSource::iParents
CMceMediaSource::iStream

Constructor & Destructor Documentation

CMceRtpSource()

CMceRtpSource()[private]

C++ default constructor.

~CMceRtpSource()

IMPORT_C~CMceRtpSource()

Destructor.

Member Functions Documentation

ConstructL(TUint, TUint, TUint32, HBufC8 *, HBufC8 *)

voidConstructL(TUintaBufferLength,
TUintaBufferTreshold,
TUint32aInactivityTimer,
HBufC8 *aMediaBurstIndicator,
HBufC8 *aIdentity
)[private]

second-phase constructor

Parameters

TUint aBufferLengthLength in packets of jitter buffer
TUint aBufferTresholdTreshold in packets of jitter buffer
TUint32 aInactivityTimerTimer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk burts and report inactivity.
HBufC8 * aMediaBurstIndicatorIndicator sound to be played before every new burst of media, if source in media burst mode.
HBufC8 * aIdentityIdentity of user placed in RTCP, ownership not transferred.

DisableInactivityTimerL()

IMPORT_C voidDisableInactivityTimerL()

Disables RTP inactivity timer.

DisableL()

IMPORT_C voidDisableL()[virtual]

Disables the source explicitly.

DisableSsrcL(TUint)

IMPORT_C voidDisableSsrcL(TUintaSsrc)

Disables streaming from specified synchronization source (SSRC).

Parameters

TUint aSsrcsynchronization source to be disabled

DoITCSendL(TUint8)

voidDoITCSendL(TUint8aITCFunction)[private]

Parameters

TUint8 aITCFunction

EnableInactivityTimerL(TUint32)

IMPORT_C voidEnableInactivityTimerL(TUint32aInactivityTimer)

Enables RTP inactivity timer.

Parameters

TUint32 aInactivityTimerTimer value (ms) that after inactivity of media from network is reported to client.

EnableL()

IMPORT_C voidEnableL()[virtual]

Enables the source explicitly.

EnableSsrcL(TUint)

IMPORT_C voidEnableSsrcL(TUintaSsrc)

Enables streaming from specified synchronization source (SSRC).

Parameters

TUint aSsrcsynchronization source to be enabled

EventReceivedL(TMceEvent &)

TInt EventReceivedL(TMceEvent &aEvent)[virtual]

Traversal event handler

Parameters

TMceEvent & aEventthe event

HandleEvent(TMceEvent &)

TInt HandleEvent(TMceEvent &aEvent)[private]

Handles event

Parameters

TMceEvent & aEventthe event

IsSsrcEnabledL(TUint)

IMPORT_C TBoolIsSsrcEnabledL(TUintaSsrc)

Determines whether specific SSRC is enabled or not.

Parameters

TUint aSsrcthe SSRC identifier

NewL(TUint, TUint, TUint32, HBufC8 *)

IMPORT_C CMceRtpSource *NewL(TUintaBufferLength =  KMceJitterBufferLength ,
TUintaBufferTreshold =  KMceJitterBufferTreshold ,
TUint32aInactivityTimer = 0,
HBufC8 *aIdentity = 0
)[static]

Two-phased constructor.

Parameters

TUint aBufferLength =  KMceJitterBufferLength Length in packets of jitter buffer
TUint aBufferTreshold =  KMceJitterBufferTreshold Treshold in packets of jitter buffer
TUint32 aInactivityTimer = 0Timer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk bursts and report inactivity.
HBufC8 * aIdentity = 0Identity of user placed in RTCP, ownership not transferred.

NewLC(TUint, TUint, TUint32, HBufC8 *)

IMPORT_C CMceRtpSource *NewLC(TUintaBufferLength =  KMceJitterBufferLength ,
TUintaBufferTreshold =  KMceJitterBufferTreshold ,
TUint32aInactivityTimer = 0,
HBufC8 *aIdentity = 0
)[static]

Two-phased constructor.

Parameters

TUint aBufferLength =  KMceJitterBufferLength Length in packets of jitter buffer
TUint aBufferTreshold =  KMceJitterBufferTreshold Treshold in packets of jitter buffer
TUint32 aInactivityTimer = 0Timer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk bursts and report inactivity.
HBufC8 * aIdentity = 0Identity of user placed in RTCP, ownership not transferred.

SendRRL()

IMPORT_C voidSendRRL()

Sends RTCP receiver report to recipient.

Ssrc()

IMPORT_C TUint32Ssrc()const
Returns the last RTP stream source identifier used in network (SSRC).
Pre-condition
CMceSession::State() == CMceSession::EEstablished

Ssrcs()

IMPORT_C const RArray< TUint > &Ssrcs()const

Gets an array of RTP synchronization source (SSRC) identifiers. Array includes all SSRC values this RtpSource has received RTP from. Changes in array are notified using MMceRtpObserver interface.

UpdateL(TUint, TUint, TUint32, HBufC8 *)

IMPORT_C voidUpdateL(TUintaBufferLength =  KMceJitterBufferLength ,
TUintaBufferTreshold =  KMceJitterBufferTreshold ,
TUint32aInactivityTimer = 0,
HBufC8 *aIdentity = 0
)
Updates settings for incoming session.
Pre-condition
CMceSession::State() == CMceSession::EIncoming

Parameters

TUint aBufferLength =  KMceJitterBufferLength Length in packets of jitter buffer
TUint aBufferTreshold =  KMceJitterBufferTreshold Treshold in packets of jitter buffer
TUint32 aInactivityTimer = 0Timer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk bursts and report inactivity.
HBufC8 * aIdentity = 0Identity of user placed in RTCP, ownership not transferred.