com.github.sarxos.webcam
Class Webcam

java.lang.Object
  com.github.sarxos.webcam.Webcam

public class Webcam
extends Object

Webcam class.

Author:

Bartosz Firyn (bfiryn)

Constructor Summary

Webcam(WebcamDevice device)
Webcam class.

Method Summary

void	addWebcamListener(WebcamListener l) Add webcam listener.
void	close() Close webcam.
static Webcam	getDefault()
static WebcamDriver	getDriver()
BufferedImage	getImage() Capture image from webcam.
String	getName() Get webcam name (device name).
Dimension	getViewSize()
Dimension[]	getViewSizes() Return list of supported view sizes.
WebcamListener[]	getWebcamListeners()
static List<Webcam>	getWebcams() Get list of webcams to use.
boolean	isOpen() Is webcam open?
void	open() Open webcam.
static void	registerDriver(Class<? extends WebcamDriver> clazz) Register new webcam video driver.
static void	registerDriver(String clazzName) Register new webcam video driver.
static void	setDriver(Class<? extends WebcamDriver> driverClass) Set new video driver class to be used by webcam.
static void	setDriver(WebcamDriver driver) Set new video driver to be used by webcam.
void	setViewSize(Dimension size)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Webcam

public Webcam(WebcamDevice device)

Webcam class.

Parameters:

device - - device to be used as webcam

Method Detail

open

public void open()

Open webcam.

close

public void close()

Close webcam.

isOpen

public boolean isOpen()

Is webcam open?

Returns:

true if open, false otherwise

getViewSize

public Dimension getViewSize()

Returns:

Webcam view size (picture size) in pixels.

getViewSizes

public Dimension[] getViewSizes()

Return list of supported view sizes. It can differ between vary webcam data sources.

Returns:

setViewSize

public void setViewSize(Dimension size)

getImage

public BufferedImage getImage()

Capture image from webcam.

Returns:

Captured image

getWebcams

public static List<Webcam> getWebcams()

Get list of webcams to use.

Returns:

List of webcams

getDefault

public static Webcam getDefault()

Returns:

Default webcam (first from the list)

getName

public String getName()

Get webcam name (device name). The name of device depends on the value returned by the underlying data source, so in some cases it can be human-readable value and sometimes it can be some strange number.

Returns:

Name

toString

public String toString()

Overrides:

toString in class Object

addWebcamListener

public void addWebcamListener(WebcamListener l)

Add webcam listener.

Parameters:

l - a listener to add

getWebcamListeners

public WebcamListener[] getWebcamListeners()

Returns:

All webcam listeners

getDriver

public static WebcamDriver getDriver()

Returns:

Data source currently used by webcam

setDriver

public static void setDriver(WebcamDriver driver)

Set new video driver to be used by webcam.

Parameters:

driver - new video driver to use (e.g. Civil, JFM, FMJ, QTJ, etc)

setDriver

public static void setDriver(Class<? extends WebcamDriver> driverClass)

Set new video driver class to be used by webcam. Class given in the argument shall extend WebcamDriver interface and should have public default constructor, so instance can be created by reflection.

Parameters:

driver - new video driver class to use

registerDriver

public static void registerDriver(Class<? extends WebcamDriver> clazz)

Register new webcam video driver.

Parameters:

clazz - webcam video driver class

registerDriver

public static void registerDriver(String clazzName)

Register new webcam video driver.

Parameters:

clazzName - webcam video driver class name