Table of Contents

Class SpinnakerSourceSettings

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

Spinnaker SDK cameras source settings.

public class SpinnakerSourceSettings : IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Constructors

SpinnakerSourceSettings(string, Rect, VideoFrameRate, SpinnakerPixelFormat)

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

public SpinnakerSourceSettings(string name, Rect region, VideoFrameRate frameRate, SpinnakerPixelFormat pixelFormat = SpinnakerPixelFormat.RGB)

Parameters

name string

Name of the device.

region Rect

The region.

frameRate VideoFrameRate

The frame rate.

pixelFormat SpinnakerPixelFormat

The pixel format.

Exceptions

ArgumentNullException

name or region is null.

ArgumentException

name is empty or whitespace.

Properties

ExposureMaximum

Gets or sets the maximum exposure time for the auto exposure algoritm(us) [10 - 29999999].

public int ExposureMaximum { get; set; }

Property Value

int

ExposureMinimum

Gets or sets the the minimum exposure time for the auto exposure algoritm (us) [10 - 29999999].

public int ExposureMinimum { get; set; }

Property Value

int

FrameRate

Gets or sets the frame rate.

[JsonInclude]
public VideoFrameRate FrameRate { get; }

Property Value

VideoFrameRate

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

PixelFormat

Gets the pixel format.

[JsonInclude]
public SpinnakerPixelFormat PixelFormat { get; }

Property Value

SpinnakerPixelFormat

Region

Gets or sets the region.

[JsonInclude]
public Rect Region { get; }

Property Value

Rect

ShutterType

Gets or sets the type of the shutter.

public SpinnakerSourceShutterType ShutterType { get; set; }

Property Value

SpinnakerSourceShutterType

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.