com.smaxe.uv.na.webcam

Interface IWebcam

All Known Implementing Classes:

ScreenWebcam

public interface IWebcam

IWebcam - webcam interface.

Author:

Andrei Sochirca

See Also:

JUV Webcam SDK

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IWebcam.FrameFormat FrameFormat - frame format.
static interface	IWebcam.IListener IListener - webcam listener.

Method Summary

Methods

Modifier and Type	Method and Description
VideoFrame	capture() Captures single frame.
void	close() Closes webcam.
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.

Method Detail

getId

java.lang.String getId()

Returns device id.

Returns:

device id

getName

java.lang.String getName()

Returns device name.

Returns:

device name

getFormats

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

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

Parameters:

args -

Returns:

supported formats

isOpen

boolean isOpen()

Checks if webcam is open in the current application.

Returns:

true if open; false if closed

open

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

Opens webcam using format.

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

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

boolean setFrameFormat(IWebcam.FrameFormat format)

Sets capture frame format.

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

Parameters:

format - new frame format for webcam capture

Returns:

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

setFrameRate

void setFrameRate(float frameRate)

Sets capture frame rate (in frames per second).

Parameters:

frameRate - frame rate (in frames per second)

startCapture

void startCapture()

Starts capture.

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

stopCapture

void stopCapture()

Stops capture.

capture

VideoFrame capture()

Captures single frame.

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

Returns:

captured frame

close

void close()

Closes webcam.