com.github.sarxos.webcam
Class Webcam

java.lang.Object
  extended by 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 WebcamDataSource getDataSource()
           
static Webcam getDefault()
           
 BufferedImage getImage()
          Capture image from webcam.
 String getName()
          Get webcam name (actually device name).
 Dimension getViewSize()
           
 Dimension[] getViewSizes()
           
 WebcamListener[] getWebcamListeners()
           
static List<Webcam> getWebcams()
          Get list of webcams to use.
 boolean isOpen()
          Is webcam open?
 void open()
          Open webcam.
static void setDataSource(WebcamDataSource ds)
          Set new data source 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()

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 (actually device name).

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

getDataSource

public static WebcamDataSource getDataSource()
Returns:
Data source currently used by webcam

setDataSource

public static void setDataSource(WebcamDataSource ds)
Set new data source to be used by webcam.

Parameters:
ds - new data source to use (e.g. Civil, JFM, FMJ, QTJ, etc)


Copyright © 2012 Bartosz Firyn (SarXos). All Rights Reserved.