CameraControlOptions (raspoid 1.0 API)

java.lang.Object
- com.raspoid.additionalcomponents.camera.CameraControlOptions

Direct Known Subclasses:

PictureConfig, PreviewConfig, VideoConfig
```
public class CameraControlOptions
extends java.lang.Object
```
This class is used to set general parameters regarding the camera options.
Those options are general in the sense that they can be used for a simple preview as well as for a new picture or a new video.

The default, min and max values of those options are defined according to informations given in official documentation (RaspberryPi/Camera)

See Also:

PreviewConfig, PictureConfig, VideoConfig

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BRIGHTNESS` Default brightness value.
`static int`	`DEFAULT_CONTRAST` Deault contrast value.
`static int`	`DEFAULT_EV_COMPENSATION` Default EV compensation value.
`static int`	`DEFAULT_SATURATION` Default saturation value.
`static int`	`DEFAULT_SHARPNESS` Default sharpness value.
`static int`	`MAX_BRIGHTNESS` Maximum brightness value.
`static int`	`MAX_CONTRAST` Maximum contrast value.
`static int`	`MAX_EV_COMPENSATION` Maximum EV compensation value.
`static int`	`MAX_ISO` Maximum ISO value.
`static int`	`MAX_SATURATION` Maximum saturation value.
`static int`	`MAX_SHARPNESS` Maximum sharpness value.
`static int`	`MIN_BRIGHTNESS` Minimum brightness value.
`static int`	`MIN_CONTRAST` Minimum contrast value.
`static int`	`MIN_EV_COMPENSATION` Minimum EV compensation value.
`static int`	`MIN_ISO` Minimum ISO value.
`static int`	`MIN_SATURATION` Minimum saturation value.
`static int`	`MIN_SHARPNESS` Minimum sharpness value.

Constructor Summary

Constructors
Constructor and Description

CameraControlOptions()

Constructors
Constructor and Description
`CameraControlOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`annotate(boolean annotationTime, boolean annotationDate, java.lang.String annotationTxt)` Add some text and/or metadata to the picture.
`protected java.lang.String`	`getOptions()` Get the options to add to command line requests, regarding camera control options.
`void`	`setAWBMode(AWBMode awbMode)` Set the Automatic White Balance (AWB) mode.
`void`	`setBrightness(int brightness)` Set the brightness of the image.
`void`	`setCameraMode(CameraMode cameraMode)` Sets a specified sensor mode, disabling the automatic selection.
`void`	`setContrast(int contrast)` Set the contrast of the image.
`void`	`setEVCompensation(int evCompensation)` Set the EV compensation of the image.
`void`	`setExposureMode(ExposureMode exposureMode)` Set the exposure mode.
`void`	`setHorizontalFlip(boolean active)` Flips the preview and saved image horizontally.
`void`	`setImageEffect(ImageEffect imageEffect)` Set an effect to be applied to the image.
`void`	`setISO(int iso)` Sets the ISO to be used for captures.
`void`	`setRotationDegree(RotationDegree rotationDegree)` Sets the rotation of the image in viewfinder and resulting image.
`void`	`setSaturation(int saturation)` Set the colour saturation of the image.
`void`	`setSharpness(int sharpness)` Set the sharpness of the image.
`void`	`setVerticalFlip(boolean active)` Flips the preview and saved image vertically.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SHARPNESS
```
public static final int DEFAULT_SHARPNESS
```
    Default sharpness value.
    
    See Also:
    
    Constant Field Values
  - MAX_SHARPNESS
```
public static final int MAX_SHARPNESS
```
    Maximum sharpness value.
    
    See Also:
    
    Constant Field Values
  - MIN_SHARPNESS
```
public static final int MIN_SHARPNESS
```
    Minimum sharpness value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONTRAST
```
public static final int DEFAULT_CONTRAST
```
    Deault contrast value.
    
    See Also:
    
    Constant Field Values
  - MAX_CONTRAST
```
public static final int MAX_CONTRAST
```
    Maximum contrast value.
    
    See Also:
    
    Constant Field Values
  - MIN_CONTRAST
```
public static final int MIN_CONTRAST
```
    Minimum contrast value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BRIGHTNESS
```
public static final int DEFAULT_BRIGHTNESS
```
    Default brightness value.
    
    See Also:
    
    Constant Field Values
  - MAX_BRIGHTNESS
```
public static final int MAX_BRIGHTNESS
```
    Maximum brightness value.
    
    See Also:
    
    Constant Field Values
  - MIN_BRIGHTNESS
```
public static final int MIN_BRIGHTNESS
```
    Minimum brightness value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SATURATION
```
public static final int DEFAULT_SATURATION
```
    Default saturation value.
    
    See Also:
    
    Constant Field Values
  - MAX_SATURATION
```
public static final int MAX_SATURATION
```
    Maximum saturation value.
    
    See Also:
    
    Constant Field Values
  - MIN_SATURATION
```
public static final int MIN_SATURATION
```
    Minimum saturation value.
    
    See Also:
    
    Constant Field Values
  - MAX_ISO
