RPiCamera (jrpicam 1.1.0 API)

java.lang.Object
- com.hopding.jrpicam.RPiCamera

```
public class RPiCamera
extends java.lang.Object
```
RPiCamera is used to access the Raspberry Pi Camera and take still photos. There are a variety of different settings that may be changed to modify images taken by an RPiCamera instance, such as width, height, AWB, DRC, and the resulting image's encoding type (jpg, bmp, png, gif).
Although it provides additional features and support for Java specific operations, RPiCamera is essentially a wrapper class for executing the raspistill software from within a Java application. Thus it is essential that all Raspberry Pis using the JRPiCam library have properly configured and working raspistill software.
Usage Example:
```
 // Directory to save pictures to
 String saveDir = "/home/pi/Pictures";

 // Create RPiCamera instance
 RPiCamera camera = new RPiCamera(saveDir)
     .setWidth(150)   // Set width property of RPiCamera.
     .setHeight(150); // Set height property of RPiCamera.

 // Take a picture and save it as "/home/pi/Pictures/APicture.jpg"
 camera.takeStill("APicture.jpg"); 

 
```

Constructor Summary

Constructors
Constructor and Description

RPiCamera()
Creates new RPiCamera.

RPiCamera(java.lang.String saveDir)
Creates new RPiCamera and sets its save directory.

