com.smaxe.uv.na.webcam

Class ScreenWebcam

java.lang.Object

com.smaxe.uv.na.webcam.ScreenWebcam

All Implemented Interfaces:

IWebcam

public final class ScreenWebcam
extends java.lang.Object
implements IWebcam

ScreenWebcam - IWebcam implementation based on screen capture.

Author:

Andrei Sochirca

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScreenWebcam.ScreenFrameFormat ScreenFrameFormat

Nested classes/interfaces inherited from interface com.smaxe.uv.na.webcam.IWebcam

IWebcam.FrameFormat, IWebcam.IListener

Constructor Summary

Constructors

Constructor and Description
ScreenWebcam(java.lang.String name, java.awt.GraphicsDevice device) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
VideoFrame	capture() Captures single frame.
void	close() Closes webcam.
static java.awt.Rectangle	createRectangleByFormat(IWebcam.FrameFormat format) Creates Rectangle equivalent to the format.
IWebcam.FrameFormat[]	getFormats(java.lang.Object... args) Returns supported formats.
java.lang.String	getId() Returns device id.
java.lang.String	getName() Returns device name.
boolean	isOpen() Checks if webcam is open in the current application.
void	open(IWebcam.FrameFormat format, IWebcam.IListener listener) Opens webcam using format.
boolean	setFrameFormat(IWebcam.FrameFormat format) Sets capture frame format.
void	setFrameRate(float frameRate) Sets capture frame rate (in frames per second).
void	startCapture() Starts capture.
void	stopCapture() Stops capture.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScreenWebcam

public ScreenWebcam(java.lang.String name,
            java.awt.GraphicsDevice device)
             throws java.lang.Exception

Constructor.

Parameters:

name -

device -

Throws:

java.lang.Exception

Method Detail

createRectangleByFormat

public static java.awt.Rectangle createRectangleByFormat(IWebcam.FrameFormat format)

Creates Rectangle equivalent to the format.

Parameters:

format - frame format

Returns:

region rectangle, null if format is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getId

public java.lang.String getId()

Description copied from interface: IWebcam

Returns device id.

Specified by:

getId in interface IWebcam

Returns:

device id

getName

public java.lang.String getName()

Description copied from interface: IWebcam

Returns device name.

Specified by:

getName in interface IWebcam

Returns:

device name

getFormats

public IWebcam.FrameFormat[] getFormats(java.lang.Object... args)

Description copied from interface: IWebcam

Returns supported formats.

Note:
- method returns valid formats only after successful IWebcam#open() invocation
- returned null means that supported formats enumeration functionality is not supported

Specified by:

getFormats in interface IWebcam

Returns:

supported formats

isOpen

public boolean isOpen()

Description copied from interface: IWebcam

Checks if webcam is open in the current application.

Specified by:

isOpen in interface IWebcam

Returns:

true if open; false if closed

open

public void open(IWebcam.FrameFormat format,
        IWebcam.IListener listener)
          throws java.lang.Exception

Description copied from interface: IWebcam

Opens webcam using format.

Note:
- The method opens webcam asynchronously. IWebcam.isOpen() method returns true after webcam is opened successfully

Specified by:

open in interface IWebcam

Parameters:

format - initial frame format to use, if null then default webcam frame format is used

listener - webcam listener

Throws:

java.lang.Exception - if failed to initialize webcam device

setFrameFormat

public boolean setFrameFormat(IWebcam.FrameFormat format)

Description copied from interface: IWebcam

Sets capture frame format.

Note:
- This method should be called after the webcam is opened.

Specified by:

setFrameFormat in interface IWebcam

Parameters:

format - new frame format for webcam capture

Returns:

true if format was set successfully; false if failed to set format

setFrameRate

public void setFrameRate(float frameRate)

Description copied from interface: IWebcam

Sets capture frame rate (in frames per second).

Specified by:

setFrameRate in interface IWebcam

Parameters:

frameRate - frame rate (in frames per second)

startCapture

public void startCapture()

Description copied from interface: IWebcam

Starts capture.

Note:
- This method should be called after the webcam is opened.

Specified by:

startCapture in interface IWebcam

stopCapture

public void stopCapture()

Description copied from interface: IWebcam

Stops capture.

Specified by:

stopCapture in interface IWebcam

capture

public VideoFrame capture()

Description copied from interface: IWebcam

Captures single frame.

Note:
- This method should be called after the webcam is opened.

Specified by:

capture in interface IWebcam

Returns:

captured frame

close

public void close()

Description copied from interface: IWebcam

Closes webcam.

Specified by:

close in interface IWebcam