FrameGrabber (JavaCV 1.0 API)

java.lang.Object
- org.bytedeco.javacv.FrameGrabber

Direct Known Subclasses:

DC1394FrameGrabber, FFmpegFrameGrabber, FlyCapture2FrameGrabber, FlyCaptureFrameGrabber, IPCameraFrameGrabber, OpenCVFrameGrabber, OpenKinectFrameGrabber, PS3EyeFrameGrabber, VideoInputFrameGrabber
```
public abstract class FrameGrabber
extends Object
```
Author:

Samuel Audet

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FrameGrabber.Array`
`static class`	`FrameGrabber.Exception`
`static class`	`FrameGrabber.ImageMode`
`static class`	`FrameGrabber.PropertyEditor`

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`aspectRatio`
`protected int`	`audioBitrate`
`protected int`	`audioChannels`
`protected int`	`audioCodec`
`protected HashMap<String,String>`	`audioMetadata`
`protected HashMap<String,String>`	`audioOptions`
`protected int`	`audioStream`
`protected int`	`bpp`
`protected boolean`	`deinterlace`
`protected String`	`format`
`protected int`	`frameNumber`
`protected double`	`frameRate`
`protected double`	`gamma`
`protected int`	`imageHeight`
`protected FrameGrabber.ImageMode`	`imageMode`
`protected int`	`imageWidth`
`static List<String>`	`list`
`protected HashMap<String,String>`	`metadata`
`protected int`	`numBuffers`
`protected HashMap<String,String>`	`options`
`protected int`	`pixelFormat`
`protected int`	`sampleFormat`
`protected int`	`sampleRate`
`static long`	`SENSOR_PATTERN_BGGR`
`static long`	`SENSOR_PATTERN_GBRG`
`static long`	`SENSOR_PATTERN_GRBG`
`static long`	`SENSOR_PATTERN_RGGB`
`protected long`	`sensorPattern`
`protected int`	`timeout`
`protected long`	`timestamp`
`protected boolean`	`triggerMode`
`protected int`	`videoBitrate`
`protected int`	`videoCodec`
`protected HashMap<String,String>`	`videoMetadata`
`protected HashMap<String,String>`	`videoOptions`
`protected int`	`videoStream`

Constructor Summary

Constructors
Constructor and Description

FrameGrabber()

Constructors
Constructor and Description
`FrameGrabber()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static FrameGrabber`	`create(Class<? extends FrameGrabber> c, Class p, Object o)`
`static FrameGrabber`	`create(String className, File deviceFile)`
`static FrameGrabber`	`create(String className, int deviceNumber)`
`static FrameGrabber`	`create(String className, String devicePath)`
`FrameGrabber.Array`	`createArray(FrameGrabber[] frameGrabbers)`
`static FrameGrabber`	`createDefault(File deviceFile)`
`static FrameGrabber`	`createDefault(int deviceNumber)`
`static FrameGrabber`	`createDefault(String devicePath)`
`void`	`delayedGrab(long delayTime)`
`void`	`flush()`
`static Class<? extends FrameGrabber>`	`get(String className)`
`double`	`getAspectRatio()`
`int`	`getAudioBitrate()`
`int`	`getAudioChannels()`
`int`	`getAudioCodec()`
`String`	`getAudioMetadata(String key)`
`String`	`getAudioOption(String key)`
`int`	`getAudioStream()`
`int`	`getBitsPerPixel()`
`static Class<? extends FrameGrabber>`	`getDefault()`
`Frame`	`getDelayedFrame()`
`long`	`getDelayedTime()`
`String`	`getFormat()`
`int`	`getFrameNumber()`
`double`	`getFrameRate()`
`double`	`getGamma()`
`int`	`getImageHeight()`
`FrameGrabber.ImageMode`	`getImageMode()`
`int`	`getImageWidth()`
`int`	`getLengthInFrames()`
`long`	`getLengthInTime()`
`String`	`getMetadata(String key)`
`int`	`getNumBuffers()`
`String`	`getOption(String key)`
`int`	`getPixelFormat()`
`int`	`getSampleFormat()`
`int`	`getSampleRate()`
`long`	`getSensorPattern()`
`int`	`getTimeout()`
`long`	`getTimestamp()`
`int`	`getVideoBitrate()`
`int`	`getVideoCodec()`
`String`	`getVideoMetadata(String key)`
`String`	`getVideoOption(String key)`
`int`	`getVideoStream()`
`abstract Frame`	`grab()`
`Frame`	`grabFrame()`
`static void`	`init()`
`boolean`	`isDeinterlace()`
`boolean`	`isTriggerMode()`
`abstract void`	`release()`
`void`	`restart()`
`void`	`setAspectRatio(double aspectRatio)`
`void`	`setAudioBitrate(int audioBitrate)`
`void`	`setAudioChannels(int audioChannels)`
`void`	`setAudioCodec(int audioCodec)`
`void`	`setAudioMetadata(String key, String value)`
`void`	`setAudioOption(String key, String value)`
`void`	`setAudioStream(int audioStream)`
`void`	`setBitsPerPixel(int bitsPerPixel)`
`void`	`setDeinterlace(boolean deinterlace)`
`void`	`setFormat(String format)`
`void`	`setFrameNumber(int frameNumber)`
`void`	`setFrameRate(double frameRate)`
`void`	`setGamma(double gamma)`
`void`	`setImageHeight(int imageHeight)`
`void`	`setImageMode(FrameGrabber.ImageMode imageMode)`
`void`	`setImageWidth(int imageWidth)`
`void`	`setMetadata(String key, String value)`
`void`	`setNumBuffers(int numBuffers)`
`void`	`setOption(String key, String value)`
`void`	`setPixelFormat(int pixelFormat)`
`void`	`setSampleFormat(int sampleFormat)`
`void`	`setSampleRate(int sampleRate)`
`void`	`setSensorPattern(long sensorPattern)`
`void`	`setTimeout(int timeout)`
`void`	`setTimestamp(long timestamp)`
`void`	`setTriggerMode(boolean triggerMode)`
`void`	`setVideoBitrate(int videoBitrate)`
`void`	`setVideoCodec(int videoCodec)`
`void`	`setVideoMetadata(String key, String value)`
`void`	`setVideoOption(String key, String value)`
`void`	`setVideoStream(int videoStream)`
`abstract void`	`start()`
`abstract void`	`stop()`
`abstract void`	`trigger()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