Constructors
Constructor and Description
`RPiCamera()` Creates new RPiCamera.
`RPiCamera(java.lang.String saveDir)` Creates new RPiCamera and sets its save directory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RPiCamera`	`disableBurst()` Turns off burst mode for RPiCamera.
`RPiCamera`	`enableBurst()` Turns on burst mode for RPiCamera.
`java.lang.String`	`getPrevCommand()` Gets the raspistill command previously executed by the RPiCamera.
`RPiCamera`	`selectCamera(int camNumber)` Selects which camera to use (on a multicamera system).
`RPiCamera`	`setAddRawBayer(boolean add)` Appends raw Bayer data from the RPiCamera to the image's JPEG metadata.
`RPiCamera`	`setAWB(AWB awb)` Sets Automatic White Balance (AWB) mode.
`RPiCamera`	`setBrightness(int brightness)` Sets brightness of image (0 to 100), default value is 50.
`RPiCamera`	`setColourEffect(int U, int V)` Sets colour effect of RPiCamera.
`RPiCamera`	`setContrast(int contrast)` Sets contrast of image (-100 to 100), default value is 0.
`RPiCamera`	`setDateTimeOff()` Disables effects of `setDateTimeOn()`.
`RPiCamera`	`setDateTimeOn()` Replaces output pattern (%d) in save file name with DateTime (MonthDayHourMinSec).
`RPiCamera`	`setDRC(DRC drc)` Sets the Dynamic Range Compression of image.
`RPiCamera`	`setEncoding(Encoding encoding)` Sets the encoding for images.
`RPiCamera`	`setExposure(Exposure exposure)` Sets exposure mode of RPiCamera.
`RPiCamera`	`setFullPreviewOff()` Turns off fullpreview mode.
`RPiCamera`	`setFullPreviewOn()` Runs the preview windows using the full resolution capture mode.
`RPiCamera`	`setHeight(int height)` Sets height of images taken by the RPiCamera.
`RPiCamera`	`setHorizontalFlipOff()` Turns off horizontal flip.
`RPiCamera`	`setHorizontalFlipOn()` Flips the preview and saved image horizontally.
`RPiCamera`	`setImageEffect(ImageEffect imageEffect)` Sets an effect to be applied to image.
`RPiCamera`	`setISO(int iso)` WARNING: OPERATION NOT YET SUPPORTED BY raspistill SOFTWARE.
`RPiCamera`	`setLinkLatestImage(boolean link, java.lang.String fileName)` Links latest image to the specified file.
`RPiCamera`	`setMeteringMode(MeteringMode meteringMode)` Sets metering mode used for preview and capture.
`RPiCamera`	`setPreviewFullscreen(boolean fullscreen)` Turn fullscreen preview on or off.
`RPiCamera`	`setPreviewOpacity(int opacity)` Sets the preview window's opacity (0 to 255).
`RPiCamera`	`setQuality(int quality)` Sets quality of image (0 to 100), 75 is recommended for usual purposes.
`RPiCamera`	`setRegionOfInterest(double x, double y, double w, double d)` Allows the specification of the area of the sensor to be used as the source for the preview and capture.
`RPiCamera`	`setRotation(int rotation)` Sets the rotation of the image in viewfinder and resulting image.
`RPiCamera`	`setSaturation(int saturation)` Sets colour saturation of image (-100 to 100), default is 0.
`RPiCamera`	`setSaveDir(java.lang.String saveDir)` Sets the RPiCamera's save directory.
`RPiCamera`	`setSharpness(int sharpness)` Sets sharpness of image (-100 to 100), default value is 0.
`RPiCamera`	`setShutter(int speed)` Set the shutter speed to the specified value (in microseconds).
`RPiCamera`	`setThumbnailParams(int x, int y, int quality)` Allows specification of the thumbnail image inserted in to the image file.
`RPiCamera`	`setTimeout(int time)` Sets the RPiCamera's timeout.
`RPiCamera`	`setTimestampOff()` Disables effects of `setTimestampOn()`.
`RPiCamera`	`setTimestampOn()` Replace output pattern (%d) with unix timestamp (seconds since 1970) E.g.
`RPiCamera`	`setToDefaults()` Sets all RPiCamera options to their default settings, overriding any previously set options.
`RPiCamera`	`setVerticalFlipOff()` Turns off vertical flip.
`RPiCamera`	`setVerticalFlipOn()` Flips the preview and saved image vertically.
`RPiCamera`	`setWidth(int width)` Sets width of images taken by RPiCamera.
`void`	`stop()` Stops any raspistill processes being run by RPiCamera.
`java.awt.image.BufferedImage`	`takeBufferedStill()` Takes an image and stores it in a BufferedImage object.
`java.awt.image.BufferedImage`	`takeBufferedStill(int width, int height)` Takes an image of the specified width and height and stores it in a BufferedImage object.
`java.io.File`	`takeStill(java.lang.String pictureName)` Takes an image and saves it under the specified name to the RPiCamera's save directory ("/home/pi/Pictures" by default).
`java.io.File`	`takeStill(java.lang.String pictureName, int width, int height)` Takes an image of the specified width and height and saves it under the specified name to the RPiCamera's save directory ("/home/pi/Pictures" by default).
`int[]`	`takeStillAsRGB(boolean keepPadding)` Captures an image and returns the RGB values of that image.
`int[]`	`takeStillAsRGB(int width, int height, boolean keepPadding)` Captures an image and returns the RGB values of that image.
`java.io.File`	`timelapse(boolean wait, java.lang.String pictureName, int time)` Take a series of timelapsed photos for the specified time frame and save them under the specified filename to the RPiCamera's save directory.
`RPiCamera`	`turnOffPreview()` Turns off image preview.
`RPiCamera`	`turnOffThumbnail()` Turns off image thumbnails.
`RPiCamera`	`turnOnPreview()` Turns on image preview.
`RPiCamera`	`turnOnPreview(int x, int y, int w, int h)` Defines the size and location on the screen that the preview window will be placed.

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

- Constructor Detail
  - RPiCamera
```
public RPiCamera()
          throws FailedToRunRaspistillException
```
    Creates new RPiCamera. The resulting RPiCamera's save directory will be set to "/home/pi/Pictures" and will have a default image width and height of 500.
    
    Throws:
    
    FailedToRunRaspistillException
  - RPiCamera
```
public RPiCamera(java.lang.String saveDir)
          throws FailedToRunRaspistillException
