MDisplaySink Class Reference

class MDisplaySink

MDisplaySink

DisplaySink.lib

Public Member Functions
voidDestroy()
voidNextFrame()
voidPause()
voidRelease()
voidResume()
voidSetBitmapAvailable(TBitmapNo)
voidUpdateSinkParamsL(const TDisplaySinkParams &, TBool &)
operator MVTVideoSink &()
Public Member Enumerations
enumTBitmapNo { EFirstBitmap = 0, ESecondBitmap }

Member Functions Documentation

Destroy()

voidDestroy()[pure virtual]

Deletes instance and frees all memory.

NextFrame()

voidNextFrame()[pure virtual]

This method is called by the VT engine when engine has finished handling of previous frame and is ready to handle a new one.

Pause()

voidPause()[pure virtual]

Pauses sending of remote video to VT engine.

Release()

voidRelease()[pure virtual]

Cancels sink so that it does not convert bitmaps even it receives data.

Resume()

voidResume()[pure virtual]

Resumes sending of remote video to VT engine.

SetBitmapAvailable(TBitmapNo)

voidSetBitmapAvailable(TBitmapNoaBitmapNo)[pure virtual]

Mark the bitmap available for use.

Parameters

TBitmapNo aBitmapNoOne of the enumerated TBitmapNo values.

UpdateSinkParamsL(const TDisplaySinkParams &, TBool &)

voidUpdateSinkParamsL(const TDisplaySinkParams &aParams,
TBool &aUpdated
)[pure virtual]
Updates display sink parameters, e.g. when display mode changes.
Exceptions
May

leave with one of the system wide error codes (e.g. in out of memory situaton).

Parameters

const TDisplaySinkParams & aParamsStructure that contains new bitmap handles.
TBool & aUpdatedReference to boolean variable that will be set to ETrue when display sink parameter update has been completed.

operator MVTVideoSink &()

operator MVTVideoSink &()[pure virtual]

Operator returns this instance .

Member Enumerations Documentation

Enum TBitmapNo

Enumerators

EFirstBitmap = 0
ESecondBitmap