Class VNCSourceSettings

VNC/RFB source settings. Implements the IMediaPlayerBaseSourceSettings. Implements the IVideoCaptureBaseVideoSourceSettings.

Inheritance
object
VNCSourceSettings
Implements
Inherited Members
Namespace: VisioForge.Core.Types.X.Sources
Assembly: VisioForge.Core.dll
Syntax
public class VNCSourceSettings : IMediaPlayerBaseSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Properties

Height

Gets or sets the height.

Declaration
public int Height { get; set; }
Property Value
Type Description
int

The height.

Host

Gets or sets the host to connect to.

Declaration
public string Host { get; set; }
Property Value
Type Description
string

The host.

Incremental

Gets or sets a value indicating whether to use incremental updates.

Declaration
public bool Incremental { get; set; }
Property Value
Type Description
bool

true if incremental; otherwise, false.

OffsetX

Gets or sets the X offset for screen scrapping.

Declaration
public int OffsetX { get; set; }
Property Value
Type Description
int

The X offset.

OffsetY

Gets or sets the Y offset for screen scrapping.

Declaration
public int OffsetY { get; set; }
Property Value
Type Description
int

The Y offset.

Password

Gets or sets the password.

Declaration
public string Password { get; set; }
Property Value
Type Description
string

The password.

Port

Gets or sets the port.

Declaration
public int Port { get; set; }
Property Value
Type Description
int

The port.

RFBVersion

Gets or sets the RFB protocol version.

Declaration
public string RFBVersion { get; set; }
Property Value
Type Description
string

The version.

Shared

Gets or sets a value indicating whether to share desktop with other clients.

Declaration
public bool Shared { get; set; }
Property Value
Type Description
bool

true if shared; otherwise, false.

Uri

Gets or sets the URI to an RFB from. URI format is RFC compliant.

Declaration
public string Uri { get; set; }
Property Value
Type Description
string

The URI.

UseCopyrect

Gets or sets a value indicating whether use copyrect encoding.

Declaration
public bool UseCopyrect { get; set; }
Property Value
Type Description
bool

true if use copyrect encoding; otherwise, false.

ViewOnly

Gets or sets a value indicating whether only view the desktop.

Declaration
public bool ViewOnly { get; set; }
Property Value
Type Description
bool

true if view only; otherwise, false.

Width

Gets or sets the width.

Declaration
public int Width { get; set; }
Property Value
Type Description
int

The width.

Methods

CreateBlock()

Creates the block.

Declaration
public MediaBlock CreateBlock()
Returns
Type Description
MediaBlock

MediaBlock.

ReadInfoAsync()

Reads the information asynchronous.

Declaration
public Task<MediaFileInfo> ReadInfoAsync()
Returns
Type Description
Task<MediaFileInfo>

Task<MediaFileInfo>.

Implements

IMediaPlayerBaseSourceSettings
IVideoCaptureBaseVideoSourceSettings
IVideoMixerSource
IVideoSourceSettings
IMediaBlockSettings

See Also