Bartosz Firyn (SarXos)

com.github.sarxos.webcam
Interface WebcamDevice

All Known Implementing Classes:
WebcamDefaultDevice

public interface WebcamDevice

Webcam device abstraction.

Author:
Bartosz Firyn (SarXos)

Nested Class Summary
static interface WebcamDevice.BufferAccess
          This interface should be implemented by all webcam devices supporting possibility to access raw bytes or direct bytes buffer from native webcam device.
 
Method Summary
 void close()
          Close device, however it can be open again.
 void dispose()
          Dispose device.
 BufferedImage getImage()
          Fetch image from underlying camera.
 String getName()
          Get device name.
 Dimension getResolution()
          Get currently set image size.
 Dimension[] getResolutions()
          Get the list of all possible image resolutions.
 boolean isOpen()
          Is webcam device open?
 void open()
          Open device, it can be closed any time.
 void setResolution(Dimension size)
          Set new expected image size.
 

Method Detail

getName

String getName()
Get device name.

Returns:
Device name

getResolutions

Dimension[] getResolutions()
Get the list of all possible image resolutions.

Returns:
Possible resolutions

getResolution

Dimension getResolution()
Get currently set image size.

Returns:
The size which is currently set

setResolution

void setResolution(Dimension size)
Set new expected image size.

Parameters:
size - the size to be set

getImage

BufferedImage getImage()
Fetch image from underlying camera.

Returns:
Image

open

void open()
Open device, it can be closed any time.


close

void close()
Close device, however it can be open again.


dispose

void dispose()
Dispose device. After device is disposed it cannot be open again.


isOpen

boolean isOpen()
Is webcam device open?

Returns:
True if webcam device is open, false otherwise

Bartosz Firyn (SarXos)

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