Class TMMFVideoConfig

class TMMFVideoConfig;

Description

Class used when sending custom commands from the client API to the video controller to get or set the video configuration.

Members

Defined in TMMFVideoConfig:
TMMFVideoConfig(), iAntiAliasFiltering, iAudioBitRate, iAudioCodec, iAudioEnabled, iBalance, iBitmapHandle, iCameraHandle, iChannels, iClipRect, iCropRectangle, iDSAEvent, iEndPosition, iFormatUid, iFrameBitmapServerHandle, iFrameNumber, iFramesPerSecond, iGain, iHeightScalePercentage, iLoadingCompletePercentage, iMaxFileSize, iMaxGain, iMaxVolume, iMetaData, iRampDuration, iRecordTimeAvailable, iStartPosition, iTopLeftPt, iVideoBitRate, iVideoCodec, iVideoFrameSize, iVideoRotation, iVolume, iWidthScalePercentage, iWindowRect

inline TMMFVideoConfig();

Description

Initialises the object with arbitrary values.

TBool iAudioEnabled;

Description

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

TPoint iTopLeftPt;

Description

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

TRect iClipRect;

Description

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

TInt iBitmapHandle;

Description

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

TInt iFrameNumber;

Description

The current frame number in the video clip.

TReal32 iFramesPerSecond;

Description

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

TSize iVideoFrameSize;

Description

The width & height of the video frame.

TInt iVolume;

Description

The volume setting of the video device.

Should be between 0 and iMaxVolume.

TInt iMaxVolume;

Description

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.

TInt iBalance;

Description

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

TInt iGain;

Description

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

TInt iMaxGain;

Description

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

TInt iMetaData;

Description

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.

TInt iMaxFileSize;

Description

Set the maximum size of the recording, in bytes.

TUint iChannels;

Description

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

TInt iVideoBitRate;

Description

The video bit rate of the video device.

TInt iAudioBitRate;

Description

The audio bit rate of the video device.

TUid iFormatUid;

Description

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

TFourCC iVideoCodec;

Description

The video data type represented as a fourCC code.

TFourCC iAudioCodec;

Description

The audio data type represented as a fourCC code.

TTimeIntervalMicroSeconds iRampDuration;

Description

The period over which the volume is to rise.

TTimeIntervalMicroSeconds iStartPosition;

Description

The start position for playback in micro seconds.

TTimeIntervalMicroSeconds iEndPosition;

Description

The end position for playback in micro seconds.

TTimeIntervalMicroSeconds iRecordTimeAvailable;

Description

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

TInt iFrameBitmapServerHandle;

Description

Handle to the bitmap of the current video frame.

Used by RMMFVideoPlayControllerCustomCommands::GetFrame() to pass a bitmap handle to the video controller.

TRect iWindowRect;

Description

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

TInt iCameraHandle;

Description

A handle to the video camera being used.

TInt iDSAEvent;

Description

Whether the video display is active

TInt iLoadingCompletePercentage;

Description

The percentage of loading/rebuffering completed.

TVideoRotation iVideoRotation;

Description

The video rotation.

TReal32 iWidthScalePercentage;

Description

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

TReal32 iHeightScalePercentage;

Description

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

TBool iAntiAliasFiltering;

Description

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

TRect iCropRectangle;

Description

The crop region currently applied to the image.