Class ScreenCaptureSourceSettings

Screen capture source settings.

Inheritance

object

ScreenCaptureSourceSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.Types.VideoCapture

Assembly: VisioForge.Core.dll

Syntax

public class ScreenCaptureSourceSettings

Constructors

ScreenCaptureSourceSettings()

Initializes a new instance of the ScreenCaptureSourceSettings class.

Declaration

public ScreenCaptureSourceSettings()

Properties

AllowDesktopDuplicationEngine

Gets or sets a value indicating whether Desktop Duplication API can be used (available starting Windows 8).

Declaration

public bool AllowDesktopDuplicationEngine { get; set; }

Property Value

Type	Description
bool

Bottom

Gets or sets Bottom coordinate of screen used for screen capture.

Declaration

public int Bottom { get; set; }

Property Value

Type	Description
int

DisplayIndex

Gets or sets display index to capture.

Declaration

public int DisplayIndex { get; set; }

Property Value

Type	Description
int

FrameRate

Gets or sets frame rate for screen capture.

Declaration

public VideoFrameRate FrameRate { get; set; }

Property Value

Type	Description
VideoFrameRate

FullScreen

Gets or sets a value indicating whether full screen capture enabled.

Declaration

public bool FullScreen { get; set; }

Property Value

Type	Description
bool

GrabMouseCursor

Gets or sets a value indicating whether mourse cursor will be grabbed during video capture.

Declaration

public bool GrabMouseCursor { get; set; }

Property Value

Type	Description
bool

Left

Gets or sets left coordinate of screen used for screen capture.

Declaration

public int Left { get; set; }

Property Value

Type	Description
int

Mode

Gets or sets screen capture mode.

Declaration

public ScreenCaptureMode Mode { get; set; }

Property Value

Type	Description
ScreenCaptureMode

MouseHighlight

Gets or sets a value indicating whether mouse highlight is enabled.

Declaration

public bool MouseHighlight { get; set; }

Property Value

Type	Description
bool	true if [mouse highlight]; otherwise, false.

MouseHighlightColor

Gets or sets the color of the mouse highlight.

Declaration

public Color MouseHighlightColor { get; set; }

Property Value

Type	Description
Color	The color of the mouse highlight.

MouseHighlightDuration

Gets or sets the duration of the mouse highlight.

Declaration

public TimeSpan MouseHighlightDuration { get; set; }

Property Value

Type	Description
TimeSpan	The duration of the mouse highlight.

MouseHighlightOpacity

Gets or sets the mouse highlight opacity [0.0-1.0].

Declaration

public double MouseHighlightOpacity { get; set; }

Property Value

Type	Description
double	The mouse highlight opacity.

MouseHighlightRadius

Gets or sets the mouse highlight radius.

Declaration

public int MouseHighlightRadius { get; set; }

Property Value

Type	Description
int	The mouse highlight radius.

MouseHighlightSize

Gets or sets the size of the mouse highlight.

Declaration

public int MouseHighlightSize { get; set; }

Property Value

Type	Description
int	The size of the mouse highlight.

Right

Gets or sets right coordinate of screen used for screen capture.

Declaration

public int Right { get; set; }

Property Value

Type	Description
int

Top

Gets or sets top coordinate of screen used for screen capture.

Declaration

public int Top { get; set; }

Property Value

Type	Description
int

WindowHandle

Gets or sets window handle for capture.

Declaration

[JsonIgnore]
public nint WindowHandle { get; set; }

Property Value

Type	Description
nint

Methods

ToString()

Gets settings as string.

Declaration

public override string ToString()

Returns

Type	Description
string	Returns string.

Overrides

object.ToString()