```
    Creates new RPiCamera and sets its save directory. The resulting RPiCamera will have a default image width and height of 500.
    
    Parameters:
    
    saveDir - A String specifying the directory for RPiCamera to save images.
    
    Throws:
    
    FailedToRunRaspistillException
- Method Detail
  - takeStill
```
public java.io.File takeStill(java.lang.String pictureName,
                              int width,
                              int height)
                       throws java.io.IOException,
                              java.lang.InterruptedException
```
    Takes an image of the specified width and height and saves it under the specified name to the RPiCamera's save directory ("/home/pi/Pictures" by default). The image's encoding will be the same as the RPiCamera's encoding setting (JPEG by default).
    Usage Example:
```
 // Create an RPiCamera instance using default constructor, which sets the 
 // save directory to "/home/pi/Pictures".
 RPiCamera piCamera = new RPiCamera()
     .setEncoding(Encoding.PNG); // Change encoding from JPEG to PNG

 // Take a 500x500 PNG image and save it as "/home/pi/Pictures/AStillImage.png"
 piCamera.takeStill("AStillImage.png", 500, 500);

 
```
    Parameters:
    
    pictureName - A String containing the name to save picture under.
    
    width - An int specifying the width of the image to take.
    
    height - An int specifying the height of the image to take.
    
    Returns:
    
    A File object representing the full path the picture was saved to.
    
    Throws:
    
    java.io.IOException
    
    java.lang.InterruptedException
  - takeStill
```
public java.io.File takeStill(java.lang.String pictureName)
                       throws java.io.IOException,
                              java.lang.InterruptedException
```
    Takes an image and saves it under the specified name to the RPiCamera's save directory ("/home/pi/Pictures" by default). The image's encoding will be the same as the RPiCamera's encoding setting (JPEG by default).
    Usage Example:
```
 // Create an RPiCamera instance using default constructor, which sets the
 // save directory to "/home/pi/Pictures".
 RPiCamera piCamera = new RPiCamera()
     .setEncoding(Encoding.PNG); // Change encoding from JPEG to PNG

 // Take a PNG image and save it as "/home/pi/Pictures/AStillImage.png"
 piCamera.takeStill("AStillImage.png");

 
```
    Parameters:
    
    pictureName - A String containing the name to save picture under.
    
    Returns:
    
    A File object representing the full path the picture was saved to.
    
    Throws:
    
    java.io.IOException
    
    java.lang.InterruptedException
  - takeBufferedStill
```
public java.awt.image.BufferedImage takeBufferedStill(int width,
                                                      int height)
                                               throws java.io.IOException,
                                                      java.lang.InterruptedException
```
    Takes an image of the specified width and height and stores it in a BufferedImage object. The resulting image is NOT saved anywhere in the Pi's memory. The image's encoding will be the same as the RPiCamera's encoding setting (JPEG by default).
    Usage Example:
```
 // Create an RPiCamera instance using default constructor, which sets the 
 // save directory to "/home/pi/Pictures".
 RPiCamera piCamera = new RPiCamera()
     .setEncoding(Encoding.PNG); // Change encoding from JPEG to PNG

 // Take a 500x500 PNG image and store it in a BufferedImage
 BufferedImage buffImg = piCamera.takeBufferedStill(500, 500);

 
```
    Parameters:
    
    width - An int specifying width of image to take.
    
    height - An int specifying height of image to take.
    
    Returns:
    
    A BufferedImage containing the image.
    
    Throws:
    
    java.io.IOException
    
    java.lang.InterruptedException
  - takeBufferedStill
```
public java.awt.image.BufferedImage takeBufferedStill()
                                               throws java.io.IOException,
                                                      java.lang.InterruptedException
```
    Takes an image and stores it in a BufferedImage object. The resulting image is NOT saved anywhere in the Pi's memory. The image's encoding will be the same as the RPiCamera's encoding setting (JPEG by default).
    Usage Example:
```
 // Create an RPiCamera instance using default constructor, which sets the
 // save directory to "/home/pi/Pictures".
 RPiCamera piCamera = new RPiCamera()
     .setEncoding(Encoding.PNG); // Change encoding from JPEG to PNG

 // Take a PNG image and store it in a BufferedImage
 BufferedImage buffImg = piCamera.takeBufferedStill();

 
