js.dev.cam.web
Class JWebCam

java.lang.Object
  extended by js.dev.cam.web.JWebCam
All Implemented Interfaces:
JCam

public class JWebCam
extends java.lang.Object
implements JCam

The JWebCam class defines all the available methods for controling web cameras.

Author:
soldan

Constructor Summary
JWebCam()
          Constructor.
 
Method Summary
 CloseResults close(CloseParams cp)
          The close method is used to close web camera.
 ExposureStartTimeResults getExposureStartTime()
          The getExposureStartTime method returns the exposure start time in the Calendar object.
 InitResults init(InitParams ip)
          The init public method initialize the device.
 boolean isDeviceOpenStatus()
           
 OpenResults open(OpenParams op)
          The open method is used to open requested web camera.
 void setDeviceOpenStatus(boolean deviceOpenStatus)
           
 VideoDisableResults videoDisable(VideoDisableParams vdp)
          The videoDisable method disables capturing of video data.
 VideoEnableResults videoEnable(VideoEnableParams vep)
          The videoEnable method enables capturing of video data.
 VideoGetControlsResults videoGetControls(VideoGetControlsParams vgcp)
          The getControls method returns the set of available controls.
 VideoGrabResults videoGrab(VideoGrabParams vgp)
          The videoGrab method grabs video data.
 VideoSetBrightnessResults videoSetBrightness(VideoSetBrightnessParams vsbp)
          The videoSetBrightness method sets the video brightness.
 VideoSetContrastResults videoSetContrast(VideoSetContrastParams vscp)
          The videoSetContrast method sets the video contrast.
 VideoSetGainResults videoSetGain(VideoSetGainParams vsgp)
          The videoSetGain method sets the video gain.
 VideoSetSaturationResults videoSetSaturation(VideoSetSaturationParams vssp)
          The videoSetSaturation method sets the video saturation.
 VideoTryFormatResults videoTryFormat(VideoTryFormatParams vtfp)
          The videoTryFormat tries if the requested video format is available.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JWebCam

public JWebCam()
Constructor.

Method Detail

open

public final OpenResults open(OpenParams op)
The open method is used to open requested web camera.

Specified by:
open in interface JCam
Parameters:
op - OpenParams object
Returns:
or OpenResults object

close

public final CloseResults close(CloseParams cp)
The close method is used to close web camera.

Specified by:
close in interface JCam
Parameters:
cp - CloseParams object
Returns:
cr CloseResults object

init

public final InitResults init(InitParams ip)
The init public method initialize the device.

Specified by:
init in interface JCam
Parameters:
ip - InitParams object.
Returns:
InitResults object.

videoTryFormat

public final VideoTryFormatResults videoTryFormat(VideoTryFormatParams vtfp)
The videoTryFormat tries if the requested video format is available. If not, the closest one video format is returned.


videoEnable

public final VideoEnableResults videoEnable(VideoEnableParams vep)
The videoEnable method enables capturing of video data.


videoDisable

public final VideoDisableResults videoDisable(VideoDisableParams vdp)
The videoDisable method disables capturing of video data.


videoGrab

public final VideoGrabResults videoGrab(VideoGrabParams vgp)
The videoGrab method grabs video data.


videoGetControls

public final VideoGetControlsResults videoGetControls(VideoGetControlsParams vgcp)
The getControls method returns the set of available controls.


videoSetBrightness

public final VideoSetBrightnessResults videoSetBrightness(VideoSetBrightnessParams vsbp)
The videoSetBrightness method sets the video brightness.


videoSetContrast

public final VideoSetContrastResults videoSetContrast(VideoSetContrastParams vscp)
The videoSetContrast method sets the video contrast.


videoSetSaturation

public final VideoSetSaturationResults videoSetSaturation(VideoSetSaturationParams vssp)
The videoSetSaturation method sets the video saturation.


videoSetGain

public final VideoSetGainResults videoSetGain(VideoSetGainParams vsgp)
The videoSetGain method sets the video gain.


getExposureStartTime

public final ExposureStartTimeResults getExposureStartTime()
The getExposureStartTime method returns the exposure start time in the Calendar object.

Specified by:
getExposureStartTime in interface JCam
Returns:
exposureStartTime ExposureStartTimeResults

isDeviceOpenStatus

public final boolean isDeviceOpenStatus()
Returns:
the deviceOpenStatus

setDeviceOpenStatus

public final void setDeviceOpenStatus(boolean deviceOpenStatus)
Parameters:
deviceOpenStatus - the deviceOpenStatus to set.