boofcv 1.0.2

class: SimpleImageSequence

[124:7] extends: object

SimpleImageSequence wraps boofcv.io.image.SimpleImageSequence.

Members

• obj

Methods

• SimpleImageSequence (object Obj)

  Wraps a simple image sequence.

  • @p Obj is an existing sequence object.

• getWidth ()

  Gets sequence width.

  • @r Width in pixels.

• getHeight ()

  Gets sequence height.

  • @r Height in pixels.

• hasNext ()

  Gets whether another frame is available.

  • @r True when next can be called.

• next ()

  Gets the next BoofCV image.

  • @r The next image Java object.

• getImage ()

  Gets the current BoofCV image.

  • @r The current image Java object.

• getGuiImage ()

  Gets the current GUI image.

  • @r The current GUI image Java object.

• getFrameNumber ()

  Gets the frame number.

  • @r The current frame number.

• setLoop (bool On)

  Sets looping.

  • @p On true enables looping when supported.

• getImageType ()

  Gets image type.

  • @r An ImageType wrapper.

• reset ()

  Resets the sequence.

• close ()

  Closes the sequence.

class: JCodecMediaManager

[74:7] extends: MediaManager

JCodecMediaManager wraps boofcv.io.jcodec.JCodecMediaManager.

Methods

• JCodecMediaManager ()

  Creates the JCodec media manager.

class: FfmpegVideoImageSequence

[108:7] extends: SimpleImageSequence

FfmpegVideoImageSequence wraps boofcv.io.ffmpeg.FfmpegVideoImageSequence. This class needs the FFmpeg native libraries and this package does not ship them, so calling the constructor as-is raises a runtime exception reading no jniavutil in java.library.path. That is expected and does not mean the install is broken. The reason is licensing. The only prebuilt FFmpeg binaries matching the API BoofCV was compiled against were built with the FFmpeg configure flags enable-gpl and enable-nonfree. That combination puts GPL code in the same binary as code the GPL forbids combining with, so the result cannot be redistributed under any license. Bundling it would make this whole package undistributable. Newer FFmpeg builds without those flags exist but renamed their Java packages and no longer bind to BoofCV. You can still use FFmpeg by supplying the binaries yourself. Download the native jar for your platform from Maven Central under org.bytedeco.javacpp-presets:ffmpeg:4.1-1.4.4, for example ffmpeg-4.1-1.4.4-linux-x86_64.jar, then call app.loadJar("lib/ffmpeg-4.1-1.4.4-linux-x86_64.jar") before creating a sequence. The version must be 4.1-1.4.4; later versions will not bind. Doing this makes you the party distributing those binaries, so their license terms become yours to meet. See README.md for the full steps. To avoid the question entirely, JCodecMediaManager reads video with no native code at all. It handles fewer formats, mainly H.264 in MP4, but it is included here and ready to use.

Methods

• FfmpegVideoImageSequence (string Path, object ImageType)

  Creates an FFmpeg video sequence. Requires the FFmpeg native jar to be loaded first. See the class documentation above for why it is not bundled and how to add it.

  • @p Path is the video path.
  • @p ImageType is an ImageType wrapper.

class: DefaultMediaManager

[62:7] extends: MediaManager

DefaultMediaManager wraps boofcv.io.wrapper.DefaultMediaManager.

Methods

• DefaultMediaManager ()

  Creates the default media manager.

class: MediaManager

[22:7] extends: object

MediaManager wraps boofcv.io.MediaManager.

Members

• obj

Methods

• MediaManager (object Obj)

  Wraps a media manager.

  • @p Obj is an existing media manager Java object.

• openVideo (string Path, object ImageType)

  Opens video.

  • @p Path is a file path or URL accepted by the concrete manager.
  • @p ImageType is an ImageType wrapper.
  • @r A SimpleImageSequence wrapper.

• openCamera (string Spec, int Width, int Height, object ImageType)

  Opens a camera.

  • @p Spec is the concrete manager camera spec.
  • @p Width is requested width.
  • @p Height is requested height.
  • @p ImageType is an ImageType wrapper.
  • @r A SimpleImageSequence wrapper.

• openImage (string Path)

  Opens an image.

  • @p Path is a file path or URL accepted by the manager.
  • @r A BufferedImage Java object.

• openFile (string Path)

  Opens a text file.

  • @p Path is a file path or URL accepted by the manager.
  • @r A Reader Java object.