list
```
public static final List<String> list
```

SENSOR_PATTERN_RGGB
```
public static final long SENSOR_PATTERN_RGGB
```
See Also:

Constant Field Values

SENSOR_PATTERN_GBRG
```
public static final long SENSOR_PATTERN_GBRG
```
See Also:

Constant Field Values

SENSOR_PATTERN_GRBG
```
public static final long SENSOR_PATTERN_GRBG
```
See Also:

Constant Field Values

SENSOR_PATTERN_BGGR
```
public static final long SENSOR_PATTERN_BGGR
```
See Also:

Constant Field Values

videoStream
```
protected int videoStream
```

audioStream
```
protected int audioStream
```

format
```
protected String format
```

imageWidth
```
protected int imageWidth
```

imageHeight
```
protected int imageHeight
```

audioChannels
```
protected int audioChannels
```

imageMode

protected FrameGrabber.ImageMode imageMode

sensorPattern
```
protected long sensorPattern
```

pixelFormat
```
protected int pixelFormat
```

videoCodec
```
protected int videoCodec
```

videoBitrate
```
protected int videoBitrate
```

aspectRatio
```
protected double aspectRatio
```

frameRate
```
protected double frameRate
```

sampleFormat
```
protected int sampleFormat
```

audioCodec
```
protected int audioCodec
```

audioBitrate
```
protected int audioBitrate
```

sampleRate
```
protected int sampleRate
```

triggerMode
```
protected boolean triggerMode
```

bpp
```
protected int bpp
```

timeout
```
protected int timeout
```

numBuffers
```
protected int numBuffers
```

gamma
```
protected double gamma
```

deinterlace
```
protected boolean deinterlace
```

options

protected HashMap<String,String> options

videoOptions

protected HashMap<String,String> videoOptions

audioOptions

protected HashMap<String,String> audioOptions

metadata

protected HashMap<String,String> metadata

videoMetadata

protected HashMap<String,String> videoMetadata

audioMetadata

protected HashMap<String,String> audioMetadata

frameNumber
```
protected int frameNumber
```

timestamp
```
protected long timestamp
```

Constructor Detail
- FrameGrabber
```
public FrameGrabber()
```

Method Detail

init
```
public static void init()
```

getDefault

public static Class<? extends FrameGrabber> getDefault()

get

public static Class<? extends FrameGrabber> get(String className)
                                         throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

create

public static FrameGrabber create(Class<? extends FrameGrabber> c,
                                  Class p,
                                  Object o)
                           throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

createDefault

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

Throws:: FrameGrabber.Exception

createDefault

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

Throws:: FrameGrabber.Exception

createDefault

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

Throws:: FrameGrabber.Exception

create

public static FrameGrabber create(String className,
                                  File deviceFile)
                           throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

create

public static FrameGrabber create(String className,
                                  String devicePath)
                           throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

create

public static FrameGrabber create(String className,
                                  int deviceNumber)
                           throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

getVideoStream
```
public int getVideoStream()
```

setVideoStream

public void setVideoStream(int videoStream)

getAudioStream
```
public int getAudioStream()
```

setAudioStream

public void setAudioStream(int audioStream)

getFormat
```
public String getFormat()
```

setFormat
```
public void setFormat(String format)
```

getImageWidth
```
public int getImageWidth()
```

setImageWidth

public void setImageWidth(int imageWidth)

getImageHeight
```
public int getImageHeight()
```

setImageHeight

public void setImageHeight(int imageHeight)

getAudioChannels
```
public int getAudioChannels()
```

setAudioChannels

public void setAudioChannels(int audioChannels)

getImageMode

public FrameGrabber.ImageMode getImageMode()

setImageMode

public void setImageMode(FrameGrabber.ImageMode imageMode)

