org.bytedeco.javacv

Class IPCameraFrameGrabber

java.lang.Object

org.bytedeco.javacv.FrameGrabber

org.bytedeco.javacv.IPCameraFrameGrabber

All Implemented Interfaces:

Closeable, AutoCloseable

public class IPCameraFrameGrabber
extends FrameGrabber

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacv.FrameGrabber

FrameGrabber.Array, FrameGrabber.Exception, FrameGrabber.ImageMode, FrameGrabber.PropertyEditor, FrameGrabber.SampleMode

Field Summary

Fields inherited from class org.bytedeco.javacv.FrameGrabber

aspectRatio, audioBitrate, audioChannels, audioCodec, audioCodecName, audioDisposition, audioMetadata, audioOptions, audioSideData, audioStream, bpp, charset, deinterlace, format, frameNumber, frameRate, gamma, imageHeight, imageMode, imageScalingFlags, imageWidth, list, maxDelay, metadata, numBuffers, options, pixelFormat, sampleFormat, sampleMode, sampleRate, SENSOR_PATTERN_BGGR, SENSOR_PATTERN_GBRG, SENSOR_PATTERN_GRBG, SENSOR_PATTERN_RGGB, sensorPattern, startTime, timeout, timestamp, triggerMode, videoBitrate, videoCodec, videoCodecName, videoDisposition, videoMetadata, videoOptions, videoSideData, videoStream

Constructor Summary

Constructors

Constructor and Description
IPCameraFrameGrabber(String urlstr) Deprecated. By not setting the connection timeout and the read timeout if your network ever crashes then start() or grab() can hang for upwards of 45 to 60 seconds before failing. You should always explicitly set the connectionTimeout and readTimeout so that your application can respond appropriately to a loss or failure to connect.
IPCameraFrameGrabber(String urlstr, int connectionTimeout, int readTimeout, TimeUnit timeUnit)
IPCameraFrameGrabber(URL url, int startTimeout, int grabTimeout, TimeUnit timeUnit)

Method Summary

Modifier and Type	Method and Description
Frame	grab() Each call to grab stores the new image in the memory address for the previously returned frame.
BufferedImage	grabBufferedImage()
void	release()
void	start()
void	stop()
void	trigger()
static void	tryLoad()

Methods inherited from class org.bytedeco.javacv.FrameGrabber

close, create, create, create, create, createArray, createDefault, createDefault, createDefault, delayedGrab, flush, get, getAspectRatio, getAudioBitrate, getAudioChannels, getAudioCodec, getAudioCodecName, getAudioDisposition, getAudioMetadata, getAudioMetadata, getAudioOption, getAudioOptions, getAudioSideData, getAudioSideData, getAudioStream, getBitsPerPixel, getCharset, getDefault, getDelayedFrame, getDelayedTime, getFormat, getFrameNumber, getFrameRate, getGamma, getImageHeight, getImageMode, getImageScalingFlags, getImageWidth, getLengthInFrames, getLengthInTime, getMaxDelay, getMetadata, getMetadata, getNumBuffers, getOption, getOptions, getPixelFormat, getSampleFormat, getSampleMode, getSampleRate, getSensorPattern, getTimeout, getTimestamp, getVideoBitrate, getVideoCodec, getVideoCodecName, getVideoDisposition, getVideoMetadata, getVideoMetadata, getVideoOption, getVideoOptions, getVideoSideData, getVideoSideData, getVideoStream, grabAtFrameRate, grabFrame, init, isDeinterlace, isTriggerMode, resetStartTime, restart, setAspectRatio, setAudioBitrate, setAudioChannels, setAudioCodec, setAudioCodecName, setAudioDisposition, setAudioMetadata, setAudioMetadata, setAudioOption, setAudioOptions, setAudioSideData, setAudioSideData, setAudioStream, setBitsPerPixel, setCharset, setDeinterlace, setFormat, setFrameNumber, setFrameRate, setGamma, setImageHeight, setImageMode, setImageScalingFlags, setImageWidth, setMaxDelay, setMetadata, setMetadata, setNumBuffers, setOption, setOptions, setPixelFormat, setSampleFormat, setSampleMode, setSampleRate, setSensorPattern, setTimeout, setTimestamp, setTriggerMode, setVideoBitrate, setVideoCodec, setVideoCodecName, setVideoDisposition, setVideoMetadata, setVideoMetadata, setVideoOption, setVideoOptions, setVideoSideData, setVideoSideData, setVideoStream, waitForTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

IPCameraFrameGrabber

public IPCameraFrameGrabber(URL url,
                            int startTimeout,
                            int grabTimeout,
                            TimeUnit timeUnit)

Parameters:

url - The URL to create the camera connection with.

startTimeout - How long should this wait on the connection while trying to start() before timing out. If this value is less than zero it will be ignored. URLConnection.setConnectTimeout(int)

grabTimeout - How long should grab wait while reading the connection before timing out. If this value is less than zero it will be ignored. URLConnection.setReadTimeout(int)

timeUnit - The time unit to use for the connection and read timeout. If this value is null then the start timeout and grab timeout will be ignored.

IPCameraFrameGrabber

public IPCameraFrameGrabber(String urlstr,
                            int connectionTimeout,
                            int readTimeout,
                            TimeUnit timeUnit)
                     throws MalformedURLException

Throws:

MalformedURLException

IPCameraFrameGrabber

@Deprecated
public IPCameraFrameGrabber(String urlstr)
                                 throws MalformedURLException

Deprecated. By not setting the connection timeout and the read timeout if your network ever crashes then start() or grab() can hang for upwards of 45 to 60 seconds before failing. You should always explicitly set the connectionTimeout and readTimeout so that your application can respond appropriately to a loss or failure to connect.

Parameters:

urlstr - A string to be used to create the URL.

Throws:

MalformedURLException - if the urlstr is a malformed URL

Method Detail

tryLoad

public static void tryLoad()
                    throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

start

public void start()
           throws FrameGrabber.Exception

Specified by:

start in class FrameGrabber

Throws:

FrameGrabber.Exception

stop

public void stop()
          throws FrameGrabber.Exception

Specified by:

stop in class FrameGrabber

Throws:

FrameGrabber.Exception

trigger

public void trigger()
             throws FrameGrabber.Exception

Specified by:

trigger in class FrameGrabber

Throws:

FrameGrabber.Exception

grab

public Frame grab()
           throws FrameGrabber.Exception

Description copied from class: FrameGrabber

Each call to grab stores the new image in the memory address for the previously returned frame.
IE.
grabber.grab() == grabber.grab()
This means that if you need to cache images returned from grab you should Frame.clone() the returned frame as the next call to grab will overwrite your existing image's memory.
Why?
Using this method instead of allocating a new buffer every time a frame is grabbed improves performance by reducing the frequency of garbage collections. Almost no additional heap space is typically allocated per frame.

Specified by:

grab in class FrameGrabber

Returns:

The frame returned from the grabber

Throws:

FrameGrabber.Exception

grabBufferedImage

public BufferedImage grabBufferedImage()
                                throws IOException

Throws:

IOException

release

public void release()
             throws FrameGrabber.Exception

Specified by:

release in class FrameGrabber

Throws:

FrameGrabber.Exception