com.github.sarxos.webcam.ds.buildin

Class WebcamDefaultDevice

java.lang.Object

com.github.sarxos.webcam.ds.buildin.WebcamDefaultDevice

All Implemented Interfaces:

WebcamDevice, WebcamDevice.BufferAccess, WebcamDevice.FPSSource, java.lang.Runnable

public class WebcamDefaultDevice
extends java.lang.Object
implements WebcamDevice, WebcamDevice.BufferAccess, java.lang.Runnable, WebcamDevice.FPSSource

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.sarxos.webcam.WebcamDevice

WebcamDevice.BufferAccess, WebcamDevice.Configurable, WebcamDevice.FPSSource

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebcamDefaultDevice(Device device)

Method Summary

Modifier and Type	Method and Description
void	close() Close device, however it can be open again.
void	dispose() Dispose device.
java.lang.String	getDeviceId()
java.lang.String	getDeviceName()
Device	getDeviceRef()
double	getFPS() Get current device FPS.
java.awt.image.BufferedImage	getImage() Fetch image from underlying camera.
java.nio.ByteBuffer	getImageBytes() Read the underlying image memory buffer.
void	getImageBytes(java.nio.ByteBuffer target) Copy the underlying image memory into the target buffer passed as the argument.The remaining capacity of the target buffer needs to be at least image width * height * 3 bytes.
java.lang.String	getName() Get device name.
java.awt.Dimension	getResolution() Get currently set image size.
java.awt.Dimension[]	getResolutions() Get the list of all possible image resolutions.
int	getTimeout() Get timeout for image acquisition.
boolean	isOpen() Is webcam device open?
void	open() Open device, it can be closed any time.
void	run()
void	setFailOnSizeMismatch(boolean fail) Determines if device should fail when requested image size is different than actually received.
void	setResolution(java.awt.Dimension size) Set new expected image size.
void	setTimeout(int timeout) Set timeout for image acquisition.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebcamDefaultDevice

protected WebcamDefaultDevice(Device device)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: WebcamDevice

Get device name.

Specified by:

getName in interface WebcamDevice

Returns:

Device name

getDeviceName

public java.lang.String getDeviceName()

getDeviceId

public java.lang.String getDeviceId()

getDeviceRef

public Device getDeviceRef()

getResolutions

public java.awt.Dimension[] getResolutions()

Description copied from interface: WebcamDevice

Get the list of all possible image resolutions.

Specified by:

getResolutions in interface WebcamDevice

Returns:

Possible resolutions

getResolution

public java.awt.Dimension getResolution()

Description copied from interface: WebcamDevice

Get currently set image size.

Specified by:

getResolution in interface WebcamDevice

Returns:

The size which is currently set

setResolution

public void setResolution(java.awt.Dimension size)

Description copied from interface: WebcamDevice

Set new expected image size.

Specified by:

setResolution in interface WebcamDevice

Parameters:

size - the size to be set

getImageBytes

public java.nio.ByteBuffer getImageBytes()

Description copied from interface: WebcamDevice.BufferAccess

Read the underlying image memory buffer. This method will return new reference to pre-allocated off-heap memory where image bytes are stored. The size of this buffer is image width * height * 3 bytes.

NOTE! Do not use this buffer to set bytes value. It should be used only for read purpose!

Specified by:

getImageBytes in interface WebcamDevice.BufferAccess

Returns:

Bytes buffer

getImageBytes

public void getImageBytes(java.nio.ByteBuffer target)

Description copied from interface: WebcamDevice.BufferAccess

Copy the underlying image memory into the target buffer passed as the argument.The remaining capacity of the target buffer needs to be at least image width * height * 3 bytes.

Specified by:

getImageBytes in interface WebcamDevice.BufferAccess

Parameters:

target - the buffer to which image data should be copied

getImage

public java.awt.image.BufferedImage getImage()

Description copied from interface: WebcamDevice

Fetch image from underlying camera.

Specified by:

getImage in interface WebcamDevice

Returns:

Image

open

public void open()

Description copied from interface: WebcamDevice

Open device, it can be closed any time.

Specified by:

open in interface WebcamDevice

close

public void close()

Description copied from interface: WebcamDevice

Close device, however it can be open again.

Specified by:

close in interface WebcamDevice

dispose

public void dispose()

Description copied from interface: WebcamDevice

Dispose device. After device is disposed it cannot be open again.

Specified by:

dispose in interface WebcamDevice

setFailOnSizeMismatch

public void setFailOnSizeMismatch(boolean fail)

Determines if device should fail when requested image size is different than actually received.

Parameters:

fail - the fail on size mismatch flag, true or false

isOpen

public boolean isOpen()

Description copied from interface: WebcamDevice

Is webcam device open?

Specified by:

isOpen in interface WebcamDevice

Returns:

True if webcam device is open, false otherwise

getTimeout

public int getTimeout()

Get timeout for image acquisition.

Returns:

Value in milliseconds

setTimeout

public void setTimeout(int timeout)

Set timeout for image acquisition.

Parameters:

timeout - the timeout value in milliseconds

run

public void run()

Specified by:

run in interface java.lang.Runnable

getFPS

public double getFPS()

Description copied from interface: WebcamDevice.FPSSource

Get current device FPS.

Specified by:

getFPS in interface WebcamDevice.FPSSource

Returns:

FPS