```
    Returns:
    
    A BufferedImage containing the image.
    
    Throws:
    
    java.io.IOException
    
    java.lang.InterruptedException
  - takeStillAsRGB
```
public int[] takeStillAsRGB(int width,
                            int height,
                            boolean keepPadding)
                     throws java.io.IOException
```
    Captures an image and returns the RGB values of that image. Images taken in this manner are not encoded, rather rather their RGB values are stored in an int array. Indexes 0 - 2 of the array make up the red, green, and blue values of the upper left pixel in the image. The pixels are added to the array from left to right, top to bottom.
    If an image's dimensions are not multiples of 16, then black padding will be added onto the right and bottom sides of an image until both the width and height are multiples of 16 (e.g. a 500x500 image would have a black band 12 pixels thick added to the right and bottom sides to achieve dimensions of 512x512, the closest multiple of 16 to 500).
    The boolean keepPadding parameter may be set to false to remove this padding. Note that this does require extra computations to be performed, so it has the potential to slightly reduce the fps a Pi is capable of. However, this has not yet been officially tested for. If the padding is kept, then it is the responsibility of the caller to determine what the dimensions of the resulting image will be, and adjust their processing as such (e.g. If the padding is kept on a 500x500 image, the array that is returned will contain 786,432 elements, as opposed to the 750,000 one would expect from a 500x500 image. This is because the image stored in the returned array is not 500x500, but 512x512 and the caller of this method must take that into account when processing the image).
    Usage Example:
```
 // Creating and setting up an RPiCamera
 RPiCamera piCamera = new RPiCamera()
      .turnOffPreview()
      .setTimeout(1);

 // Capture an image and store its RGB values, not preserving the border
 int[] rgbVals = piCamera.takeStillAsRGB(500, 500, false);

 // Create a BufferedImage from the stored RGB values
 BufferedImage image = new BufferedImage(500, 500, BufferedImage.TYPE_INT_RGB);
 WritableRaster raster = (WritableRaster) image.getData();
 raster.setPixels(0, 0, 500, 500, rgbVals);
 image.setData(raster);

 // Write the BufferedImage to a file as a JPEG
 File file = new File("/home/pi/Desktop/A Cool Image.jpg");
 ImageIO.write(image, "jpg", file);
 
 
```
    Parameters:
    
    width - An int specifying the width of the image to take (ideally a multiple of 16).
    
    height - An int specifying the height of the image to take (ideally a multiple of 16).
    
    keepPadding - A boolean indicating whether or not to preserve the padding on an image.
    
    Returns:
    
    An int array containing the image's RGB values.
    
    Throws:
    
    java.io.IOException
  - takeStillAsRGB
```
public int[] takeStillAsRGB(boolean keepPadding)
                     throws java.io.IOException
```
    Captures an image and returns the RGB values of that image. Images taken in this manner are not encoded, rather rather their RGB values are stored in an int array. Indexes 0 - 2 of the array make up the red, green, and blue values of the upper left pixel in the image. The pixels are added to the array from left to right, top to bottom.
    If an image's dimensions are not multiples of 16, then black padding will be added onto the right and bottom sides of an image until both the width and height are multiples of 16 (e.g. a 500x500 image would have a black band 12 pixels thick added to the right and bottom sides to achieve dimensions of 512x512, the closest multiple of 16 to 500).
    The boolean keepPadding parameter may be set to false to remove this padding. Note that this does require extra computations to be performed, so it has the potential to slightly reduce the fps a Pi is capable of. However, this has not yet been officially tested for. If the padding is kept, then it is the responsibility of the caller to determine what the dimensions of the resulting image will be, and adjust their processing as such (e.g. If the padding is kept on a 500x500 image, the array that is returned will contain 786,432 elements, as opposed to the 750,000 one would expect from a 500x500 image. This is because the image stored in the returned array is not 500x500, but 512x512 and the caller of this method must take that into account when processing the image).
    Usage Example:
```
 // Creating and setting up an RPiCamera
 RPiCamera piCamera = new RPiCamera()
     .turnOffPreview()
     .setTimeout(1);

 // Capture an image and store its RGB values, not preserving the border
 int[] rgbVals = piCamera.takeStillAsRGB(500, 500, false);

 // Create a BufferedImage from the stored RGB values
 BufferedImage image = new BufferedImage(500, 500, BufferedImage.TYPE_INT_RGB);
 WritableRaster raster = (WritableRaster) image.getData();
 raster.setPixels(0, 0, 500, 500, rgbVals);
 image.setData(raster);

 // Write the BufferedImage to a file as a JPEG
 File file = new File("/home/pi/Desktop/A Cool Image.jpg");
 ImageIO.write(image, "jpg", file);

 
