TEncodeStreamCaps Class Reference

#include <icl/imageconversionextension.h>

class TEncodeStreamCaps

Detailed Description

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

Member Enumeration Documentation

Enum TNavigation

Navigation possibilities within the stream.

EnumeratorValueDescription
ENavigationSequentialForward0x01

Blocks can be returned from first to last

ENavigationRandomForward0x02

Blocks can be returned in a random order but moving only from first to last e.g. 1, 5, 18...

ENavigationRandomBackwards0x04

Blocks can be returned in a random order but moving only from last to first e.g. 1, 5, 18...

Constructor & Destructor Documentation

TEncodeStreamCaps ( )

IMPORT_CTEncodeStreamCaps()

Constructor.

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

IMPORT_CTEncodeStreamCaps(TIntaMaxBlocksPerRequest,
const TSize &aMinBlockSizeInPixels,
TIntaOptimalBlocksPerRequest,
TEncodeStreamCaps::TNavigationaNavigation
)

Constructor.

Parameters
aMaxBlocksPerRequestMaximum number of blocks that can be sent from the stream to client in a single request.
aMinBlockSizeInPixelsMinimum size in pixels of a block sent to the stream from the client in a single request.
aOptimalBlocksPerRequestOptimum number of blocks sent to the stream from the client in a single request to get maximum performance benefit.
aNavigationNavigation capabilities.

Member Function Documentation

MaxBlocksPerRequest ( )

IMPORT_C TIntMaxBlocksPerRequest()const

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

Return Value
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.

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

Navigation ( )

IMPORT_C TEncodeStreamCaps::TNavigationNavigation()const

Navigation capabilities.

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

Return Value
navigation capabilities.

OptimalBlocksPerRequest ( )

IMPORT_C TIntOptimalBlocksPerRequest()const

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

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

Size ( )

IMPORT_C TUintSize()const

Compatibility - internal use only

Version ( )

IMPORT_C TUintVersion()const

Compatibility - internal use only