org.bytedeco.javacv

Class VideoInputFrameGrabber

java.lang.Object

org.bytedeco.javacv.FrameGrabber

org.bytedeco.javacv.VideoInputFrameGrabber

All Implemented Interfaces:

Closeable, AutoCloseable

public class VideoInputFrameGrabber
extends FrameGrabber

Author:

Samuel Audet

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, audioMetadata, audioOptions, audioStream, bpp, deinterlace, format, frameNumber, frameRate, gamma, imageHeight, imageMode, imageWidth, list, maxDelay, metadata, numBuffers, options, pixelFormat, sampleFormat, sampleMode, sampleRate, SENSOR_PATTERN_BGGR, SENSOR_PATTERN_GBRG, SENSOR_PATTERN_GRBG, SENSOR_PATTERN_RGGB, sensorPattern, timeout, timestamp, triggerMode, videoBitrate, videoCodec, videoMetadata, videoOptions, videoStream

Constructor Summary

Constructors

Constructor and Description
VideoInputFrameGrabber(int deviceNumber)

Method Summary

Modifier and Type	Method and Description
static VideoInputFrameGrabber	createDefault(File deviceFile)
static VideoInputFrameGrabber	createDefault(int deviceNumber)
static VideoInputFrameGrabber	createDefault(String devicePath)
protected void	finalize()
static String[]	getDeviceDescriptions()
double	getGamma()
int	getImageHeight()
int	getImageWidth()
Frame	grab() Each call to grab stores the new image in the memory address for the previously returned frame.
void	release()
void	start()
void	start(int connection)
void	stop()
void	trigger()
static void	tryLoad()

Methods inherited from class org.bytedeco.javacv.FrameGrabber

close, create, create, create, create, createArray, delayedGrab, flush, get, getAspectRatio, getAudioBitrate, getAudioChannels, getAudioCodec, getAudioMetadata, getAudioMetadata, getAudioOption, getAudioOptions, getAudioStream, getBitsPerPixel, getDefault, getDelayedFrame, getDelayedTime, getFormat, getFrameNumber, getFrameRate, getImageMode, getLengthInFrames, getLengthInTime, getMaxDelay, getMetadata, getMetadata, getNumBuffers, getOption, getOptions, getPixelFormat, getSampleFormat, getSampleMode, getSampleRate, getSensorPattern, getTimeout, getTimestamp, getVideoBitrate, getVideoCodec, getVideoMetadata, getVideoMetadata, getVideoOption, getVideoOptions, getVideoStream, grabFrame, init, isDeinterlace, isTriggerMode, restart, setAspectRatio, setAudioBitrate, setAudioChannels, setAudioCodec, setAudioMetadata, setAudioMetadata, setAudioOption, setAudioOptions, setAudioStream, setBitsPerPixel, setDeinterlace, setFormat, setFrameNumber, setFrameRate, setGamma, setImageHeight, setImageMode, setImageWidth, setMaxDelay, setMetadata, setMetadata, setNumBuffers, setOption, setOptions, setPixelFormat, setSampleFormat, setSampleMode, setSampleRate, setSensorPattern, setTimeout, setTimestamp, setTriggerMode, setVideoBitrate, setVideoCodec, setVideoMetadata, setVideoMetadata, setVideoOption, setVideoOptions, setVideoStream

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoInputFrameGrabber

public VideoInputFrameGrabber(int deviceNumber)

Method Detail

getDeviceDescriptions

public static String[] getDeviceDescriptions()
                                      throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

createDefault

public static VideoInputFrameGrabber createDefault(File deviceFile)
                                            throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

createDefault

public static VideoInputFrameGrabber createDefault(String devicePath)
                                            throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

createDefault

public static VideoInputFrameGrabber createDefault(int deviceNumber)
                                            throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

tryLoad

public static void tryLoad()
                    throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

release

public void release()
             throws FrameGrabber.Exception

Specified by:

release in class FrameGrabber

Throws:

FrameGrabber.Exception

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getGamma

public double getGamma()

Overrides:

getGamma in class FrameGrabber

getImageWidth

public int getImageWidth()

Overrides:

getImageWidth in class FrameGrabber

getImageHeight

public int getImageHeight()

Overrides:

getImageHeight in class FrameGrabber

start

public void start()
           throws FrameGrabber.Exception

Specified by:

start in class FrameGrabber

Throws:

FrameGrabber.Exception

start

public void start(int connection)
           throws FrameGrabber.Exception

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