Collapse all Symbian^3 Application Developer Library

CMceDisplaySink Class Reference

class CMceDisplaySink : public CMceMediaSink

Class representing display in MCE.

CMceDisplaySink can be used to show video on screen or as a viewfinder of the camera.

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

mceclient.lib

Inherits from

CMceDisplaySink
- CMceMediaSink
  - CBase

Public Member Functions
	~CMceDisplaySink ()
MMceEndPointProxy *	CreateEndpointProxyL ()
IMPORT_C void	DisableL ()
IMPORT_C const TRect	DisplayRectL ()
IMPORT_C TInt	DisplaysAvailable ()
IMPORT_C void	EnableL ()
void	InitializeL ( CMceManager *)
IMPORT_C CMceDisplaySink *	NewL ( CMceManager &)
CMceDisplaySink *	NewL ()
IMPORT_C CMceDisplaySink *	NewLC ( CMceManager &)
CMceDisplaySink *	NewLC ()
IMPORT_C TUint	PriorityL ()
IMPORT_C TRotation	RotationL ()
IMPORT_C void	SetDisplay ( RWindow &, CWindowGc &)
IMPORT_C void	SetDisplayIndexL ( TInt )
IMPORT_C void	SetDisplayRectL (const TRect &)
IMPORT_C void	SetPriorityL ( TUint )
IMPORT_C void	SetRotationL ( TRotation )
TBool	UsesEndpointProxy ()

Private Member Functions
	CMceDisplaySink ()
void	ConstructL ( CMceManager *)
TInt	GetITCValueL ( TUint8 )
TInt	SetITCValueL ( TUint8 , TInt )

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()
	CMceMediaSink::CMceMediaSink()
	CMceMediaSink::ConstructL(CMceComMediaSink *)
	CMceMediaSink::DoDisableL()
	CMceMediaSink::DoEnableL()
	CMceMediaSink::Enabled(TBool)
	CMceMediaSink::EndpointProxy()const
	CMceMediaSink::EventReceivedL(TMceEvent &)
	CMceMediaSink::ExternalizeFlatL(RWriteStream &)
	CMceMediaSink::ExternalizeL(MMceComSerializationContext &)
	CMceMediaSink::Factory()
	CMceMediaSink::HandleEvent(TMceEvent &)
	CMceMediaSink::Id()const
	CMceMediaSink::InitializeL(CMceMediaStream &)
	CMceMediaSink::InternalizeFlatL(RReadStream &)
	CMceMediaSink::InternalizeL(MMceComSerializationContext &)
	CMceMediaSink::IsEnabled()const
	CMceMediaSink::ReferenceCount()
	CMceMediaSink::SerializationId()const
	CMceMediaSink::SetupEndpointProxyL(MMceEndPointProxy *)
	CMceMediaSink::StreamAddedL(CMceMediaStream &)
	CMceMediaSink::Type()const
	CMceMediaSink::UnInitialize(CMceMediaStream &)
	CMceMediaSink::UpdateL(CMceMediaSink &)
	CMceMediaSink::Updated()
	CMceMediaSink::~CMceMediaSink()

Public Member Enumerations
enum	TRotation { ENone , EClockwise90Degree , EClockwise180Degree , EClockwise270Degree }

Private Attributes
CWindowGc *	iGc
TAny *	iReserved
RWindow *	iWindow

Inherited Attributes
	CMceMediaSink::iEndpointProxy
	CMceMediaSink::iFlatData
	CMceMediaSink::iParents
	CMceMediaSink::iStream

Constructor & Destructor Documentation

CMceDisplaySink()

CMceDisplaySink

(

)

[private]

C++ constructor.

~CMceDisplaySink()

IMPORT_C

~CMceDisplaySink

(

)

Destructor.

Member Functions Documentation

ConstructL(CMceManager *)

void

ConstructL

(

CMceManager *

aManager

)

[private]

second-phase constructor

Parameters

CMceManager * aManager

CreateEndpointProxyL()

MMceEndPointProxy *

CreateEndpointProxyL

(

)

const [virtual]

Called endpoint proxy must be created

DisableL()

IMPORT_C void

DisableL

(

)

[virtual]

Disables the sink explicitly.

DisplayRectL()

IMPORT_C const TRect

DisplayRectL

(

)

Gets current display rectagle.

DisplaysAvailable()

IMPORT_C TInt

DisplaysAvailable

(

)

const

Gets the number of available displays on the device.

EnableL()

IMPORT_C void

EnableL

(

)

[virtual]

Enables the sink explicitly.

GetITCValueL(TUint8)

TInt

GetITCValueL

(

TUint8

aITCFunction

)

[private]

Handles ITC

Parameters

TUint8 aITCFunction

InitializeL(CMceManager *)

void

InitializeL

(

CMceManager *

aManager

)

[virtual]

Initializes

Parameters

CMceManager * aManager

the manager. Ownership is NOT transferred

NewL(CMceManager &)

IMPORT_C CMceDisplaySink *

NewL

(

CMceManager &

aManager

)

[static]

Two-phased constructor.

Parameters

CMceManager & aManager

reference to the manager

NewL()

CMceDisplaySink *

NewL

(

)

[static]

Two-phased constructor.

NewLC(CMceManager &)

IMPORT_C CMceDisplaySink *

NewLC

(

CMceManager &

aManager

)

[static]

Two-phased constructor.

Parameters

CMceManager & aManager

reference to the manager

NewLC()

CMceDisplaySink *

NewLC

(

)

[static]

Two-phased constructor.

PriorityL()

IMPORT_C TUint

PriorityL

(

)

RotationL()

IMPORT_C TRotation

RotationL

(

)

SetDisplay(RWindow &, CWindowGc &)

IMPORT_C void	SetDisplay	(	RWindow &	aWindow,
			CWindowGc &	aGc
		)

Sets display resources.

Parameters

RWindow & aWindow	handle to the display window of the user
CWindowGc & aGc	graphics context of the user

SetDisplayIndexL(TInt)

IMPORT_C void

SetDisplayIndexL

(

TInt

aDisplayIndex

)

Sets index of physical display to be used.

leave: KErrNotSupported if requested display cannot be used

Parameters

TInt aDisplayIndex

Index of the display to be used; number of available displays can be retrieved by calling CMceDisplaySink::DisplaysAvailable

SetDisplayRectL(const TRect &)

IMPORT_C void

SetDisplayRectL

(

const TRect &

aRect

)

Sets display rectangle. Display data is drawn to the given area.

Parameters

const TRect & aRect

display area

SetITCValueL(TUint8, TInt)

TInt	SetITCValueL	(	TUint8	aITCFunction,
			TInt	aValue
		)	[private]

Handles ITC

Parameters

TUint8 aITCFunction
TInt aValue

SetPriorityL(TUint)

IMPORT_C void

SetPriorityL

(

TUint

aPriority

)

Parameters

TUint aPriority

SetRotationL(TRotation)

IMPORT_C void

SetRotationL

(

TRotation

aRotation

)

Parameters

TRotation aRotation

UsesEndpointProxy()

TBool

UsesEndpointProxy

(

)

const [virtual]

Should this endpoint use endpoint proxy

Member Enumerations Documentation

Enum TRotation

Enumerators

ENone
EClockwise90Degree
EClockwise180Degree
EClockwise270Degree

Member Data Documentation

CWindowGc * iGc

CWindowGc *

iGc

[private]

TAny * iReserved

TAny *

iReserved

[private]

RWindow * iWindow

RWindow *

iWindow

[private]