TDecodeStreamCaps Class Reference

#include <icl/imageconversionextension.h>

class TDecodeStreamCaps

Detailed Description

'Block' streaming extension capabilities.

Member Enumeration Documentation

Enum TNavigation

Navigation possibilities within stream.

EnumeratorValueDescription
ENavigationSequentialForward0x01

Blocks are returned from first to last

ENavigationRandomForward0x02

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

ENavigationRandomBackwards0x04

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

ENavigationRandom0x08

Blocks are returned randomly e.g. 18, 5, 20, ...

ENavigationSequentialBackwards0x10

Blocks are returned from last to first

Constructor & Destructor Documentation

TDecodeStreamCaps ( )

IMPORT_CTDecodeStreamCaps()

Constructor.

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

IMPORT_CTDecodeStreamCaps(TIntaMaxBlocksPerRequest,
const TSize &aMinBlockSizeInPixels,
TIntaOptimalBlocksPerRequest,
TIntaStreamSizeInBlocks,
TDecodeStreamCaps::TNavigationaNavigation
)

Constructor.

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

Member Function Documentation

MaxBlocksPerRequest ( )

IMPORT_C TIntMaxBlocksPerRequest()const

The maximum number of blocks that can be returned from the stream to client in a single request.

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

MinBlockSizeInPixels ( )

IMPORT_C const TSize &MinBlockSizeInPixels()const

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

Return Value
Minimum size in pixels of a block returned from the stream to the client in a single request. Sequence numbers and StreamSizeInBlocks() refer to this size of block.

Navigation ( )

IMPORT_C TDecodeStreamCaps::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 returned from the stream to the client in a single request to get maximum performance benefit.

Return Value
Optimum number of blocks returned from the stream to the client in a single request to get maximum performance benefit. This can be used to determine the optimum value of the number of blocks of min block size per request.

Size ( )

IMPORT_C TUintSize()const

Compatibility - internal use only

StreamSizeInBlocks ( )

IMPORT_C TIntStreamSizeInBlocks()const

Number of blocks of size MinBlockSizeInPixels() in the stream.

Return Value
Number of blocks of size MinBlockSizeInPixels() in the stream.

Version ( )

IMPORT_C TUintVersion()const

Compatibility - internal use only