```
    Parameters:
    
    keepPadding - A boolean indicating whether or not to preserve the padding on an image.
    
    Returns:
    
    An int array containing the image's RGB values.
    
    Throws:
    
    java.io.IOException
  - timelapse
```
public java.io.File timelapse(boolean wait,
                              java.lang.String pictureName,
                              int time)
                       throws java.io.IOException,
                              java.lang.InterruptedException
```
    Take a series of timelapsed photos for the specified time frame and save them under the specified filename to the RPiCamera's save directory. Length of time to timelapse for may be specified with the setTimeout(int) method.
    THIS METHOD WILL BLOCK THE THREAD UNTIL THE TIMELAPSE IS COMPLETE IF boolean wait ARGUMENT IS SET TO true.
    Most recent image in the series may be appended to the file specified in the setLinkLatestImage(boolean, String) method. If this property is set, timelapse() will return a File object representing the full path to the file the timelapsed photos are being linked to. Otherwise, will return null.
    When passing in a String for the photo's name, it is important to include "%04d" in the name. This is where the frame count number will be included in the file name. If the name does not contain these characters, the frame count will be appended to the beginning of each file name.
    Usage Example:
```
 
 // Create an RPiCamera instance using default constructor, which sets the 
 // save directory to "/home/pi/Pictures".
 RPiCamera piCamera = new RPiCamera()
     .setEncoding(Encoding.PNG) // Change encoding from JPEG to PNG
     .setTimeout(10000)         // Set period for timelapse to run at 10 seconds
     .setLinkLatestImage(true, "/home/pi/Pictures/linkfile.png"); // Set RPiCamera to link images to "linkFile.png"
 // Begin timelapse
 piCamera.timelapse(
 	true, // Block thread until timelapse is completed
 	"%04dTimelapsePics.png", // Save images under this name, with frame count added to beginning
 	1000 // Wait 1 second between capturing each image
 );
 
 
```
    Parameters:
    
    wait - A boolean indicating whether to block the thread until timelapse is complete or not.
    
    pictureName - A String containing name for each captured image.
    
    time - Period of time in milliseconds to wait between taking each image.
    
    Returns:
    
    If the link latest image property is set, the File images are being linked to, otherwise returns null.
    
    Throws:
    
    java.io.IOException
    
    java.lang.InterruptedException
  - stop
```
public void stop()
```
    Stops any raspistill processes being run by RPiCamera.
  - getPrevCommand
```
public java.lang.String getPrevCommand()
```
    Gets the raspistill command previously executed by the RPiCamera. If no commands have been executed, null will be returned.
    
    Returns:
    
    String containing command previously executed.
  - setSaveDir
```
public RPiCamera setSaveDir(java.lang.String saveDir)
```
    Sets the RPiCamera's save directory.
    
    Parameters:
    
    saveDir - String containing directory for RPiCamera to save images to.
  - setToDefaults
```
public RPiCamera setToDefaults()
```
    Sets all RPiCamera options to their default settings, overriding any previously set options.
  - turnOffPreview
```
public RPiCamera turnOffPreview()
```
    Turns off image preview.
  - turnOnPreview
```
public RPiCamera turnOnPreview()
```
    Turns on image preview. Note the preview will be superimposed over the top of any other windows/graphics.
  - setFullPreviewOn
```
public RPiCamera setFullPreviewOn()
```
    Runs the preview windows using the full resolution capture mode. Maximum frames per second in this mode is 15fps and the preview will have the same field of view as the capture. Captures should happen more quickly as no mode change should be required. This feature is currently under development.
  - setFullPreviewOff
```
public RPiCamera setFullPreviewOff()
```
    Turns off fullpreview mode.
  - turnOnPreview
```
public RPiCamera turnOnPreview(int x,
                               int y,
                               int w,
                               int h)
