Table of Contents

Class GenICamSourceSettings

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

GenICam camera source settings.

public class GenICamSourceSettings : IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Constructors

GenICamSourceSettings(string, Rect, VideoFrameRate, GenICamPixelFormat)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.GenICamSourceSettings class.

[JsonConstructor]
public GenICamSourceSettings(string name, Rect region, VideoFrameRate frameRate, GenICamPixelFormat pixelFormat)

Parameters

name string

Name of the device.

region Rect

The region.

frameRate VideoFrameRate

The frame rate.

pixelFormat GenICamPixelFormat

The pixel format.

Remarks

Marked [JsonConstructor] because this class declares two constructors and no parameterless one - System.Text.Json has no rule to pick between them and refuses the type outright, so every document holding a GenICam source failed to load while the [JsonInclude] region, frame rate and pixel format were written into it regardless.

Exceptions

ArgumentNullException

name or region is null.

ArgumentException

name is empty or whitespace.

GenICamSourceSettings(string)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.GenICamSourceSettings class.

public GenICamSourceSettings(string name)

Parameters

name string

Name of the device.

Exceptions

ArgumentNullException

name is null.

ArgumentException

name is empty or whitespace.

Properties

AutoExposureMode

Gets or sets the automatic exposure mode.

public GenICamSettingsMode AutoExposureMode { get; set; }

Property Value

GenICamSettingsMode

AutoGainMode

Gets or sets the automatic gain mode.

public GenICamSettingsMode AutoGainMode { get; set; }

Property Value

GenICamSettingsMode

AutoPacketSize

Gets or sets a value indicating whether to negotiate GigEVision streaming packet size.

public bool AutoPacketSize { get; set; }

Property Value

bool

ExposureTime

Gets or sets the exposure time [0 - 100_000_000 µs].

public TimeSpan? ExposureTime { get; set; }

Property Value

TimeSpan?

Features

Gets or sets the additional configuration parameters as a space separated list of feature assignations.

public string Features { get; set; }

Property Value

string

FrameRate

Gets the frame rate.

[JsonInclude]
public VideoFrameRate FrameRate { get; }

Property Value

VideoFrameRate

Gain

Gets or sets the gain (dB) [-1.0 - 500].

public double Gain { get; set; }

Property Value

double

HBinning

Gets or sets the CCD horizontal binning.

public int HBinning { get; set; }

Property Value

int

Name

Gets or sets the camera name.

[JsonInclude]
public string Name { get; set; }

Property Value

string

Remarks

[JsonInclude] on a settable property looks redundant, and is not: it is what puts the name on the required-property gate, so a document omitting it - or carrying an empty one - is reported as MBS043 naming the property, and MediaBlockDescriptor.Properties tells a host authoring the block that it is required. The constructors enforce the same invariant on the way in; the setter stays public because a host editing the block needs it, so a name cleared after construction is not covered here.

OffsetX

Gets or sets the X offset.

public int OffsetX { get; set; }

Property Value

int

OffsetY

Gets or sets the Y offset.

public int OffsetY { get; set; }

Property Value

int

PacketDelay

Gets or sets the GigEVision streaming inter packet delay (in ns, -1 = default).

public long PacketDelay { get; set; }

Property Value

long

PacketResend

Gets or sets a value indicating whether to request dropped packets to be reissued by the camera.

public bool PacketResend { get; set; }

Property Value

bool

PacketSize

Gets or sets the size of the packet [36-65500].

public int PacketSize { get; set; }

Property Value

int

PixelFormat

Gets the pixel format.

[JsonInclude]
public GenICamPixelFormat PixelFormat { get; }

Property Value

GenICamPixelFormat

Region

Gets the region.

[JsonInclude]
public Rect Region { get; }

Property Value

Rect

USBMode

Gets or sets the USB mode.

public GenICamUSBMode USBMode { get; set; }

Property Value

GenICamUSBMode

VBinning

Gets or sets the CCD vertical binning.

public int VBinning { get; set; }

Property Value

int

VBuffersNumber

Gets or sets the number of video buffers to allocate for video frames.

public int VBuffersNumber { get; set; }

Property Value

int

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

ToString()

Returns a String that represents this instance.

public override string ToString()

Returns

string

A String that represents this instance.