getSensorPattern
```
public long getSensorPattern()
```

setSensorPattern

public void setSensorPattern(long sensorPattern)

getPixelFormat
```
public int getPixelFormat()
```

setPixelFormat

public void setPixelFormat(int pixelFormat)

getVideoCodec
```
public int getVideoCodec()
```

setVideoCodec

public void setVideoCodec(int videoCodec)

getVideoBitrate
```
public int getVideoBitrate()
```

setVideoBitrate

public void setVideoBitrate(int videoBitrate)

getAspectRatio
```
public double getAspectRatio()
```

setAspectRatio

public void setAspectRatio(double aspectRatio)

getFrameRate
```
public double getFrameRate()
```

setFrameRate

public void setFrameRate(double frameRate)

getAudioCodec
```
public int getAudioCodec()
```

setAudioCodec

public void setAudioCodec(int audioCodec)

getAudioBitrate
```
public int getAudioBitrate()
```

setAudioBitrate

public void setAudioBitrate(int audioBitrate)

getSampleFormat
```
public int getSampleFormat()
```

setSampleFormat

public void setSampleFormat(int sampleFormat)

getSampleRate
```
public int getSampleRate()
```

setSampleRate

public void setSampleRate(int sampleRate)

isTriggerMode
```
public boolean isTriggerMode()
```

setTriggerMode

public void setTriggerMode(boolean triggerMode)

getBitsPerPixel
```
public int getBitsPerPixel()
```

setBitsPerPixel

public void setBitsPerPixel(int bitsPerPixel)

getTimeout
```
public int getTimeout()
```

setTimeout
```
public void setTimeout(int timeout)
```

getNumBuffers
```
public int getNumBuffers()
```

setNumBuffers

public void setNumBuffers(int numBuffers)

getGamma
```
public double getGamma()
```

setGamma
```
public void setGamma(double gamma)
```

isDeinterlace
```
public boolean isDeinterlace()
```

setDeinterlace

public void setDeinterlace(boolean deinterlace)

getOption
```
public String getOption(String key)
```

setOption

public void setOption(String key,
                      String value)

getVideoOption

public String getVideoOption(String key)

setVideoOption

public void setVideoOption(String key,
                           String value)

getAudioOption

public String getAudioOption(String key)

setAudioOption

public void setAudioOption(String key,
                           String value)

getMetadata

public String getMetadata(String key)

setMetadata

public void setMetadata(String key,
                        String value)

getVideoMetadata

public String getVideoMetadata(String key)

setVideoMetadata

public void setVideoMetadata(String key,
                             String value)

getAudioMetadata

public String getAudioMetadata(String key)

setAudioMetadata

public void setAudioMetadata(String key,
                             String value)

getFrameNumber
```
public int getFrameNumber()
```

setFrameNumber

public void setFrameNumber(int frameNumber)
                    throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

getTimestamp
```
public long getTimestamp()
```

setTimestamp

public void setTimestamp(long timestamp)
                  throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

getLengthInFrames
```
public int getLengthInFrames()
```

getLengthInTime
```
public long getLengthInTime()
```

start

public abstract void start()
                    throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

stop

public abstract void stop()
                   throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

trigger

public abstract void trigger()
                      throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

grab

public abstract Frame grab()
                    throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

grabFrame

public Frame grabFrame()
                throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

release

public abstract void release()
                      throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

restart

public void restart()
             throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

flush

public void flush()
           throws FrameGrabber.Exception

Throws:: FrameGrabber.Exception

delayedGrab

public void delayedGrab(long delayTime)

getDelayedTime

public long getDelayedTime()
                    throws InterruptedException,
                           ExecutionException

Throws:: InterruptedException; ExecutionException

getDelayedFrame

public Frame getDelayedFrame()
                      throws InterruptedException,
                             ExecutionException

Throws:: InterruptedException; ExecutionException

createArray

public FrameGrabber.Array createArray(FrameGrabber[] frameGrabbers)

Class FrameGrabber

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

list

SENSOR_PATTERN_RGGB

SENSOR_PATTERN_GBRG

SENSOR_PATTERN_GRBG

SENSOR_PATTERN_BGGR

videoStream

audioStream

format

imageWidth

imageHeight

audioChannels

imageMode

sensorPattern

pixelFormat

videoCodec

videoBitrate

aspectRatio

frameRate

sampleFormat

audioCodec

audioBitrate

sampleRate

triggerMode

bpp

timeout

numBuffers

gamma

deinterlace

options

videoOptions

audioOptions

metadata

videoMetadata

audioMetadata

frameNumber

timestamp

Constructor Detail

FrameGrabber

Method Detail

init

getDefault

get

create

createDefault

createDefault

createDefault

create

create

create

getVideoStream

setVideoStream

getAudioStream

setAudioStream

getFormat

setFormat

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getAudioChannels

setAudioChannels

getImageMode

setImageMode

getSensorPattern

setSensorPattern

getPixelFormat

setPixelFormat

getVideoCodec

setVideoCodec

getVideoBitrate

setVideoBitrate

getAspectRatio

setAspectRatio