Table of Contents

Class VNCSourceBlock

Namespace
VisioForge.Core.MediaBlocks.Sources
Assembly
VisioForge.Core.dll

VNC (Virtual Network Computing) source block for remote desktop access and screen sharing. Provides real-time screen capture from remote computers via RFB (Remote Framebuffer) protocol for remote assistance, system administration, and collaborative workflows with support for various VNC server implementations and authentication methods. Implements the VisioForge.Core.MediaBlocks.Sources.SourceMediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class VNCSourceBlock : SourceMediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

VNCSourceBlock(VNCSourceSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Sources.VNCSourceBlock class with custom VNC settings. Configures the VNC source for remote desktop access with specified connection and display parameters.

public VNCSourceBlock(VNCSourceSettings settings)

Parameters

settings VNCSourceSettings

The VNC settings controlling host, port, authentication, encoding, and display configuration parameters.

Properties

Input

Gets the primary input pad (none for source blocks that receive network streams).

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads available on this block (none for source blocks).

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the primary video output pad for the remote screen.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads available on this block (single video output for VNC).

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets or sets the VNC configuration settings that control connection parameters and display options.

public VNCSourceSettings Settings { get; set; }

Property Value

VNCSourceSettings

Type

Gets the media block type identifier for VNC source operations.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Builds and initializes the VNC source within the pipeline context. Establishes VNC connection, configures remote screen capture, and prepares video output for downstream processing.

public override bool Build()

Returns

bool

true if the VNC source was successfully built and configured; otherwise, false.

CleanUp()

Cleans up all resources associated with the VNC operations, including network connection and video buffers.

public void CleanUp()

Dispose(bool)

Releases unmanaged and managed resources used by the VNC source. Properly closes VNC connection and disposes of GStreamer elements and video processing resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetCore()

Gets the core GStreamer element wrapper for advanced configuration and monitoring.

public BaseElement GetCore()

Returns

BaseElement

Always null for composite source blocks with multiple internal elements.

GetElement()

Gets the native GStreamer element for direct GStreamer pipeline integration.

public Element GetElement()

Returns

Element

The VNC source GStreamer element.

IsAvailable()

Determines whether VNC support is available on the current system. Requires GStreamer VNC source plugins and RFB protocol support to be installed and functional.

public static bool IsAvailable()

Returns

bool

true if VNC support is available; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Sets the pipeline context for this VNC source, providing access to the parent pipeline and logging context.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The parent MediaBlocks pipeline containing this VNC source.

See Also