```
    Defines the size and location on the screen that the preview window will be placed. Note the preview will be superimposed over the top of any other windows/graphics.
    
    Parameters:
    
    x - int coordinate for upper right corner of preview window.
    
    y - int coordinate for upper right corner of preview window.
    
    w - An int specifying width of preview window.
    
    h - An int specifying height of preview window.
  - setPreviewFullscreen
```
public RPiCamera setPreviewFullscreen(boolean fullscreen)
```
    Turn fullscreen preview on or off.
    
    Parameters:
    
    fullscreen - turn on/off fullscreen.
  - setPreviewOpacity
```
public RPiCamera setPreviewOpacity(int opacity)
```
    Sets the preview window's opacity (0 to 255). Opacity values lower than 0 will set opacity to 0, values greater than 255 will set opacity to 255.
    
    Parameters:
    
    opacity - An integer specifying the opacity.
  - setSharpness
```
public RPiCamera setSharpness(int sharpness)
```
    Sets sharpness of image (-100 to 100), default value is 0. Sharpness values lower than -100 will set sharpness to -100, values greater than 100 will set sharpness to 100.
    
    Parameters:
    
    sharpness - An int specifying the sharpness.
  - setContrast
```
public RPiCamera setContrast(int contrast)
```
    Sets contrast of image (-100 to 100), default value is 0. Contrast values lower than -100 will set contrast to -100, values greater than 100 will set contrast to 100.
    
    Parameters:
    
    contrast - An int specifying the contrast.
  - setBrightness
```
public RPiCamera setBrightness(int brightness)
```
    Sets brightness of image (0 to 100), default value is 50. 0 is black, 100 is white. Brightness values lower than 0 will set brightness to 0, values greater than 100 will set brightness to 100.
    
    Parameters:
    
    brightness - An int specifying the brightness.
  - setSaturation
```
public RPiCamera setSaturation(int saturation)
```
    Sets colour saturation of image (-100 to 100), default is 0. Saturation values lower than -100 will set saturation to -100, values greater than 100 will set saturation to 100.
    
    Parameters:
    
    saturation - An int specifying the saturation.
  - setISO
```
public RPiCamera setISO(int iso)
```
    WARNING: OPERATION NOT YET SUPPORTED BY raspistill SOFTWARE. OPTION MAY STILL BE SET, BUT WILL HAVE NO EFFECT ON THE IMAGE UNTIL SUPPORT IS ADDED TO raspistill.
    
    Sets ISO of RPiCamera (100 to 800).
    
    Parameters:
    
    iso - An int specifying the ISO.
  - setExposure
```
public RPiCamera setExposure(Exposure exposure)
```
    Sets exposure mode of RPiCamera. Certain modes may not be supported by raspistill software, depending on camera tuning.
    
    Parameters:
    
    exposure - An Exposure enum specifying the desired mode.
  - setAWB
```
public RPiCamera setAWB(AWB awb)
```
    Sets Automatic White Balance (AWB) mode. Certain modes may not be supported by raspistill software, depending on camera type.
    
    Parameters:
    
    awb - An AWB enum specifying the desired AWB setting.
  - setImageEffect
```
public RPiCamera setImageEffect(ImageEffect imageEffect)
```
    Sets an effect to be applied to image. Certain settings may not be supported by raspistill software, depending on circumstances.
    
    Parameters:
    
    imageEffect - An ImageEffect enum specifying the desired effect.
  - setColourEffect
```
public RPiCamera setColourEffect(int U,
                                 int V)
