TRVCamera.DesktopMode, DesktopRect, DesktopWindowHandle [Windows], DesktopForm [FireMonkey], DesktopZoomPercent

<< Click to display table of contents >>

TRVCamera.DesktopMode, DesktopRect, DesktopWindowHandle [Windows], DesktopForm [FireMonkey], DesktopZoomPercent

These properties specify a part of desktop for encoding into a video.


  // defined in MRVType unit
  TRVDesktopMode = (rvdmFull, rvdmRect, rvdmWindow);
property DesktopMode: TRVDesktopMode;
property DesktopRect: TRect
property DesktopWindowHandle: THandle; // only for Windows

property DesktopForm: TCustomForm; // only for FireMonkey

property DesktopZoomPercent: Integer

These properties are used if DeviceType=rvdtDesktop.

VCL, Lazarus for Windows, FireMonkey for Windows,

A source region of screen is chosen depending in DesktopMode property.




A whole desktop or a whole monitor is used as a source, see VideoDevice*** properties.


A rectangle defined in DesktopRect is used


A window (of this application) specified in DesktopWindowHandle is used. If DesktopWindowHandle=0, the main form is used.


FireMonkey version of RVMedia supports all DesktopMode options only for Windows platform.

On other platforms, it can stream only forms of this application. DesktopMode must be rvdmWindow. The source form is specified in DesktopForm. On Windows platform, if both DesktopWindowHandle and DesktopForm are defined, DesktopForm is chosen for streaming.

When streaming, RVMedia draws DesktopForm onto the bitmap (instead of streaming a screen area covered by this form).

If DesktopWindowHandle and DesktopForm are not defined, the main form is used.


DesktopZoomPercent scales the resulting video frames. For example, DesktopZoomPercent=100 leaves frames unchanged (100% size), DesktopZoomPercent=50 shrinks its width and height to 50%. Assign values in the range 1..99 to reduce frame size and thus to reduce traffic. It is also possible to assign values larger than 100 to make frames larger, but it makes no sense.

Default value

DesktopMode: rvdmFull

DesktopWindowHandle: 0

DesktopForm: nil

DesktopZoomPercent: 100

See also

DesktopVideoMode methods