FFmpegFrameGrabber (JavaCV 1.2 API)

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

public class FFmpegFrameGrabber
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

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, metadata, numBuffers, options, pixelFormat, sampleFormat, 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

FFmpegFrameGrabber(File file)

FFmpegFrameGrabber(String filename)

Constructors
Constructor and Description
`FFmpegFrameGrabber(File file)`
`FFmpegFrameGrabber(String filename)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FFmpegFrameGrabber`	`createDefault(File deviceFile)`
`static FFmpegFrameGrabber`	`createDefault(int deviceNumber)`
`static FFmpegFrameGrabber`	`createDefault(String devicePath)`
`protected void`	`finalize()`
`double`	`getAspectRatio()`
`int`	`getAudioBitrate()`
`int`	`getAudioChannels()`
`int`	`getAudioCodec()`
`String`	`getAudioMetadata(String key)`
`static String[]`	`getDeviceDescriptions()`
`String`	`getFormat()`
`avformat.AVFormatContext`	`getFormatContext()`
`double`	`getFrameRate()`
`double`	`getGamma()`
`int`	`getImageHeight()`
`int`	`getImageWidth()`
`int`	`getLengthInFrames()`
`long`	`getLengthInTime()`
`String`	`getMetadata(String key)`
`int`	`getPixelFormat()`
`int`	`getSampleFormat()`
`int`	`getSampleRate()`
`int`	`getVideoBitrate()`
`int`	`getVideoCodec()`
`String`	`getVideoMetadata(String key)`
`Frame`	`grab()` Each call to grab stores the new image in the memory address for the previously returned frame.
`Frame`	`grabFrame(boolean doAudio, boolean doVideo, boolean processImage, boolean keyFrames)`
`Frame`	`grabImage()`
`Frame`	`grabKeyFrame()`
`avcodec.AVPacket`	`grabPacket()`
`Frame`	`grabSamples()`
`void`	`release()`
`void`	`setFrameNumber(int frameNumber)`
`void`	`setTimestamp(long timestamp)`
`void`	`start()`
`void`	`stop()`
`void`	`trigger()`
`static void`	`tryLoad()`

Methods inherited from class org.bytedeco.javacv.FrameGrabber
create, create, create, create, createArray, delayedGrab, flush, get, getAudioOption, getAudioStream, getBitsPerPixel, getDefault, getDelayedFrame, getDelayedTime, getFrameNumber, getImageMode, getNumBuffers, getOption, getSensorPattern, getTimeout, getTimestamp, getVideoOption, getVideoStream, grabFrame, init, isDeinterlace, isTriggerMode, restart, setAspectRatio, setAudioBitrate, setAudioChannels, setAudioCodec, setAudioMetadata, setAudioOption, setAudioStream, setBitsPerPixel, setDeinterlace, setFormat, setFrameRate, setGamma, setImageHeight, setImageMode, setImageWidth, setMetadata, setNumBuffers, setOption, setPixelFormat, setSampleFormat, setSampleRate, setSensorPattern, setTimeout, setTriggerMode, setVideoBitrate, setVideoCodec, setVideoMetadata, setVideoOption, setVideoStream

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

- Constructor Detail
  - FFmpegFrameGrabber
```
public FFmpegFrameGrabber(File file)
```
  - FFmpegFrameGrabber
```
public FFmpegFrameGrabber(String filename)
```
- Method Detail
  - getDeviceDescriptions
```
public static String[] getDeviceDescriptions()
                                      throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception
  - createDefault
```
public static FFmpegFrameGrabber createDefault(File deviceFile)
                                        throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception
  - createDefault
```
public static FFmpegFrameGrabber createDefault(String devicePath)
                                        throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception
  - createDefault
```
public static FFmpegFrameGrabber 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
  - getFormat
```
public String getFormat()
```
    Overrides:
    
    getFormat in class FrameGrabber
  - getImageWidth
```
public int getImageWidth()
```
    Overrides:
    
    getImageWidth in class FrameGrabber
  - getImageHeight
```
public int getImageHeight()
```
    Overrides:
    
    getImageHeight in class FrameGrabber
  - getAudioChannels