```
    Sets colour effect of RPiCamera. The specified U and V parameters (0 to 255) are applied to the U and Y channels of the image. For example, setColourEffect(128, 128) should result in a monochrome image.
    
    Parameters:
    
    U -
    
    V -
  - setMeteringMode
```
public RPiCamera setMeteringMode(MeteringMode meteringMode)
```
    Sets metering mode used for preview and capture.
    
    Parameters:
    
    meteringMode - a MeteringMode enum specifying the desired mode.
  - setRotation
```
public RPiCamera setRotation(int rotation)
```
    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.
    
    Parameters:
    
    rotation -
  - setHorizontalFlipOn
```
public RPiCamera setHorizontalFlipOn()
```
    Flips the preview and saved image horizontally.
  - setHorizontalFlipOff
```
public RPiCamera setHorizontalFlipOff()
```
    Turns off horizontal flip.
  - setVerticalFlipOn
```
public RPiCamera setVerticalFlipOn()
```
    Flips the preview and saved image vertically.
  - setVerticalFlipOff
```
public RPiCamera setVerticalFlipOff()
```
    Turns off vertical flip.
  - setRegionOfInterest
```
public RPiCamera setRegionOfInterest(double x,
                                     double y,
                                     double w,
                                     double d)
```
    Allows the specification of the area of the sensor to be used as the source for the preview and capture. This is defined as x,y for the top left corner, and a width and height, all values in normalised coordinates (0.0-1.0). \
    So to set a ROI at half way across and down the sensor, and a width and height of a quarter of the sensor use: setRegionOfInterest(0.5, 0.5, 0.25, 0.25)
    
    Parameters:
    
    x -
    
    y -
    
    w -
    
    d -
  - setShutter
```
public RPiCamera setShutter(int speed)
```
    Set the shutter speed to the specified value (in microseconds). There is currently an upper limit of approximately 6000000us (6000ms, 6s). Shutter speed values passed in that are greater than 6000000 will be regarded as 6000000.
    
    Parameters:
    
    speed -
  - setDRC
```
public RPiCamera setDRC(DRC drc)
```
    Sets the Dynamic Range Compression of image. DRC changes the images by increasing the range of dark areas of the image, and decreasing the brighter areas. This can improve the image in low light areas.
    
    Parameters:
    
    drc - A DRC enum specifying the desired DRC level.
  - setWidth
```
public RPiCamera setWidth(int width)
```
    Sets width of images taken by RPiCamera. Note that this setting can be overriden by the takeStill(String, int, int) and takeBufferedStill(int, int) methods.
    
    Parameters:
    
    width - An int specifying the width.
  - setHeight
```
public RPiCamera setHeight(int height)
```
    Sets height of images taken by the RPiCamera. Note that this settings can be overriden by the takeStill(String, int, int) and takeBufferedStill(int, int) methods.
    
    Parameters:
    
    height - An int specifying the height.
  - setQuality
```
public RPiCamera setQuality(int quality)
```
    Sets quality of image (0 to 100), 75 is recommended for usual purposes. Quality values lower than 0 will set quality to 0, values greater than 100 will set quality to 100.
    
    Parameters:
    
    quality - An int specifying the quality.
  - setAddRawBayer
```
public RPiCamera setAddRawBayer(boolean add)
```
    Appends raw Bayer data from the RPiCamera to the image's JPEG metadata.
    
    Parameters:
    
    add - turn on/off bayer data.
  - setLinkLatestImage
```
public RPiCamera setLinkLatestImage(boolean link,
                                    java.lang.String fileName)
