Collapse all Symbian^3 Application Developer Library

CMceMediaSink Class Reference

class CMceMediaSink : public CBase

Base class for the MCE media sinks.

Media sinks represent the destination of data. CMceMediaSink gets it data from CMceMediaSource through CMceMediaStream .

CMceMediaSink has a type that defines how it can connected to other sources and streams.

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

mceclient.lib

Inherits from

CMceMediaSink
- CBase

Public Member Functions
	~CMceMediaSink ()
MMceEndPointProxy *	CreateEndpointProxyL ()
void	DisableL ()
void	EnableL ()
void	Enabled ( TBool )
MMceEndPointProxy *	EndpointProxy ()
TInt	EventReceivedL ( TMceEvent &)
void	ExternalizeFlatL ( RWriteStream &)
void	ExternalizeL ( MMceComSerializationContext &)
TMceSinkFactory	Factory ()
TMceMediaId	Id ()
void	InitializeL ( CMceMediaStream &)
void	InitializeL ( CMceManager *)
void	InternalizeFlatL ( RReadStream &)
void	InternalizeL ( MMceComSerializationContext &)
IMPORT_C TBool	IsEnabled ()
TInt &	ReferenceCount ()
TUint64	SerializationId ()
void	SetupEndpointProxyL ( MMceEndPointProxy *)
void	StreamAddedL ( CMceMediaStream &)
IMPORT_C TMceSinkType	Type ()
void	UnInitialize ( CMceMediaStream &)
void	UpdateL ( CMceMediaSink &)
void	Updated ()
TBool	UsesEndpointProxy ()

Protected Member Functions
	CMceMediaSink ()
void	ConstructL ( CMceComMediaSink *)
void	DoDisableL ()
void	DoEnableL ()
TInt	HandleEvent ( TMceEvent &)

Private Member Functions
void	DoITCSendL ( TUint8 , TBool )

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()

Protected Attributes
MMceEndPointProxy *	iEndpointProxy
CMceComMediaSink *	iFlatData
RPointerArray < CMceMediaStream >	iParents
CMceMediaStream *	iStream

Constructor & Destructor Documentation

CMceMediaSink()

CMceMediaSink

(

)

[protected]

C++ default constructor.

~CMceMediaSink()

IMPORT_C

~CMceMediaSink

(

)

Member Functions Documentation

ConstructL(CMceComMediaSink *)

void

ConstructL

(

CMceComMediaSink *

aFlatData

)

[protected]

second-phase constructor flat data container

Parameters

CMceComMediaSink * aFlatData

CreateEndpointProxyL()

MMceEndPointProxy *

CreateEndpointProxyL

(

)

const [virtual]

Called endpoint proxy must be created

DisableL()

void

DisableL

(

)

[pure virtual]

Disables streaming explicitly.

DoDisableL()

void

DoDisableL

(

)

[protected]

Disables streaming explicitly.

DoEnableL()

void

DoEnableL

(

)

[protected]

Enables streaming explicitly.

DoITCSendL(TUint8, TBool)

void	DoITCSendL	(	TUint8	aITCFunction,
			TBool	aEnabled
		)	[private]

Handles ITC

Parameters

TUint8 aITCFunction
TBool aEnabled

EnableL()

void

EnableL

(

)

[pure virtual]

Enables streaming explicitly.

Enabled(TBool)

void

Enabled

(

TBool

aValue

)

Sets enabled flag

Parameters

TBool aValue

enabled/disabled

EndpointProxy()

MMceEndPointProxy *

EndpointProxy

(

)

const

Returns endpoint proxy

EventReceivedL(TMceEvent &)

TInt

EventReceivedL

(

TMceEvent &

aEvent

)

[virtual]

Traversal event handler

Parameters

TMceEvent & aEvent

the event

ExternalizeFlatL(RWriteStream &)

void

ExternalizeFlatL

(

RWriteStream &

aWriteStream

)

Externalizes flat data

Parameters

RWriteStream & aWriteStream

write stream

ExternalizeL(MMceComSerializationContext &)

void

ExternalizeL

(

MMceComSerializationContext &

aSerCtx

)

[virtual]

Externalizes

Parameters

MMceComSerializationContext & aSerCtx

context for serialization

Factory()

TMceSinkFactory

Factory

(

)

[static]

Factory

HandleEvent(TMceEvent &)

TInt

HandleEvent

(

TMceEvent &

aEvent

)

[protected]

Handles event

Parameters

TMceEvent & aEvent

the event

Id()

TMceMediaId

(

)

const

InitializeL(CMceMediaStream &)

void

InitializeL

(

CMceMediaStream &

aParent

)

[virtual]

Initializes

Parameters

CMceMediaStream & aParent

the parent

InitializeL(CMceManager *)

void

InitializeL

(

CMceManager *

aManager

)

[virtual]

Initializes

Parameters

CMceManager * aManager

the manager. Ownership is NOT transferred

InternalizeFlatL(RReadStream &)

void

InternalizeFlatL

(

RReadStream &

aReadStream

)

Internalizes flat data

Parameters

RReadStream & aReadStream

read stream

InternalizeL(MMceComSerializationContext &)

void

InternalizeL

(

MMceComSerializationContext &

aSerCtx

)

[virtual]

Internalizes

Parameters

MMceComSerializationContext & aSerCtx

context for serialization

IsEnabled()

IMPORT_C TBool

IsEnabled

(

)

const

Returns the state of the sink.

ReferenceCount()

TInt &

ReferenceCount

(

)

Sets and gets reference count describing to how many streams sink is associated

SerializationId()

TUint64

SerializationId

(

)

const

Returns serialization id

SetupEndpointProxyL(MMceEndPointProxy *)

void

SetupEndpointProxyL

(

MMceEndPointProxy *

aEndpointProxy

)

Called when stream bundle has beed added to prepare proxy for it

Parameters

MMceEndPointProxy * aEndpointProxy

endpoint proxy setup by another endpoint or NULL

StreamAddedL(CMceMediaStream &)

void

StreamAddedL

(

CMceMediaStream &

aParent

)

[virtual]

Stream has been added to session

Parameters

CMceMediaStream & aParent

the parent stream

Type()

IMPORT_C TMceSinkType

Type

(

)

const

Returns the type of the sink.

UnInitialize(CMceMediaStream &)

void

UnInitialize

(

CMceMediaStream &

aParent

)

Stream is been deleted

Parameters

CMceMediaStream & aParent

the parent stream

UpdateL(CMceMediaSink &)

void

UpdateL

(

CMceMediaSink &

aUpdate

)

Updates

Parameters

CMceMediaSink & aUpdate

updated data

Updated()

void

Updated

(

)

[virtual]

Called after update

UsesEndpointProxy()

TBool

UsesEndpointProxy

(

)

const [virtual]

Should this endpoint use endpoint proxy

Member Data Documentation

MMceEndPointProxy * iEndpointProxy

MMceEndPointProxy *

iEndpointProxy

[protected]

CMceComMediaSink * iFlatData

CMceComMediaSink *

iFlatData

[protected]

flat data container

RPointerArray< CMceMediaStream > iParents

RPointerArray < CMceMediaStream >

iParents

[protected]

CMceMediaStream * iStream

CMceMediaStream *

iStream

[protected]

stream