Collapse all Symbian^3 Application Developer Library

TEncodeStreamCaps Class Reference

class TEncodeStreamCaps

'Block' streaming extension for Image Conversion Library encoder. 'Block' streaming extension for Image Conversion Library encoder.

Public Member Functions
	TEncodeStreamCaps ()
	TEncodeStreamCaps ( TInt , const TSize &, TInt , TEncodeStreamCaps::TNavigation )
IMPORT_C TInt	MaxBlocksPerRequest ()
IMPORT_C const TSize &	MinBlockSizeInPixels ()
IMPORT_C TEncodeStreamCaps::TNavigation	Navigation ()
IMPORT_C TInt	OptimalBlocksPerRequest ()
IMPORT_C TUint	Size ()
IMPORT_C TUint	Version ()

Public Member Enumerations
enum	TNavigation { ENavigationSequentialForward = 0x01, ENavigationRandomForward = 0x02, ENavigationRandomBackwards = 0x04 }

Private Attributes
TInt	iMaxBlocksPerRequest
TSize	iMinBlockSizeInPixels
TNavigation	iNavigation
TInt	iOptimalBlocksPerRequest
TInt	iReserved
TUint	iSizeVersion

Constructor & Destructor Documentation

TEncodeStreamCaps()

IMPORT_C

TEncodeStreamCaps

(

)

Constructor.

TEncodeStreamCaps(TInt, const TSize &, TInt, TEncodeStreamCaps::TNavigation)

IMPORT_C	TEncodeStreamCaps	(	TInt	aMaxBlocksPerRequest,
			const TSize &	aMinBlockSizeInPixels,
			TInt	aOptimalBlocksPerRequest,
			TEncodeStreamCaps::TNavigation	aNavigation
		)

Constructor.

Parameters

TInt aMaxBlocksPerRequest	Maximum number of blocks that can be sent from the stream to client in a single request.
const TSize & aMinBlockSizeInPixels	Minimum size in pixels of a block sent to the stream from the client in a single request.
TInt aOptimalBlocksPerRequest	Optimum number of blocks sent to the stream from the client in a single request to get maximum performance benefit.
TEncodeStreamCaps::TNavigation aNavigation	Navigation capabilities.

Member Functions Documentation

MaxBlocksPerRequest()

IMPORT_C TInt

MaxBlocksPerRequest

(

)

const

Maximum number of blocks that can be sent from the stream to client in a single request.

MinBlockSizeInPixels()

IMPORT_C const TSize &

MinBlockSizeInPixels

(

)

const

Minimum size in pixels of a block sent to the stream from the client in a single request.

Navigation()

IMPORT_C TEncodeStreamCaps::TNavigation

Navigation

(

)

const

Navigation capabilities.

Full random access to the stream if Navigation() returns ENavigationSequentialForward | ENavigationRandomForward |ENavigationRandomBackwards

OptimalBlocksPerRequest()

IMPORT_C TInt

OptimalBlocksPerRequest

(

)

const

Optimum number of blocks sent to the stream from the client in a single request to get maximum performance benefit.

Size()

IMPORT_C TUint

Size

(

)

const

Compatibility - internal use only

Version()

IMPORT_C TUint

Version

(

)

const

Compatibility - internal use only

Member Enumerations Documentation

Enum TNavigation

Navigation possibilities within the stream.

Enumerators

ENavigationSequentialForward = 0x01	Blocks can be returned from first to last
ENavigationRandomForward = 0x02	Blocks can be returned in a random order but moving only from first to last e.g. 1, 5, 18...
ENavigationRandomBackwards = 0x04	Blocks can be returned in a random order but moving only from last to first e.g. 1, 5, 18...