```
    Links latest image to the specified file. Intended for use with timelapse photography. Allows the latest image in a series of time lapse photos to be easily accessed while the lapse is still running at the specified file, while still saving all photos with their unique file names.
    
    Parameters:
    
    link - turn on/off linking.
    
    fileName - fully qualified path to file to link images to.
  - setTimeout
```
public RPiCamera setTimeout(int time)
```
    Sets the RPiCamera's timeout. RPiCamera runs for the specified number of milliseconds before taking the image. Default value is 5 seconds. If timeout value is 0, then RPiCamera will continue to run indefinitely (but can be stopped by calling stop() on the instance).
    
    Parameters:
    
    time - An int specifying the timeout in milliseconds.
  - setThumbnailParams
```
public RPiCamera setThumbnailParams(int x,
                                    int y,
                                    int quality)
```
    Allows specification of the thumbnail image inserted in to the image file. If not specified, defaults are a size of 64x48 at quality 35.
    
    Parameters:
    
    x -
    
    y -
    
    quality -
  - turnOffThumbnail
```
public RPiCamera turnOffThumbnail()
```
    Turns off image thumbnails. Reduces image's file size slightly.
  - setEncoding
```
public RPiCamera setEncoding(Encoding encoding)
```
    Sets the encoding for images. Default is JPG. Note that unaccelerated image types (gif, png, bmp) will take much longer to save than JPG which is hardware accelerated. Also note that the filename suffix is completely ignored when deciding the encoding of a file.
    
    Parameters:
    
    encoding - an Encoding enum specifying the desired image encoding.
  - selectCamera
```
public RPiCamera selectCamera(int camNumber)
```
    Selects which camera to use (on a multicamera system). 0 or 1. Default is 0. Values lower than 0 will select camera 0, values higher than 1 will select camera 1.
    
    Parameters:
    
    camNumber -
  - enableBurst
```
public RPiCamera enableBurst()
```
    Turns on burst mode for RPiCamera. Prevents raspistill from switching between preview and capture modes, saving a few 100ms of time for each capture.
  - disableBurst
```
public RPiCamera disableBurst()
```
    Turns off burst mode for RPiCamera.
  - setDateTimeOn
```
public RPiCamera setDateTimeOn()
```
    Replaces output pattern (%d) in save file name with DateTime (MonthDayHourMinSec). E.g.
```
 RPiCamera camera = new RPiCamera()
    .setDateTimeOn();
 camera.takeStill("APicture%d.jpg", 500, 500);
```
    Would produce a file named "APicture1223140756" if executed on Dec 23rd, at 14:07:56.
  - setDateTimeOff
```
public RPiCamera setDateTimeOff()
```
    Disables effects of setDateTimeOn(). This is default state of RPiCamera.
  - setTimestampOn
```
public RPiCamera setTimestampOn()
```
    Replace output pattern (%d) with unix timestamp (seconds since 1970) E.g.
```
 RPiCamera camera = new RPiCamera()
     .setTimestampOn();
 camera.takeStill("APicture%d.jpg", 500, 500);
```
    Would produce a file named "APictureXXX", where XXX is the number of seconds since 1970.
  - setTimestampOff
```
public RPiCamera setTimestampOff()
```
    Disables effects of setTimestampOn(). This is default state of RPiCamera.

Class RPiCamera

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RPiCamera

RPiCamera

Method Detail

takeStill

takeStill

takeBufferedStill

takeBufferedStill

takeStillAsRGB

takeStillAsRGB

timelapse

stop

getPrevCommand

setSaveDir

setToDefaults

turnOffPreview

turnOnPreview

setFullPreviewOn

setFullPreviewOff

turnOnPreview

setPreviewFullscreen

setPreviewOpacity

setSharpness

setContrast

setBrightness

setSaturation

setISO

setExposure

setAWB

setImageEffect

setColourEffect

setMeteringMode

setRotation

setHorizontalFlipOn

setHorizontalFlipOff

setVerticalFlipOn

setVerticalFlipOff

setRegionOfInterest

setShutter

setDRC

setWidth

setHeight

setQuality

setAddRawBayer

setLinkLatestImage

setTimeout

setThumbnailParams

turnOffThumbnail

setEncoding

selectCamera

enableBurst

disableBurst

setDateTimeOn

setDateTimeOff

setTimestampOn

setTimestampOff