Collapse all Symbian^3 Application Developer Library

TDecodeStreamCaps Class Reference

class TDecodeStreamCaps

'Block' streaming extension capabilities.

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

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

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

Constructor & Destructor Documentation

TDecodeStreamCaps()

IMPORT_C

TDecodeStreamCaps

(

)

Constructor.

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

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

Constructor.

Parameters

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

Member Functions Documentation

MaxBlocksPerRequest()

IMPORT_C TInt

MaxBlocksPerRequest

(

)

const

The 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.

Navigation()

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

Size()

IMPORT_C TUint

Size

(

)

const

Compatibility - internal use only

StreamSizeInBlocks()

IMPORT_C TInt

StreamSizeInBlocks

(

)

const

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

Version()

IMPORT_C TUint

Version

(

)

const

Compatibility - internal use only

Member Enumerations Documentation

Enum TNavigation

Navigation possibilities within stream.

Enumerators

ENavigationSequentialForward = 0x01	Blocks are returned from first to last
ENavigationRandomForward = 0x02	Blocks are returned in a random order but moving only from first to last e.g. 1, 5, 18...
ENavigationRandomBackwards = 0x04	Blocks are returned in a random order but moving only from last to first e.g. 18, 5, 1...
ENavigationRandom = 0x08	Blocks are returned randomly e.g. 18, 5, 20, ...
ENavigationSequentialBackwards = 0x10	Blocks are returned from last to first