```
public static final int MAX_ISO
```
    Maximum ISO value.
    
    See Also:
    
    Constant Field Values
  - MIN_ISO
```
public static final int MIN_ISO
```
    Minimum ISO value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EV_COMPENSATION
```
public static final int DEFAULT_EV_COMPENSATION
```
    Default EV compensation value.
    
    See Also:
    
    Constant Field Values
  - MAX_EV_COMPENSATION
```
public static final int MAX_EV_COMPENSATION
```
    Maximum EV compensation value.
    
    See Also:
    
    Constant Field Values
  - MIN_EV_COMPENSATION
```
public static final int MIN_EV_COMPENSATION
```
    Minimum EV compensation value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CameraControlOptions
```
public CameraControlOptions()
```
- Method Detail
  - setSharpness
```
public void setSharpness(int sharpness)
```
    Set the sharpness of the image. Sharpness value between -100 and 100. Default is 0.
    
    Parameters:
    
    sharpness - the new sharpness value, in the -100..100 interval.
  - setContrast
```
public void setContrast(int contrast)
```
    Set the contrast of the image. Contrast value between -100 and 100. Default is 0.
    
    Parameters:
    
    contrast - the new contrast value, in the -100..100 interval.
  - setBrightness
```
public void setBrightness(int brightness)
```
    Set the brightness of the image. 0 is black, 100 is white. Default is 50.
    
    Parameters:
    
    brightness - the new brightness value, in the 0..100 interval.
  - setSaturation
```
public void setSaturation(int saturation)
```
    Set the colour saturation of the image. Saturation value between -100 and 100. 0 is the default.
    
    Parameters:
    
    saturation - the new saturation value, in the -100..100 interval.
  - setISO
```
public void setISO(int iso)
```
    Sets the ISO to be used for captures. Range is 100 to 800.
    
    Parameters:
    
    iso - the new ISO value, in the 100..800 interval.
  - setEVCompensation
```
public void setEVCompensation(int evCompensation)
```
    Set the EV compensation of the image. Range is -10 to +10. Default is 10.
    
    Parameters:
    
    evCompensation - the new EV compensation value, in the -10..10 interval.
  - setExposureMode
```
public void setExposureMode(ExposureMode exposureMode)
```
    Set the exposure mode.
    
    Parameters:
    
    exposureMode - the new exposure mode.
  - setAWBMode
```
public void setAWBMode(AWBMode awbMode)
```
    Set the Automatic White Balance (AWB) mode.
    
    Parameters:
    
    awbMode - the new automatic white balance mode.
  - setImageEffect
```
public void setImageEffect(ImageEffect imageEffect)
```
    Set an effect to be applied to the image.
    
    Parameters:
    
    imageEffect - the new effected to be applied to the image.
  - setRotationDegree
```
public void setRotationDegree(RotationDegree rotationDegree)
```
    Sets the rotation of the image in viewfinder and resulting image. This can take any value from 0 upwards, but due to hardware constraints only 0, 90, 180 and 270 degree rotations are supported (cfr RotationDegree).
    
    Parameters:
    
    rotationDegree - the new rotation to be applied to the image.
  - setHorizontalFlip
```
public void setHorizontalFlip(boolean active)
```
    Flips the preview and saved image horizontally.
    
    Parameters:
    
    active - true to flip the image horizontally. False otherwise.
  - setVerticalFlip
```
public void setVerticalFlip(boolean active)
```
    Flips the preview and saved image vertically.
    
    Parameters:
    
    active - true to flip the image vertically. False otherwise.
  - setCameraMode
```
public void setCameraMode(CameraMode cameraMode)
```
    Sets a specified sensor mode, disabling the automatic selection.
    
    Parameters:
    
    cameraMode - the new camera mode to be applied on the image.
  - annotate
```
public void annotate(boolean annotationTime,
                     boolean annotationDate,
                     java.lang.String annotationTxt)
```
    Add some text and/or metadata to the picture.
    
    Parameters:
    
    annotationTime - true to add time on the picture. False otherwise.
    
    annotationDate - true to add date on the picture. False otherwise.
    
    annotationTxt - the text to add on the picture. null if unused
  - getOptions
```
protected java.lang.String getOptions()
```
    Get the options to add to command line requests, regarding camera control options.
    
    Returns:
    
    the options to add to raspistill and raspivid command line requests.

Class CameraControlOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SHARPNESS

MAX_SHARPNESS

MIN_SHARPNESS

DEFAULT_CONTRAST

MAX_CONTRAST

MIN_CONTRAST

DEFAULT_BRIGHTNESS

MAX_BRIGHTNESS

MIN_BRIGHTNESS

DEFAULT_SATURATION

MAX_SATURATION

MIN_SATURATION

MAX_ISO

MIN_ISO

DEFAULT_EV_COMPENSATION

MAX_EV_COMPENSATION

MIN_EV_COMPENSATION

Constructor Detail

CameraControlOptions

Method Detail

setSharpness

setContrast

setBrightness

setSaturation

setISO

setEVCompensation

setExposureMode

setAWBMode

setImageEffect

setRotationDegree

setHorizontalFlip

setVerticalFlip

setCameraMode

annotate

getOptions