AxisCamera

java.lang.Object
- edu.wpi.first.wpilibj.vision.AxisCamera

public class AxisCamera
extends java.lang.Object

Axis M1011 network camera

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AxisCamera.ExposureControl`
`static class`	`AxisCamera.Resolution`
`static class`	`AxisCamera.Rotation`
`static class`	`AxisCamera.WhiteBalance`

Constructor Summary

Constructors
Constructor and Description

AxisCamera(java.lang.String cameraHost)
AxisCamera constructor

Constructors
Constructor and Description
`AxisCamera(java.lang.String cameraHost)` AxisCamera constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBrightness()`
`int`	`getColorLevel()`
`int`	`getCompression()`
`AxisCamera.ExposureControl`	`getExposureControl()`
`int`	`getExposurePriority()`
`HSLImage`	`getImage()` Instantiate a new image object and fill it with the latest image from the camera.
`boolean`	`getImage(ColorImage image)` Get an image from the camera and store it in the provided image.
`boolean`	`getImage(NIVision.Image image)` Get an image from the camera and store it in the provided image.
`int`	`getMaxFPS()`
`AxisCamera.Resolution`	`getResolution()`
`AxisCamera.Rotation`	`getRotation()`
`AxisCamera.WhiteBalance`	`getWhiteBalance()`
`boolean`	`isFreshImage()` Return true if the latest image from the camera has not been retrieved by calling GetImage() yet.
`java.lang.String`	`toString()`
`void`	`writeBrightness(int brightness)` Request a change in the brightness of the camera images.
`void`	`writeColorLevel(int colorLevel)` Request a change in the color level of the camera images.
`void`	`writeCompression(int compression)` Write the compression value to the camera.
`void`	`writeExposureControl(AxisCamera.ExposureControl exposureControl)` Request a change in the camera's exposure mode.
`void`	`writeExposurePriority(int exposurePriority)` Request a change in the exposure priority of the camera.
`void`	`writeMaxFPS(int maxFPS)` Write the maximum frames per second that the camera should send Write 0 to send as many as possible.
`void`	`writeResolution(AxisCamera.Resolution resolution)` Write resolution value to camera.
`void`	`writeRotation(AxisCamera.Rotation rotation)` Write the rotation value to the camera.
`void`	`writeWhiteBalance(AxisCamera.WhiteBalance whiteBalance)` Request a change in the white balance on the camera.

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

- Constructor Detail
  - AxisCamera
```
public AxisCamera(java.lang.String cameraHost)
```
    AxisCamera constructor
    
    Parameters:
    
    cameraHost - The host to find the camera at, typically an IP address
- Method Detail
  - isFreshImage
```
public boolean isFreshImage()
```
    Return true if the latest image from the camera has not been retrieved by calling GetImage() yet.
    
    Returns:
    
    true if the image has not been retrieved yet.
  - getImage
```
public boolean getImage(NIVision.Image image)
```
    Get an image from the camera and store it in the provided image.
    
    Parameters:
    
    image - The imaq image to store the result in. This must be an HSL or RGB image.
    
    Returns:
    
    true upon success, false on a failure
  - getImage
```
public boolean getImage(ColorImage image)
```
    Get an image from the camera and store it in the provided image.
    
    Parameters:
    
    image - The image to store the result in. This must be an HSL or RGB image
    
    Returns:
    
    true upon success, false on a failure
  - getImage
```
public HSLImage getImage()
                  throws NIVisionException
```
    Instantiate a new image object and fill it with the latest image from the camera.
    
    Returns:
    
    a pointer to an HSLImage object
    
    Throws:
    
    NIVisionException
  - writeBrightness
```
public void writeBrightness(int brightness)
```
    Request a change in the brightness of the camera images.
    
    Parameters:
    
    brightness - valid values 0 .. 100
  - getBrightness
```
public int getBrightness()
```
    Returns:
    
    The configured brightness of the camera images
  - writeWhiteBalance
```
public void writeWhiteBalance(AxisCamera.WhiteBalance whiteBalance)
```
    Request a change in the white balance on the camera.
    
    Parameters:
    
    whiteBalance - Valid values from the WhiteBalance enum.
  - getWhiteBalance
```
public AxisCamera.WhiteBalance getWhiteBalance()
```
    Returns:
    
    The configured white balances of the camera images
  - writeColorLevel
```
public void writeColorLevel(int colorLevel)
```
    Request a change in the color level of the camera images.
    
    Parameters:
    
    colorLevel - valid values are 0 .. 100
  - getColorLevel
```
public int getColorLevel()
```
    Returns:
    
    The configured color level of the camera images
  - writeExposureControl
```
public void writeExposureControl(AxisCamera.ExposureControl exposureControl)
```
    Request a change in the camera's exposure mode.
    
    Parameters:
    
    exposureControl - A mode to write in the Exposure enum.
  - getExposureControl
```
public AxisCamera.ExposureControl getExposureControl()
```
    Returns:
    
    The configured exposure control mode of the camera
  - writeExposurePriority
```
public void writeExposurePriority(int exposurePriority)
```
    Request a change in the exposure priority of the camera.
    
    Parameters:
    
    exposurePriority - Valid values are 0, 50, 100. 0 = Prioritize image quality 50 = None 100 = Prioritize frame rate
  - getExposurePriority
```
public int getExposurePriority()
```
    Returns:
    
    The configured exposure priority of the camera
  - writeMaxFPS
```
public void writeMaxFPS(int maxFPS)
```
    Write the maximum frames per second that the camera should send Write 0 to send as many as possible.
    
    Parameters:
    
    maxFPS - The number of frames the camera should send in a second, exposure permitting.
  - getMaxFPS
```
public int getMaxFPS()
```
    Returns:
    
    The configured maximum FPS of the camera
  - writeResolution
```
public void writeResolution(AxisCamera.Resolution resolution)
```
    Write resolution value to camera.
    
    Parameters:
    
    resolution - The camera resolution value to write to the camera.
  - getResolution
```
public AxisCamera.Resolution getResolution()
```
    Returns:
    
    The configured resolution of the camera (not necessarily the same resolution as the most recent image, if it was changed recently.)
  - writeCompression
```
public void writeCompression(int compression)
```
    Write the compression value to the camera.
    
    Parameters:
    
    compression - Values between 0 and 100.
  - getCompression
```
public int getCompression()
```
    Returns:
    
    The configured compression level of the camera images
  - writeRotation
```
public void writeRotation(AxisCamera.Rotation rotation)
```
    Write the rotation value to the camera. If you mount your camera upside down, use this to adjust the image for you.
    
    Parameters:
    
    rotation - A value from the AxisCamera.Rotation enum
  - getRotation
```
public AxisCamera.Rotation getRotation()
```
    Returns:
    
    The configured rotation mode of the camera
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AxisCamera

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AxisCamera

Method Detail

isFreshImage

getImage

getImage

getImage

writeBrightness

getBrightness

writeWhiteBalance

getWhiteBalance

writeColorLevel

getColorLevel

writeExposureControl

getExposureControl

writeExposurePriority

getExposurePriority

writeMaxFPS

getMaxFPS

writeResolution

getResolution

writeCompression

getCompression

writeRotation

getRotation

toString