org.bytedeco.javacv

Class FlyCapture2FrameGrabber

java.lang.Object

org.bytedeco.javacv.FrameGrabber

org.bytedeco.javacv.FlyCapture2FrameGrabber

All Implemented Interfaces:

Closeable, AutoCloseable

public class FlyCapture2FrameGrabber
extends FrameGrabber

Author:

Jeremy Laviole, Jarek Sacha

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

Modifier and Type	Field and Description
static int	CAMERA_POWER
static int	IMAGE_DATA_FORMAT
static int	INITIALIZE
static int	IS_CAMERA_POWER
static int	SOFT_ASYNC_TRIGGER
static int	SOFTWARE_TRIGGER
static int	TRIGGER_INQ

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
FlyCapture2FrameGrabber(int deviceNumber)

Method Summary

Modifier and Type	Method and Description
static FlyCapture2FrameGrabber	createDefault(File deviceFile)
static FlyCapture2FrameGrabber	createDefault(int deviceNumber)
static FlyCapture2FrameGrabber	createDefault(String devicePath)
protected void	finalize()
static String[]	getDeviceDescriptions()
double	getFrameRate()
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	setImageMode(FrameGrabber.ImageMode imageMode)
void	start()
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, getAudioCodecName, getAudioDisposition, getAudioMetadata, getAudioMetadata, getAudioOption, getAudioOptions, getAudioSideData, getAudioSideData, getAudioStream, getBitsPerPixel, getCharset, getDefault, getDelayedFrame, getDelayedTime, getFormat, getFrameNumber, getImageMode, getImageScalingFlags, 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, 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INITIALIZE

public static final int INITIALIZE

See Also:

Constant Field Values

TRIGGER_INQ

public static final int TRIGGER_INQ

See Also:

Constant Field Values

IS_CAMERA_POWER

public static final int IS_CAMERA_POWER

See Also:

Constant Field Values

CAMERA_POWER

public static final int CAMERA_POWER

See Also:

Constant Field Values

SOFTWARE_TRIGGER

public static final int SOFTWARE_TRIGGER

See Also:

Constant Field Values

SOFT_ASYNC_TRIGGER

public static final int SOFT_ASYNC_TRIGGER

See Also:

Constant Field Values

IMAGE_DATA_FORMAT

public static final int IMAGE_DATA_FORMAT

See Also:

Constant Field Values

Constructor Detail

FlyCapture2FrameGrabber

public FlyCapture2FrameGrabber(int deviceNumber)
                        throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

Method Detail

getDeviceDescriptions

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

Throws:

FrameGrabber.Exception

createDefault

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

Throws:

FrameGrabber.Exception

createDefault

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

Throws:

FrameGrabber.Exception

createDefault

public static FlyCapture2FrameGrabber 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

getFrameRate

public double getFrameRate()

Overrides:

getFrameRate in class FrameGrabber

setImageMode

public void setImageMode(FrameGrabber.ImageMode imageMode)

Overrides:

setImageMode in class FrameGrabber

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