Collapse all Symbian^3 Product Developer Library

MMMFSurfaceEventHandler Class Reference

class MMMFSurfaceEventHandler

Clients intending to use window-less graphics surfaces need to handle graphics surface specific events generated by the MultiMedia Framework (MMF). The MMMFSurfaceEventHandler interface allows client to receive these graphics surface specific events. A client intending to use the CVideoPlayerUtility2::AddDisplayL API must implement this interface.

CVideoPlayerUtility2

Public Member Functions
void	MmsehRemoveSurface(const TSurfaceId &)
void	MmsehSurfaceCreated(TInt, const TSurfaceId &, const TRect &, TVideoAspectRatio)
void	MmsehSurfaceParametersChanged(const TSurfaceId &, const TRect &, TVideoAspectRatio)

Member Functions Documentation

MmsehRemoveSurface(const TSurfaceId &)

void

MmsehRemoveSurface

(

const TSurfaceId &

aId

)

[pure virtual]

MmsehSurfaceRemoved is called when the MultiMedia Framework indicates that the surface is to be removed. Clients should stop using the graphics surface identified by aId before returning from the callback. Further, clients should be prepared to receive a MmsehSurfaceCreated callback event with a new graphics surface to use.

Parameters

const TSurfaceId & aId

Surface id of graphics surface to be removed.

MmsehSurfaceCreated(TInt, const TSurfaceId &, const TRect &, TVideoAspectRatio)

void	MmsehSurfaceCreated	(	TInt	aDisplayId,
			const TSurfaceId &	aId,
			const TRect &	aCropRect,
			TVideoAspectRatio	aAspectRatio
		)	[pure virtual]

MmsehSurfaceCreated is called when a graphics surface has been created on an added display. Clients will only be notified of surfaces created on displays that they have added. MMF still owns the graphics surface and can request the surface to be released by the client. Before this method is called by CVideoPlayerUtility2 the graphics surface is registered with the Window Server.

TVideoAspectRatio

Parameters

TInt aDisplayId	Display id the surface was created on.
const TSurfaceId & aId	surface Id of graphics surface created.
const TRect & aCropRect	Crop rectangle. The crop rectangle is the area of graphics surface containing viewable video.
TVideoAspectRatio aAspectRatio	Aspect ratio of video.

MmsehSurfaceParametersChanged(const TSurfaceId &, const TRect &, TVideoAspectRatio)

void	MmsehSurfaceParametersChanged	(	const TSurfaceId &	aId,
			const TRect &	aCropRect,
			TVideoAspectRatio	aAspectRatio
		)	[pure virtual]

MmsehSurfaceParametersChanged is called when either crop rectangle or aspect ratio of the surface changes.

Parameters

const TSurfaceId & aId	Surface id of graphics surface with changed parameters.
const TRect & aCropRect	New crop rectangle, this may be identical to previous value. The crop rectangle is the area of graphics surface containing viewable video.
TVideoAspectRatio aAspectRatio	New aspect ratio of video, this may be identical to previous value.