Collapse all Symbian^3 Application Developer Library

MCameraSnapshot2 Class Reference

class MCameraSnapshot2

This is a mixin class to be implemented by providers of the extension API for the extra features for camera snapshot.

CCamera::CCameraSnapshot

Public Member Functions
void	CreateHistogramImplFactoryL ( MImplementationFactory *&)
void	DisableSnapshot ()
void	EnableSnapshot ()
void	GetSnapshotParametersL ( CCamera::CCameraSnapshot::TSnapshotParameters &)
void	GetSnapshotStatusL ( CCamera::CCameraSnapshot::TSnapshotState &)
void	PrepareSnapshotL (const CCamera::CCameraSnapshot::TSnapshotParameters &)
void	Release ()
void	SelectSnapshotVideoFramesL ( CCamera::CCameraSnapshot::TSnapshotVideoFrames )
void	SetClientViewFinderId ( TInt )
void	SetSnapshotParametersL (const CCamera::CCameraSnapshot::TSnapshotParameters &)

Member Functions Documentation

CreateHistogramImplFactoryL(MImplementationFactory *&)

void

CreateHistogramImplFactoryL

(

MImplementationFactory *&

aImplFactoryPtr

)

const [pure virtual]

Retrieves the concrete factory handle for the histogram implementation in order to use it specifically for a given snapshot.

leave: May leave with any error code.

Parameters

MImplementationFactory *& aImplFactoryPtr

The concrete factory handle for the histogram implementation specific to the given snapshot.

DisableSnapshot()

void

DisableSnapshot

(

)

[pure virtual]

Deactivates the snapshot feature if it is active.

Once the snapshot has been deactivated, the client will no longer receive notifications about snapshots.

EnableSnapshot()

void

EnableSnapshot

(

)

[pure virtual]

Activates the snapshot feature. Calls to this method when the snapshot feature is already active will be ignored.

The client will not receive snapshot notifications until the snapshot feature is activated.

Implementation shall use the observers: MCaptureImageObserver and MCaptureVideoObserver . Snapshot notifications will be send to the clients via these observers and not through events.

GetSnapshotParametersL(CCamera::CCameraSnapshot::TSnapshotParameters &)

void

GetSnapshotParametersL

(

CCamera::CCameraSnapshot::TSnapshotParameters &

aSnapshotParameters

)

[pure virtual]

Retrieves the snapshot parameters. ECam implementation may use a different size than that provided by this method.

leave: May leave with any error code.

Note:

This method is used to retrieve snapshot parameters.

Parameters

CCamera::CCameraSnapshot::TSnapshotParameters & aSnapshotParameters

Retrieves the currently used snapshot parameters.

GetSnapshotStatusL(CCamera::CCameraSnapshot::TSnapshotState &)

void

GetSnapshotStatusL

(

CCamera::CCameraSnapshot::TSnapshotState &

aSnapshotState

)

const [pure virtual]

Retrieves the current status for the snapshot.

leave: May leave with any error code.

Note:

This method is used to retrieve the snapshot status.

Parameters

CCamera::CCameraSnapshot::TSnapshotState & aSnapshotState

Retrieves information about the current snapshot state.

PrepareSnapshotL(const CCamera::CCameraSnapshot::TSnapshotParameters &)

void

PrepareSnapshotL

(

const CCamera::CCameraSnapshot::TSnapshotParameters &

aSnapshotParameters

)

[pure virtual]

Sets the properties of the snapshot. ECam implementation may use a different size than that specified by this method.

leave: May leave with any error code.

Note:

This method is used to provide snapshot parameters.

Parameters

const CCamera::CCameraSnapshot::TSnapshotParameters & aSnapshotParameters

The snaspshot parameters.

Release()

void

Release

(

)

[pure virtual]

Releases the interface.

SelectSnapshotVideoFramesL(CCamera::CCameraSnapshot::TSnapshotVideoFrames)

void

SelectSnapshotVideoFramesL

(

CCamera::CCameraSnapshot::TSnapshotVideoFrames

aSnapshotVideoFrames

)

[pure virtual]

The method specifies the frames to be used from video captured data in order to create snapshot for video.

leave: May leave with any error code.

Parameters

CCamera::CCameraSnapshot::TSnapshotVideoFrames aSnapshotVideoFrames

A TSnapshotVideoFrames used to specify the desired frames to be used for creating snapshots for video.

SetClientViewFinderId(TInt)

void

SetClientViewFinderId

(

TInt

aClientViewFinderId

)

[pure virtual]

Sets the client viewfinder on which the client snapshot will be displayed.

Parameters

TInt aClientViewFinderId

The client viewfinder on which this client snapshot will be displayed.

SetSnapshotParametersL(const CCamera::CCameraSnapshot::TSnapshotParameters &)

void

SetSnapshotParametersL

(

const CCamera::CCameraSnapshot::TSnapshotParameters &

aSnapshotParameters

)

[pure virtual]

Sets/updates the snapshot parameters.

leave: May leave with any error code.

Note:

This method is used to set/update snapshot parameters.

Parameters

const CCamera::CCameraSnapshot::TSnapshotParameters & aSnapshotParameters

The desired snapshot parameters.