org.bytedeco.javacv

Class OpenKinect2FrameGrabber

java.lang.Object

org.bytedeco.javacv.FrameGrabber

org.bytedeco.javacv.OpenKinect2FrameGrabber

All Implemented Interfaces:

Closeable, AutoCloseable

public class OpenKinect2FrameGrabber
extends FrameGrabber

Author:

Jeremy Laviole

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	DEFAULT_COLOR_HEIGHT
static int	DEFAULT_COLOR_WIDTH
static int	DEFAULT_DEPTH_HEIGHT
static int	DEFAULT_DEPTH_WIDTH

Fields inherited from class org.bytedeco.javacv.FrameGrabber

aspectRatio, audioBitrate, audioChannels, audioCodec, audioCodecName, audioMetadata, audioOptions, audioStream, bpp, 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, timeout, timestamp, triggerMode, videoBitrate, videoCodec, videoCodecName, videoMetadata, videoOptions, videoStream

Constructor Summary

Constructors

Constructor and Description
OpenKinect2FrameGrabber(int deviceNumber)

Method Summary

Modifier and Type	Method and Description
static OpenKinect2FrameGrabber	createDefault(File deviceFile)
static OpenKinect2FrameGrabber	createDefault(int deviceNumber)
static OpenKinect2FrameGrabber	createDefault(String devicePath)
void	enableColorStream()
void	enableDepthStream()
void	enableIRStream()
protected void	finalize()
ByteOrder	getByteOrder()
int	getDepthFrameRate()
org.bytedeco.javacpp.opencv_core.IplImage	getDepthImage()
int	getDepthImageHeight()
int	getDepthImageWidth()
static String[]	getDeviceDescriptions()
org.bytedeco.javacpp.opencv_core.IplImage	getIRImage()
int	getIRImageHeight()
int	getIRImageWidth()
org.bytedeco.javacpp.opencv_core.IplImage	getVideoImage()
Frame	grab() Each call to grab stores the new image in the memory address for the previously returned frame.
protected void	grabDepth()
protected void	grabIR()
protected void	grabVideo()
void	release()
void	setByteOrder(ByteOrder byteOrder)
void	setDepthFrameRate(int frameRate)
void	setDepthImageHeight(int depthImageHeight)
void	setDepthImageWidth(int depthImageWidth)
void	setIRImageHeight(int IRImageHeight)
void	setIRImageWidth(int IRImageWidth)
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, getAudioMetadata, getAudioMetadata, getAudioOption, getAudioOptions, getAudioStream, getBitsPerPixel, 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, getVideoMetadata, getVideoMetadata, getVideoOption, getVideoOptions, getVideoStream, grabFrame, init, isDeinterlace, isTriggerMode, restart, setAspectRatio, setAudioBitrate, setAudioChannels, setAudioCodec, setAudioCodecName, setAudioMetadata, setAudioMetadata, setAudioOption, setAudioOptions, setAudioStream, setBitsPerPixel, 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, setVideoMetadata, setVideoMetadata, setVideoOption, setVideoOptions, setVideoStream

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEPTH_WIDTH

public static int DEFAULT_DEPTH_WIDTH

DEFAULT_DEPTH_HEIGHT

public static int DEFAULT_DEPTH_HEIGHT

DEFAULT_COLOR_WIDTH

public static int DEFAULT_COLOR_WIDTH

DEFAULT_COLOR_HEIGHT

public static int DEFAULT_COLOR_HEIGHT

Constructor Detail

OpenKinect2FrameGrabber

public OpenKinect2FrameGrabber(int deviceNumber)

Method Detail

getDeviceDescriptions

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

Throws:

FrameGrabber.Exception

getByteOrder

public ByteOrder getByteOrder()

setByteOrder

public void setByteOrder(ByteOrder byteOrder)

createDefault

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

Throws:

FrameGrabber.Exception

createDefault

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

Throws:

FrameGrabber.Exception

createDefault

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

Throws:

FrameGrabber.Exception

tryLoad

public static void tryLoad()
                    throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

enableColorStream

public void enableColorStream()

enableDepthStream

public void enableDepthStream()

enableIRStream

public void enableIRStream()

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

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:

Exception

FrameGrabber.Exception

grabVideo

protected void grabVideo()

grabIR

protected void grabIR()

grabDepth

protected void grabDepth()

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:

null grabs all images, get them with grabColor, grabDepth, and grabIR instead.

Throws:

FrameGrabber.Exception

getVideoImage

public org.bytedeco.javacpp.opencv_core.IplImage getVideoImage()

getIRImage

public org.bytedeco.javacpp.opencv_core.IplImage getIRImage()

getDepthImage

public org.bytedeco.javacpp.opencv_core.IplImage getDepthImage()

trigger

public void trigger()
             throws FrameGrabber.Exception

Specified by:

trigger in class FrameGrabber

Throws:

FrameGrabber.Exception

getDepthImageWidth

public int getDepthImageWidth()

setDepthImageWidth

public void setDepthImageWidth(int depthImageWidth)

getDepthImageHeight

public int getDepthImageHeight()

setDepthImageHeight

public void setDepthImageHeight(int depthImageHeight)

getIRImageWidth

public int getIRImageWidth()

setIRImageWidth

public void setIRImageWidth(int IRImageWidth)

getIRImageHeight

public int getIRImageHeight()

setIRImageHeight

public void setIRImageHeight(int IRImageHeight)

getDepthFrameRate

public int getDepthFrameRate()

setDepthFrameRate

public void setDepthFrameRate(int frameRate)