```
public int getAudioChannels()
```
    Overrides:
    
    getAudioChannels in class FrameGrabber
  - getPixelFormat
```
public int getPixelFormat()
```
    Overrides:
    
    getPixelFormat in class FrameGrabber
  - getVideoCodec
```
public int getVideoCodec()
```
    Overrides:
    
    getVideoCodec in class FrameGrabber
  - getVideoBitrate
```
public int getVideoBitrate()
```
    Overrides:
    
    getVideoBitrate in class FrameGrabber
  - getAspectRatio
```
public double getAspectRatio()
```
    Overrides:
    
    getAspectRatio in class FrameGrabber
  - getFrameRate
```
public double getFrameRate()
```
    Overrides:
    
    getFrameRate in class FrameGrabber
  - getAudioCodec
```
public int getAudioCodec()
```
    Overrides:
    
    getAudioCodec in class FrameGrabber
  - getAudioBitrate
```
public int getAudioBitrate()
```
    Overrides:
    
    getAudioBitrate in class FrameGrabber
  - getSampleFormat
```
public int getSampleFormat()
```
    Overrides:
    
    getSampleFormat in class FrameGrabber
  - getSampleRate
```
public int getSampleRate()
```
    Overrides:
    
    getSampleRate in class FrameGrabber
  - getMetadata
```
public String getMetadata(String key)
```
    Overrides:
    
    getMetadata in class FrameGrabber
  - getVideoMetadata
```
public String getVideoMetadata(String key)
```
    Overrides:
    
    getVideoMetadata in class FrameGrabber
  - getAudioMetadata
```
public String getAudioMetadata(String key)
```
    Overrides:
    
    getAudioMetadata in class FrameGrabber
  - setFrameNumber
```
public void setFrameNumber(int frameNumber)
                    throws FrameGrabber.Exception
```
    Overrides:
    
    setFrameNumber in class FrameGrabber
    
    Throws:
    
    FrameGrabber.Exception
  - setTimestamp
```
public void setTimestamp(long timestamp)
                  throws FrameGrabber.Exception
```
    Overrides:
    
    setTimestamp in class FrameGrabber
    
    Throws:
    
    FrameGrabber.Exception
  - getLengthInFrames
```
public int getLengthInFrames()
```
    Overrides:
    
    getLengthInFrames in class FrameGrabber
  - getLengthInTime
```
public long getLengthInTime()
```
    Overrides:
    
    getLengthInTime in class FrameGrabber
  - getFormatContext
```
public avformat.AVFormatContext getFormatContext()
```
  - 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
  - grabImage
```
public Frame grabImage()
                throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception
  - grabSamples
```
public Frame grabSamples()
                  throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception
  - grabKeyFrame
```
public Frame grabKeyFrame()
                   throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception
  - grabFrame
```
public Frame grabFrame(boolean doAudio,
                       boolean doVideo,
                       boolean processImage,
                       boolean keyFrames)
                throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception
  - grabPacket
```
public avcodec.AVPacket grabPacket()
                            throws FrameGrabber.Exception
```
    Throws:
    
    FrameGrabber.Exception

Class FFmpegFrameGrabber

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacv.FrameGrabber

Field Summary

Fields inherited from class org.bytedeco.javacv.FrameGrabber

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacv.FrameGrabber

Methods inherited from class java.lang.Object

Constructor Detail

FFmpegFrameGrabber

FFmpegFrameGrabber

Method Detail

getDeviceDescriptions

createDefault

createDefault

createDefault

tryLoad

release

finalize

getGamma

getFormat

getImageWidth

getImageHeight

getAudioChannels

getPixelFormat

getVideoCodec

getVideoBitrate

getAspectRatio

getFrameRate

getAudioCodec

getAudioBitrate

getSampleFormat

getSampleRate

getMetadata

getVideoMetadata

getAudioMetadata

setFrameNumber

setTimestamp

getLengthInFrames

getLengthInTime

getFormatContext

start

stop

trigger

grab

grabImage

grabSamples

grabKeyFrame

grabFrame

grabPacket