org.bytedeco.javacv

Class OpenKinectFrameGrabber

java.lang.Object

org.bytedeco.javacv.FrameGrabber

org.bytedeco.javacv.OpenKinectFrameGrabber

All Implemented Interfaces:

Closeable, AutoCloseable

public class OpenKinectFrameGrabber
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, 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, triggerMode, videoBitrate, videoCodec, videoCodecName, videoDisposition, videoMetadata, videoOptions, videoSideData, videoStream

Constructor Summary

Constructors

Constructor and Description
OpenKinectFrameGrabber(int deviceNumber)

Method Summary

Modifier and Type	Method and Description
static OpenKinectFrameGrabber	createDefault(File deviceFile)
static OpenKinectFrameGrabber	createDefault(int deviceNumber)
static OpenKinectFrameGrabber	createDefault(String devicePath)
protected void	finalize()
ByteOrder	getByteOrder()
int	getDepthFormat()
static String[]	getDeviceDescriptions()
double	getGamma()
int	getVideoFormat()
Frame	grab() Each call to grab stores the new image in the memory address for the previously returned frame.
IplImage	grabDepth()
IplImage	grabIR()
IplImage	grabVideo()
void	release()
void	setByteOrder(ByteOrder byteOrder)
void	setDepthFormat(int depthFormat)
void	setImageMode(FrameGrabber.ImageMode imageMode)
void	setVideoFormat(int videoFormat)
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, getFrameRate, 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, 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

Constructor Detail

OpenKinectFrameGrabber

public OpenKinectFrameGrabber(int deviceNumber)

Method Detail

getDeviceDescriptions

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

Throws:

FrameGrabber.Exception

createDefault

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

Throws:

FrameGrabber.Exception

createDefault

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

Throws:

FrameGrabber.Exception

createDefault

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

getByteOrder

public ByteOrder getByteOrder()

setByteOrder

public void setByteOrder(ByteOrder byteOrder)

getDepthFormat

public int getDepthFormat()

setDepthFormat

public void setDepthFormat(int depthFormat)

getVideoFormat

public int getVideoFormat()

setVideoFormat

public void setVideoFormat(int videoFormat)

getGamma

public double getGamma()

Overrides:

getGamma 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

grabDepth

public IplImage grabDepth()
                   throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

grabVideo

public IplImage grabVideo()
                   throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

grabIR

public IplImage grabIR()
                throws FrameGrabber.Exception

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