Table of Contents

Class ScreenCaptureXDisplaySourceSettings

Namespace
VisioForge.Core.Types.X.Sources
Assembly
VisioForge.Core.dll

Screen capture X Display source settings.

public class ScreenCaptureXDisplaySourceSettings : IScreenCaptureSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoSourceSettings, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Properties

CaptureCursor

Gets or sets a value indicating whether mouse cursor capture is enabled.

public bool CaptureCursor { get; set; }

Property Value

bool

DisplayName

Gets or sets the X Display name. Not set by default.

public string DisplayName { get; set; }

Property Value

string

FrameRate

Gets or sets the frame rate.

public VideoFrameRate FrameRate { get; set; }

Property Value

VideoFrameRate

IsRemote

Gets or sets a value indicating whether the X display is remote. The element will try to use alternate calls known to work better with remote displays.

public bool IsRemote { get; set; }

Property Value

bool

MouseHighlight

Gets or sets the mouse click highlight settings. When not null, mouse click positions are drawn as animated expanding circles on the captured screen video. Set to null to disable mouse click highlighting.

public MouseHighlightSettings MouseHighlight { get; set; }

Property Value

MouseHighlightSettings

Rectangle

Gets or sets the rectangle to capture.

public Rect Rectangle { get; set; }

Property Value

Rect

UseDamage

Gets or sets a value indicating whether to use X Damage.

public bool UseDamage { get; set; }

Property Value

bool

XID

Gets or sets the XID of the window to capture. 0 for the root window (default).

public ulong XID { get; set; }

Property Value

ulong

XName

Gets or sets the name of the window to capture, if any.

public string XName { get; set; }

Property Value

string

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetSourceType()

Gets the type of the source.

public ScreenCaptureSourceType GetSourceType()

Returns

ScreenCaptureSourceType

ScreenCaptureSourceType.

UpdateLiveSettings(int, int, bool)

Updates the live settings.

public void UpdateLiveSettings(int x, int y, bool cursor)

Parameters

x int

The x.

y int

The y.

cursor bool

if set to true show cursor.

OnUpdated

Occurs when on updated.

public event EventHandler<EventArgs> OnUpdated

Event Type

EventHandler<EventArgs>