Settings Class

Represents the current capture settings that will be used for acquisition and live preview

Inheritance Hierarchy

SystemObject
  MediaCy.IQL.ApplicationMcCommand
    MediaCy.IQL.ApplicationMcCommandExtended
      MediaCy.CommandsBaseCommand
        CaptureBaseCommand
          MediaCy.Commands.CaptureCaptureErrorBaseCommand
            MediaCy.Commands.CaptureSettings

Namespace: MediaCy.Commands.Capture
Assembly: MediaCy.Commands.Capture (in MediaCy.Commands.Capture.dll) Version: 1.0.0.0

Syntax

Copy

Public Class Settings
	Inherits CaptureErrorBaseCommand

The Settings type exposes the following members.

Properties

	Name	Description
	AutoAdjustForBinning	Determines whether to auto-adjust the exposure when the binning is changed.
	AutoName	Determines whether images are automatically named when acquired, using the auto-name settings
	AutoNameExtraLabel	An extra label selection that is added to automatically generated image names.
	AutoNameExtraLabelAtEnd	An extra label selection that is added to automatically generated image names.
	AutoNameExtraLabelTable	The auto-name extra label formats that are supported.
	AutoNameFormat	The format that is used to automatically generate file names.
	AutoNameFormatTable	The auto-name formats that are supported.
	AutoNameMinimumDigitsSuffix	The number of digits to use in a numerical suffix that is added to automatically generated file names.
	AutoNameNumericSuffix	Determines whether a numeric suffix is added to automatically generated file names.
	AutoNamePrefix	A prefix that is added to automatically generated file names.
	AutoNameStartAtSuffix	A prefix that is added to automatically generated file names.
	Binning	Binning along the axes of the camera.
	BitDepth	Bit depth control
	Brightness	Brightness control
	CaptureDevice
	CaptureToFile	Determines whether to save the acquisition to file at the completion of the acquisition.
	Contrast	Contrast control
	DateTimeStamp	Determines whether to add a date stamp to each acquired image
	Duration	The duration of a movie acquisition.
	DynamicAutoContrast	Determines whether the device should dynamically determine brightness and contrast.
	DynamicAutoExposure	Determines whether the device should dynamically determine auto-exposure.
	DynamicAutoRange	Determines whether the device should dynamically determine black/white levels.
	Exposure	Exposure time in milliseconds
	FastMovieCapture	Determines if movies that are recorded are recorded "as fast as possible" (if True) or at the specified Interval
	FastMovieFrames	Determines the number of frames to acquire for movies that are recorded "as fast as possible"
	FileCompression	File format compression in which images captured to disk will be stored.
	FileFormat	File format in which images captured to disk will be stored.
	FilePath	Folder where images captured to disk will be stored.
	FileQuality	File format compression quality in which images captured to disk will be stored.
	Gain	Primary gain control
	Gamma	Gamma control
	Hue	Hue control
	Interval	The interval between acquisitions of a movie acquisition.
	IsSettingSupported	Returns whether the specified attribute or setting is supported by the currently selected device.
	MarkerBar	Determines whether to add a calibration marker bar to each acquired image
	NumberOfFastMovieFramesAvailable	Returns the maximum number of FastMovieFrames available.
	Offset	Offset control
	PrePostTriggerControl	Determines how to control triggering during acquisition.
	PreviewSettings	Determines whether the Preview or acquisition (Acquire and Record) settings are adjusted.
	PromptFilename	The default file name used when prompting for a file name.
	PromptForFilename	Determines whether to prompt for a file name after acquisition.
	Resolution	The camera resolution at which to acquire.
	Saturation	Saturation control
	SettingsFilename	The currently loaded settings file.
	SettingsFolder	The current folder searched for settings files.
	ShutterControl	Determines how to control the shutter during acquisition.
	StreamToDisk	Determines whether to stream movie recording to disk.
	SubRegion	The current camera sub-region to acquire

Top

Methods

	Name	Description
	Attribute	Returns a capture attribute of the currently selected device.

Top

Remarks

Normally, Preview and Acquire/Record capture settings are locked. There are a set of capture settings that may be unlocked to allow Preview and Acquire to have different settings (including for example Exposure and Binning). For these settings, the PreviewSettings property determines whether this class represents the settings that will be used for Acquire and Record, or the Preview settings. The complete list of these settings includes: Exposure Binning Resolution Gain Contrast Brightness Gamma Hue Saturation Offset BitDepth The Settings command also supports all the rest of the capture settings that cannot have separate Preview and Acquire/Record values, like the option whether to lock the settings.

Reference

MediaCy.Commands.Capture Namespace