Class CameraSettingsBase
A base class to implement raspistill and raspivid wrappers Full documentation available at https://www.raspberrypi.org/documentation/raspbian/applications/camera.md.
Inherited Members
Namespace: Unosquare.RaspberryIO.Camera
Syntax
public abstract class CameraSettingsBaseFields
Ci
The Invariant Culture shorthand.
Declaration
protected static readonly CultureInfo CiField Value
| Type | Description |
|---|---|
| CultureInfo |
Properties
CaptureDisplayPreview
Gets or sets a value indicating whether or not to show a preview window on the screen.
Declaration
public bool CaptureDisplayPreview { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
CaptureDisplayPreviewInFullScreen
Gets or sets a value indicating whether a preview window is shown in full screen mode if enabled.
Declaration
public bool CaptureDisplayPreviewInFullScreen { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
CaptureDisplayPreviewOpacity
Gets or sets the display preview opacity only if the display preview property is enabled.
Declaration
public byte CaptureDisplayPreviewOpacity { get; set; }Property Value
| Type | Description |
|---|---|
| Byte |
CaptureDynamicRangeCompensation
Gets or sets the dynamic range compensation. DRC changes the images by increasing the range of dark areas, and decreasing the brighter areas. This can improve the image in low light areas.
Declaration
public CameraDynamicRangeCompensation CaptureDynamicRangeCompensation { get; set; }Property Value
| Type | Description |
|---|---|
| CameraDynamicRangeCompensation |
CaptureExposure
Gets or sets the exposure mode.
Declaration
public CameraExposureMode CaptureExposure { get; set; }Property Value
| Type | Description |
|---|---|
| CameraExposureMode |
CaptureExposureCompensation
Gets or sets the picture EV compensation. Default is 0, Range is -10 to 10 Camera exposure compensation is commonly stated in terms of EV units; 1 EV is equal to one exposure step (or stop), corresponding to a doubling of exposure. Exposure can be adjusted by changing either the lens f-number or the exposure time; which one is changed usually depends on the camera's exposure mode.
Declaration
public int CaptureExposureCompensation { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
CaptureHeight
Gets or sets the height of the picture to take. Less than or equal to 0 in either width or height means maximum resolution available.
Declaration
public int CaptureHeight { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
CaptureMeteringMode
Gets or sets the capture metering mode.
Declaration
public CameraMeteringMode CaptureMeteringMode { get; set; }Property Value
| Type | Description |
|---|---|
| CameraMeteringMode |
CaptureSensorRoi
Gets or sets the capture sensor region of interest in relative coordinates.
Declaration
public CameraRect CaptureSensorRoi { get; set; }Property Value
| Type | Description |
|---|---|
| CameraRect |
CaptureShutterSpeedMicroseconds
Gets or sets the capture shutter speed in microseconds. Default -1, Range 0 to 6000000 (equivalent to 6 seconds).
Declaration
public int CaptureShutterSpeedMicroseconds { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
CaptureTimeoutMilliseconds
Gets or sets the timeout milliseconds. Default value is 5000 Recommended value is at least 300 in order to let the light collectors open.
Declaration
public int CaptureTimeoutMilliseconds { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
CaptureVideoStabilizationEnabled
Gets or sets a value indicating whether video stabilization should be enabled.
Declaration
public bool CaptureVideoStabilizationEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
CaptureWhiteBalanceControl
Gets or sets the automatic white balance mode. By default it is set to Auto.
Declaration
public CameraWhiteBalanceMode CaptureWhiteBalanceControl { get; set; }Property Value
| Type | Description |
|---|---|
| CameraWhiteBalanceMode |
CaptureWhiteBalanceGainBlue
Gets or sets the capture white balance gain on the blue channel. Example: 1.25 Only takes effect if White balance control is set to off. Default is 0.
Declaration
public decimal CaptureWhiteBalanceGainBlue { get; set; }Property Value
| Type | Description |
|---|---|
| Decimal |
CaptureWhiteBalanceGainRed
Gets or sets the capture white balance gain on the red channel. Example: 1.75 Only takes effect if White balance control is set to off. Default is 0.
Declaration
public decimal CaptureWhiteBalanceGainRed { get; set; }Property Value
| Type | Description |
|---|---|
| Decimal |
CaptureWidth
Gets or sets the width of the picture to take. Less than or equal to 0 in either width or height means maximum resolution available.
Declaration
public int CaptureWidth { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
CommandName
Gets the command file executable.
Declaration
public abstract string CommandName { get; }Property Value
| Type | Description |
|---|---|
| String |
ImageAnnotationBackground
Gets or sets the background color for text annotations.
Declaration
public CameraColor ImageAnnotationBackground { get; set; }Property Value
| Type | Description |
|---|---|
| CameraColor | The image annotation background. |
ImageAnnotationFontColor
Gets or sets the color of the text annotations.
Declaration
public CameraColor ImageAnnotationFontColor { get; set; }Property Value
| Type | Description |
|---|---|
| CameraColor | The color of the image annotation font. |
ImageAnnotationFontSize
Gets or sets the font size of the text annotations Default is -1, range is 6 to 160.
Declaration
public int ImageAnnotationFontSize { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ImageAnnotations
Gets or sets the image annotations using a bitmask (or flags) notation. Apply a bitwise OR to the enumeration to include multiple annotations.
Declaration
public CameraAnnotation ImageAnnotations { get; set; }Property Value
| Type | Description |
|---|---|
| CameraAnnotation |
ImageAnnotationsText
Gets or sets the image annotations text. Text may include date/time placeholders by using the '%' character, as used by strftime. Example: ABC %Y-%m-%d %X will output ABC 2015-10-28 20:09:33.
Declaration
public string ImageAnnotationsText { get; set; }Property Value
| Type | Description |
|---|---|
| String |
ImageBrightness
Gets or sets the picture brightness. Default is 50, Range form 0 to 100.
Declaration
public int ImageBrightness { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ImageColorEffectU
Gets or sets the color effect U coordinates. Default is -1, Range is 0 to 255 128:128 should be effectively a monochrome image.
Declaration
public int ImageColorEffectU { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ImageColorEffectV
Gets or sets the color effect V coordinates. Default is -1, Range is 0 to 255 128:128 should be effectively a monochrome image.
Declaration
public int ImageColorEffectV { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ImageContrast
Gets or sets the picture contrast. Default is 0, Range form -100 to 100.
Declaration
public int ImageContrast { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ImageEffect
Gets or sets the image capture effect to be applied.
Declaration
public CameraImageEffect ImageEffect { get; set; }Property Value
| Type | Description |
|---|---|
| CameraImageEffect |
ImageFlipHorizontally
Gets or sets a value indicating whether the image should be flipped horizontally.
Declaration
public bool ImageFlipHorizontally { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
ImageFlipVertically
Gets or sets a value indicating whether the image should be flipped vertically.
Declaration
public bool ImageFlipVertically { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
ImageIso
Gets or sets the picture ISO. Default is -1 Range is 100 to 800 The higher the value, the more light the sensor absorbs.
Declaration
public int ImageIso { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ImageRotation
Gets or sets the image rotation. Default is no rotation.
Declaration
public CameraImageRotation ImageRotation { get; set; }Property Value
| Type | Description |
|---|---|
| CameraImageRotation |
ImageSaturation
Gets or sets the picture saturation. Default is 0, Range form -100 to 100.
Declaration
public int ImageSaturation { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ImageSharpness
Gets or sets the picture sharpness. Default is 0, Range form -100 to 100.
Declaration
public int ImageSharpness { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
Methods
CreateProcessArguments()
Creates the process arguments.
Declaration
public virtual string CreateProcessArguments()Returns
| Type | Description |
|---|---|
| String | The string that represents the process arguments. |
