com.esf.device.camera.service

Interface ICamera

public interface ICamera

Interface for accessing webcams in ESF. Currently only Axis cameras are supported and streaming is not supported today. Copyright (c) 2011 Eurotech Inc. All rights reserved.

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getCurrentImage(java.lang.String tmpFileName) Gets the current image snapshot from the camera
java.io.File	getCurrentImage(java.lang.String tmpFileName, boolean showDate, boolean showText, java.lang.String text) Gets the current image snapshot from the camera and overlays data onto the image based on the input parameters.
java.lang.String	getIpAddress() Gets the IP address of the connected camera as a String
java.lang.String	getModel() Gets the model number of the connected camera as a String
void	setDateTime(java.util.Calendar calendar) Sets the date of the Camera so the the images get stamped with the proper date and time if the showDate option is set to true in the getCurrentImage() method.

Method Detail

getModel

java.lang.String getModel()

Gets the model number of the connected camera as a String

Returns:

The model number of the connected camera

getIpAddress

java.lang.String getIpAddress()

Gets the IP address of the connected camera as a String

Returns:

The IP Address of the connected camera

getCurrentImage

java.io.File getCurrentImage(java.lang.String tmpFileName)
                             throws java.lang.Exception

Gets the current image snapshot from the camera

Parameters:

tmpFileName - The temporary name of the file to store the camera snapshot in

Returns:

The @File that is the camera snapshot after it is captured

Throws:

java.lang.Exception - If the snapshot can not be acquired

getCurrentImage

java.io.File getCurrentImage(java.lang.String tmpFileName,
                           boolean showDate,
                           boolean showText,
                           java.lang.String text)
                             throws java.lang.Exception

Gets the current image snapshot from the camera and overlays data onto the image based on the input parameters.

Parameters:

tmpFileName - The temporary name of the file to store the camera snapshot in

showDate - Specifies whether or not the date should be overlayed on the snapshot

showText - Specifies whether or not some text should be overlayed on the snapshot

text - If showText is set to true, this is the text that will be overlayed on the snapshot

Returns:

The @File representing the camera snapshot

Throws:

java.lang.Exception - If the snapshot can not be acquired

setDateTime

void setDateTime(java.util.Calendar calendar)
                 throws java.lang.Exception

Sets the date of the Camera so the the images get stamped with the proper date and time if the showDate option is set to true in the getCurrentImage() method.

Parameters:

calendar - The @Calendar to use to set the date of the camera

Throws:

java.lang.Exception - If the date can not be set