TMMFVideoConfig Class Reference

#include <mmf/common/mmfvideo.h>

class TMMFVideoConfig

Detailed Description

Class used when sending custom commands from the client API

to the video controller to get or set the video configuration.

Member Attribute Documentation

iAntiAliasFiltering

TBool iAntiAliasFiltering

A boolean indicating if anti-aliasing filtering should be used.

iAudioBitRate

TInt iAudioBitRate

The audio bit rate of the video device.

iAudioCodec

TFourCC iAudioCodec

The audio data type represented as a fourCC code.

iAudioEnabled

TBool iAudioEnabled

A flag indicating whether audio output is enabled. ETrue if teh audio is to be enabled, false if

not.

iBalance

TInt iBalance

The balance of the audio channels for the video device. Zero for normal balance.

iBitmapHandle

TInt iBitmapHandle

A handle to the bitmap into which the decoded frame(s) are put.

iCameraHandle

TInt iCameraHandle

A handle to the video camera being used.

iChannels

TUint iChannels

The number of channels (mono/stereo) that can be read by the video device.

iClipRect

TRect iClipRect

Defines the rectangle in which the video clip will be played.

iCropRectangle

TRect iCropRectangle

The crop region currently applied to the image.

iDSAEvent

TInt iDSAEvent

Whether the video display is active

iEndPosition

The end position for playback in micro seconds.

iFormatUid

TUid iFormatUid

The unique identifier of the video format handled by the video device.

iFrameBitmapServerHandle

TInt iFrameBitmapServerHandle

Handle to the bitmap of the current video frame.

Used by RMMFVideoPlayControllerCustomCommands::GetFrame()

to pass a bitmap handle to the video controller.

iFrameNumber

TInt iFrameNumber

The current frame number in the video clip.

iFramesPerSecond

TReal32 iFramesPerSecond

The number of frames per second; may not be an integer.

iGain

TInt iGain

The gain of the audio channels for the video device. This can be any value from zero to

iMaxGain.

iHeightScalePercentage

TReal32 iHeightScalePercentage

The percentage (100 = original size) by which the height of the video image is scaled.

iLoadingCompletePercentage

TInt iLoadingCompletePercentage

The percentage of loading/rebuffering completed.

iMaxFileSize

TInt iMaxFileSize

Set the maximum size of the recording, in bytes.

iMaxGain

TInt iMaxGain

The maximum gain of the audio channels for the video device.

iMaxVolume

TInt iMaxVolume

The maximum volume setting of the video device.

This value is platform dependent but is always greater than or equal to one. This is the maximum

value that should be passed to iVolume.

iMetaData

TInt iMetaData

Unused.

Meta data is often contained in the header of multimedia clips and is used to define attributes

such as the author and copyright details.

iRampDuration

The period over which the volume is to rise.

iRecordTimeAvailable

TTimeIntervalMicroSeconds iRecordTimeAvailable

The (possibly estimated) record time left in the clip.

iStartPosition

The start position for playback in micro seconds.

iTopLeftPt

TPoint iTopLeftPt

The location of the top left corner of the video window.

iVideoBitRate

TInt iVideoBitRate

The video bit rate of the video device.

iVideoCodec

TFourCC iVideoCodec

The video data type represented as a fourCC code.

iVideoFrameSize

TSize iVideoFrameSize

The width & height of the video frame.

iVideoRotation

TVideoRotation iVideoRotation

The video rotation.

iVolume

TInt iVolume

The volume setting of the video device.

Should be between 0 and iMaxVolume.

iWidthScalePercentage

TReal32 iWidthScalePercentage

The percentage (100 = original size) by which the width of the video image is scaled.

iWindowRect

TRect iWindowRect

Defines the window in which the video clip will be played.

Constructor & Destructor Documentation

TMMFVideoConfig ( )

TMMFVideoConfig()[inline]

Initialises the object with arbitrary values.