TMMFVideoConfig Class Reference

class TMMFVideoConfig

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

Constructor & Destructor Documentation

TMMFVideoConfig()

TMMFVideoConfig ( ) [inline]

Initialises the object with arbitrary values.

Member Data Documentation

TBool iAntiAliasFiltering

TBool iAntiAliasFiltering

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

TInt iAudioBitRate

TInt iAudioBitRate

The audio bit rate of the video device.

TFourCC iAudioCodec

TFourCC iAudioCodec

The audio data type represented as a fourCC code.

TBool iAudioEnabled

TBool iAudioEnabled

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

TInt iBalance

TInt iBalance

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

TInt iBitmapHandle

TInt iBitmapHandle

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

TInt iCameraHandle

TInt iCameraHandle

A handle to the video camera being used.

TUint iChannels

TUint iChannels

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

TRect iClipRect

TRect iClipRect

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

TRect iCropRectangle

TRect iCropRectangle

The crop region currently applied to the image.

TInt iDSAEvent

TInt iDSAEvent

Whether the video display is active

TTimeIntervalMicroSeconds iEndPosition

TTimeIntervalMicroSeconds iEndPosition

The end position for playback in micro seconds.

TUid iFormatUid

TUid iFormatUid

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

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

TInt iFrameNumber

TInt iFrameNumber

The current frame number in the video clip.

TReal32 iFramesPerSecond

TReal32 iFramesPerSecond

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

TInt iGain

TInt iGain

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

TReal32 iHeightScalePercentage

TReal32 iHeightScalePercentage

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

TInt iLoadingCompletePercentage

TInt iLoadingCompletePercentage

The percentage of loading/rebuffering completed.

TInt iMaxFileSize

TInt iMaxFileSize

Set the maximum size of the recording, in bytes.

TInt iMaxGain

TInt iMaxGain

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

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

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

TTimeIntervalMicroSeconds iRampDuration

TTimeIntervalMicroSeconds iRampDuration

The period over which the volume is to rise.

TTimeIntervalMicroSeconds iRecordTimeAvailable

TTimeIntervalMicroSeconds iRecordTimeAvailable

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

TInt iReserved1

TInt iReserved1 [private]

This member is internal and not intended for use.

TInt iReserved2

TInt iReserved2 [private]

TInt iReserved3

TInt iReserved3 [private]

TTimeIntervalMicroSeconds iStartPosition

TTimeIntervalMicroSeconds iStartPosition

The start position for playback in micro seconds.

TPoint iTopLeftPt

TPoint iTopLeftPt

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

TInt iVideoBitRate

TInt iVideoBitRate

The video bit rate of the video device.

TFourCC iVideoCodec

TFourCC iVideoCodec

The video data type represented as a fourCC code.

TSize iVideoFrameSize

TSize iVideoFrameSize

The width & height of the video frame.

TVideoRotation iVideoRotation

TVideoRotation iVideoRotation

The video rotation.

TInt iVolume

TInt iVolume

The volume setting of the video device.

Should be between 0 and iMaxVolume.

TReal32 iWidthScalePercentage

TReal32 iWidthScalePercentage

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

TRect iWindowRect

TRect iWindowRect

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