com.github.sarxos.webcam.ds.ipcam

Class IpCamDevice

java.lang.Object

com.github.sarxos.webcam.ds.ipcam.IpCamDevice

All Implemented Interfaces:

WebcamDevice, WebcamDevice.BufferAccess, WebcamDevice.FPSSource

Direct Known Subclasses:

B7210, DSC933L, F3201, IPRobocam641, X104S

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

IP camera device.

Author:

Bartosz Firyn (sarxos)

Nested Class Summary

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

WebcamDevice.BufferAccess, WebcamDevice.Configurable, WebcamDevice.FPSSource

Constructor Summary

Constructors

Constructor and Description
IpCamDevice(java.lang.String name, java.lang.String url, IpCamMode mode)
IpCamDevice(java.lang.String name, java.lang.String url, IpCamMode mode, IpCamAuth auth)
IpCamDevice(java.lang.String name, java.net.URL url, IpCamMode mode)
IpCamDevice(java.lang.String name, java.net.URL url, IpCamMode mode, IpCamAuth auth)

Method Summary

Modifier and Type	Method and Description
void	close()
void	dispose()
IpCamAuth	getAuth()
org.apache.http.client.HttpClient	getClient()
double	getFPS()
java.awt.image.BufferedImage	getImage()
java.nio.ByteBuffer	getImageBytes() Return image RGB data in form of ByteBuffer.
void	getImageBytes(java.nio.ByteBuffer buffer) Put image RGB data into the ByteBuffer.
IpCamMode	getMode()
java.lang.String	getName()
java.awt.Dimension	getResolution()
java.awt.Dimension[]	getResolutions()
java.net.URL	getURL()
boolean	isOnline() This method will send HTTP HEAD request to the camera URL to check whether it's online or offline.
boolean	isOpen()
void	open()
void	setResolution(java.awt.Dimension size)
protected void	setSizes(java.awt.Dimension[] sizes)
protected static java.net.URL	toURL(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

IpCamDevice

public IpCamDevice(java.lang.String name,
                   java.lang.String url,
                   IpCamMode mode)
            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

IpCamDevice

public IpCamDevice(java.lang.String name,
                   java.net.URL url,
                   IpCamMode mode)

IpCamDevice

public IpCamDevice(java.lang.String name,
                   java.lang.String url,
                   IpCamMode mode,
                   IpCamAuth auth)
            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

IpCamDevice

public IpCamDevice(java.lang.String name,
                   java.net.URL url,
                   IpCamMode mode,
                   IpCamAuth auth)

Method Detail

toURL

protected static final java.net.URL toURL(java.lang.String url)

getClient

public org.apache.http.client.HttpClient getClient()

getName

public java.lang.String getName()

Specified by:

getName in interface WebcamDevice

getResolutions

public java.awt.Dimension[] getResolutions()

Specified by:

getResolutions in interface WebcamDevice

setSizes

protected void setSizes(java.awt.Dimension[] sizes)

getResolution

public java.awt.Dimension getResolution()

Specified by:

getResolution in interface WebcamDevice

setResolution

public void setResolution(java.awt.Dimension size)

Specified by:

setResolution in interface WebcamDevice

getImage

public java.awt.image.BufferedImage getImage()

Specified by:

getImage in interface WebcamDevice

isOnline

public boolean isOnline()

This method will send HTTP HEAD request to the camera URL to check whether it's online or offline. It's online when this request succeed and it's offline if any exception occurs or response code is 404 Not Found.

Returns:

True if camera is online, false otherwise

open

public void open()

Specified by:

open in interface WebcamDevice

close

public void close()

Specified by:

close in interface WebcamDevice

getURL

public java.net.URL getURL()

getMode

public IpCamMode getMode()

getAuth

public IpCamAuth getAuth()

dispose

public void dispose()

Specified by:

dispose in interface WebcamDevice

isOpen

public boolean isOpen()

Specified by:

isOpen in interface WebcamDevice

getFPS

public double getFPS()

Specified by:

getFPS in interface WebcamDevice.FPSSource

getImageBytes

public java.nio.ByteBuffer getImageBytes()

Return image RGB data in form of ByteBuffer. Please note that ByteBuffer returned by this method does not contain original JPEG data bytes, but bytes representing RGB data of the image constructed from JPEG data.

Specified by:

getImageBytes in interface WebcamDevice.BufferAccess

getImageBytes

public void getImageBytes(java.nio.ByteBuffer buffer)

Put image RGB data into the ByteBuffer. Please note that data from ByteBuffer consumed by this method does not contain original JPEG data bytes, but bytes representing RGB data of the image constructed from JPEG data.

Specified by:

getImageBytes in interface WebcamDevice.BufferAccess