Symbian^3 Application Developer Library >

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 void DisableInactivityTimerL ()
IMPORT_C void DisableL ()
IMPORT_C void DisableSsrcL ( TUint )
IMPORT_C void EnableInactivityTimerL ( TUint32 )
IMPORT_C void EnableL ()
IMPORT_C void EnableSsrcL ( TUint )
TInt EventReceivedL ( TMceEvent &)
IMPORT_C TBool IsSsrcEnabledL ( TUint )
IMPORT_C CMceRtpSource * NewL ( TUint , TUint , TUint32 , HBufC8 *)
IMPORT_C CMceRtpSource * NewLC ( TUint , TUint , TUint32 , HBufC8 *)
IMPORT_C void SendRRL ()
IMPORT_C TUint32 Ssrc ()
IMPORT_C const RArray < TUint > & Ssrcs ()
IMPORT_C void UpdateL ( TUint , TUint , TUint32 , HBufC8 *)
Private Member Functions
CMceRtpSource ()
void ConstructL ( TUint , TUint , TUint32 , HBufC8 *, HBufC8 *)
void DoITCSendL ( 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 *)

void ConstructL ( TUint aBufferLength,
TUint aBufferTreshold,
TUint32 aInactivityTimer,
HBufC8 * aMediaBurstIndicator,
HBufC8 * aIdentity
) [private]

second-phase constructor

Parameters

TUint aBufferLength Length in packets of jitter buffer
TUint aBufferTreshold Treshold in packets of jitter buffer
TUint32 aInactivityTimer Timer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk burts and report inactivity.
HBufC8 * aMediaBurstIndicator Indicator sound to be played before every new burst of media, if source in media burst mode.
HBufC8 * aIdentity Identity of user placed in RTCP, ownership not transferred.

DisableInactivityTimerL()

IMPORT_C void DisableInactivityTimerL ( )

Disables RTP inactivity timer.

DisableL()

IMPORT_C void DisableL ( ) [virtual]

Disables the source explicitly.

DisableSsrcL(TUint)

IMPORT_C void DisableSsrcL ( TUint aSsrc )

Disables streaming from specified synchronization source (SSRC).

Parameters

TUint aSsrc synchronization source to be disabled

DoITCSendL(TUint8)

void DoITCSendL ( TUint8 aITCFunction ) [private]

Parameters

TUint8 aITCFunction

EnableInactivityTimerL(TUint32)

IMPORT_C void EnableInactivityTimerL ( TUint32 aInactivityTimer )

Enables RTP inactivity timer.

Parameters

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

EnableL()

IMPORT_C void EnableL ( ) [virtual]

Enables the source explicitly.

EnableSsrcL(TUint)

IMPORT_C void EnableSsrcL ( TUint aSsrc )

Enables streaming from specified synchronization source (SSRC).

Parameters

TUint aSsrc synchronization source to be enabled

EventReceivedL(TMceEvent &)

TInt EventReceivedL ( TMceEvent & aEvent ) [virtual]

Traversal event handler

Parameters

TMceEvent & aEvent the event

HandleEvent(TMceEvent &)

TInt HandleEvent ( TMceEvent & aEvent ) [private]

Handles event

Parameters

TMceEvent & aEvent the event

IsSsrcEnabledL(TUint)

IMPORT_C TBool IsSsrcEnabledL ( TUint aSsrc )

Determines whether specific SSRC is enabled or not.

Parameters

TUint aSsrc the SSRC identifier

NewL(TUint, TUint, TUint32, HBufC8 *)

IMPORT_C CMceRtpSource * NewL ( TUint aBufferLength =  KMceJitterBufferLength ,
TUint aBufferTreshold =  KMceJitterBufferTreshold ,
TUint32 aInactivityTimer = 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 = 0 Timer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk bursts and report inactivity.
HBufC8 * aIdentity = 0 Identity of user placed in RTCP, ownership not transferred.

NewLC(TUint, TUint, TUint32, HBufC8 *)

IMPORT_C CMceRtpSource * NewLC ( TUint aBufferLength =  KMceJitterBufferLength ,
TUint aBufferTreshold =  KMceJitterBufferTreshold ,
TUint32 aInactivityTimer = 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 = 0 Timer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk bursts and report inactivity.
HBufC8 * aIdentity = 0 Identity of user placed in RTCP, ownership not transferred.

SendRRL()

IMPORT_C void SendRRL ( )

Sends RTCP receiver report to recipient.

Ssrc()

IMPORT_C TUint32 Ssrc ( ) 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 void UpdateL ( TUint aBufferLength =  KMceJitterBufferLength ,
TUint aBufferTreshold =  KMceJitterBufferTreshold ,
TUint32 aInactivityTimer = 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 = 0 Timer (ms) to detect network inactivity. If 0, no activity detection, otherwise source is set to support talk bursts and report inactivity.
HBufC8 * aIdentity = 0 Identity of user placed in RTCP, ownership not transferred.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.