Collapse all Symbian^3 Application Developer Library

TImageConvStreamedEncode Class Reference

class TImageConvStreamedEncode

Public Member Functions
IMPORT_C void	AddBlocks ( TRequestStatus &, const CImageFrame &, const TInt &)
IMPORT_C void	AppendBlocks ( TRequestStatus &, const CImageFrame &, TInt )
IMPORT_C void	Complete ( TRequestStatus &)
IMPORT_C void	GetCapabilities ( TUid , TEncodeStreamCaps &)
IMPORT_C void	GetSupportedFormatsL ( RArray < TUid > &, TUid &)
IMPORT_C void	InitFrameL ( TUid , TInt , const TSize &, const TSize &, TEncodeStreamCaps::TNavigation , const CFrameImageData *)

Private Member Functions
	TImageConvStreamedEncode ()
void	SetExtension ( MImageConvExtension *)

Private Attributes
MImageConvStreamedEncode *	iExtension
TInt	iReserved

Constructor & Destructor Documentation

TImageConvStreamedEncode()

IMPORT_C

TImageConvStreamedEncode

(

)

[private]

Member Functions Documentation

AddBlocks(TRequestStatus &, const CImageFrame &, const TInt &)

IMPORT_C void	AddBlocks	(	TRequestStatus &	aStatus,
			const CImageFrame &	aBlocks,
			const TInt &	aSeqPosition
		)

Add blocks to the stream at a random position.

Parameters

TRequestStatus & aStatus	request status
const CImageFrame & aBlocks	wraps a memory buffer containing the pixel data to be added to the stream
const TInt & aSeqPosition	position of block in stream starting at 0

AppendBlocks(TRequestStatus &, const CImageFrame &, TInt)

IMPORT_C void	AppendBlocks	(	TRequestStatus &	aStatus,
			const CImageFrame &	aBlocks,
			TInt	aNumBlocksToAdd
		)

Append blocks to the stream.

Parameters

TRequestStatus & aStatus	request status
const CImageFrame & aBlocks	wraps a memory buffer containing the pixel data to be added to the stream
TInt aNumBlocksToAdd	number of blocks of size TEncodeStreamCaps::MinBlockSizeInPixels to add to the stream

Complete(TRequestStatus &)

IMPORT_C void

Complete

(

TRequestStatus &

aStatus

)

Signal completion of writing the stream

Parameters

TRequestStatus & aStatus

request status

GetCapabilities(TUid, TEncodeStreamCaps &)

IMPORT_C void	GetCapabilities	(	TUid	aFormat,
			TEncodeStreamCaps &	aCaps
		)	const

Returns the capabilities of the codec plugin for a specific format.

Parameters

TUid aFormat	The format.
TEncodeStreamCaps & aCaps	The capabilities for the format given.

GetSupportedFormatsL(RArray< TUid > &, TUid &)

IMPORT_C void	GetSupportedFormatsL	(	RArray < TUid > &	aFormats,
			TUid &	aOptimalFormat
		)	const

Returns a list of supported formats and the optimal format to be used. imageframeconst.h for a list of format uids.

Parameters

RArray < TUid > & aFormats	Returns an array of format uids
TUid & aOptimalFormat	The 'best' uid to use.

InitFrameL(TUid, TInt, const TSize &, const TSize &, TEncodeStreamCaps::TNavigation, const CFrameImageData *)

IMPORT_C void	InitFrameL	(	TUid	aFormat,
			TInt	aFrameNumber,
			const TSize &	aFrameSizeInPixels,
			const TSize &	aBlockSizeInPixels,
			TEncodeStreamCaps::TNavigation	aNavigation,
			const CFrameImageData *	aFrameImageData
		)

Initialise the stream.

TJpegImageData

leave: System wide error if for example the format is not supported.

Note:

must call InitFrameL before AppendBlocks or AddBlocks. Failure to do so completes request with KErrNotReady

can either specify format through aFormat or aImageFrameData. Conflicts cause a leave with KErrArgument.

Parameters

TUid aFormat	the format to use
TInt aFrameNumber	frame to stream
const TSize & aFrameSizeInPixels	Size of this frame in pixels
const TSize & aBlockSizeInPixels	Size of block to be added / appended.
TEncodeStreamCaps::TNavigation aNavigation	indication to stream of the way that the stream will be navigated. Allows codec to optimise it's behaviour.
const CFrameImageData * aFrameImageData	The frame image data (optional pass NULL if not required). There are format-specific image data variants that are used by encoders to obtain image specific data. This behaviour is invoked by specifying aFrameImageData. Otherwise, encoder specific defaults are invoked.

SetExtension(MImageConvExtension *)

void

SetExtension

(

MImageConvExtension *

aExtension

)

[private]

Parameters

MImageConvExtension * aExtension

Member Data Documentation

MImageConvStreamedEncode * iExtension

MImageConvStreamedEncode *

iExtension

[private]

TInt iReserved

TInt

iReserved

[private]