org.bytedeco.javacpp

Class opencv_videoio.VideoWriter

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_videoio.VideoWriter

All Implemented Interfaces:

AutoCloseable

Enclosing class:

opencv_videoio

@Namespace(value="cv")
@NoOffset
public static class opencv_videoio.VideoWriter
extends Pointer

\brief Video writer class.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
opencv_videoio.VideoWriter() \brief VideoWriter constructors
opencv_videoio.VideoWriter(BytePointer filename, int fourcc, double fps, opencv_core.Size frameSize)
opencv_videoio.VideoWriter(BytePointer filename, int fourcc, double fps, opencv_core.Size frameSize, boolean isColor) \overload
opencv_videoio.VideoWriter(long size) Native array allocator.
opencv_videoio.VideoWriter(Pointer p) Pointer cast constructor.
opencv_videoio.VideoWriter(String filename, int fourcc, double fps, opencv_core.Size frameSize)
opencv_videoio.VideoWriter(String filename, int fourcc, double fps, opencv_core.Size frameSize, boolean isColor)

Method Summary

Methods

Modifier and Type	Method and Description
static int	fourcc(byte c1, byte c2, byte c3, byte c4) \brief Concatenates 4 chars to a fourcc code
double	get(int propId) \brief Returns the specified VideoWriter property
boolean	isOpened() \brief Returns true if video writer has been successfully initialized.
boolean	open(BytePointer filename, int fourcc, double fps, opencv_core.Size frameSize)
boolean	open(BytePointer filename, int fourcc, double fps, opencv_core.Size frameSize, boolean isColor) \brief Initializes or reinitializes video writer.
boolean	open(String filename, int fourcc, double fps, opencv_core.Size frameSize)
boolean	open(String filename, int fourcc, double fps, opencv_core.Size frameSize, boolean isColor)
opencv_videoio.VideoWriter	position(long position)
void	release() \brief Closes the video writer.
boolean	set(int propId, double value) \brief Sets a property in the VideoWriter.
opencv_videoio.VideoWriter	shiftLeft(opencv_core.Mat image)
void	write(opencv_core.Mat image) \brief Writes the next video frame

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, isNull, limit, limit, maxBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, totalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

opencv_videoio.VideoWriter

public opencv_videoio.VideoWriter(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

opencv_videoio.VideoWriter

public opencv_videoio.VideoWriter(long size)

Native array allocator. Access with Pointer.position(long).

opencv_videoio.VideoWriter

public opencv_videoio.VideoWriter()

\brief VideoWriter constructors

The constructors/functions initialize video writers. On Linux FFMPEG is used to write videos; on Windows FFMPEG or VFW is used; on MacOSX QTKit is used.

opencv_videoio.VideoWriter

public opencv_videoio.VideoWriter(@opencv_core.Str
                          BytePointer filename,
                          int fourcc,
                          double fps,
                          @ByVal
                          opencv_core.Size frameSize,
                          @Cast(value="bool")
                          boolean isColor)

\overload

Parameters:

filename - Name of the output video file.

fourcc - 4-character code of codec used to compress the frames. For example, VideoWriter::fourcc('P','I','M','1') is a MPEG-1 codec, VideoWriter::fourcc('M','J','P','G') is a motion-jpeg codec etc. List of codes can be obtained at [Video Codecs by FOURCC](http://www.fourcc.org/codecs.php) page. FFMPEG backend with MP4 container natively uses other values as fourcc code: see [ObjectType](http://www.mp4ra.org/codecs.html), so you may receive a warning message from OpenCV about fourcc code conversion.

fps - Framerate of the created video stream.

frameSize - Size of the video frames.

isColor - If it is not zero, the encoder will expect and encode color frames, otherwise it will work with grayscale frames (the flag is currently supported on Windows only).

opencv_videoio.VideoWriter

public opencv_videoio.VideoWriter(@opencv_core.Str
                          BytePointer filename,
                          int fourcc,
                          double fps,
                          @ByVal
                          opencv_core.Size frameSize)

opencv_videoio.VideoWriter

public opencv_videoio.VideoWriter(@opencv_core.Str
                          String filename,
                          int fourcc,
                          double fps,
                          @ByVal
                          opencv_core.Size frameSize,
                          @Cast(value="bool")
                          boolean isColor)

opencv_videoio.VideoWriter

public opencv_videoio.VideoWriter(@opencv_core.Str
                          String filename,
                          int fourcc,
                          double fps,
                          @ByVal
                          opencv_core.Size frameSize)

Method Detail

position

public opencv_videoio.VideoWriter position(long position)

Overrides:

position in class Pointer

open

@Cast(value="bool")
public boolean open(@opencv_core.Str
                     BytePointer filename,
                     int fourcc,
                     double fps,
                     @ByVal
                     opencv_core.Size frameSize,
                     @Cast(value="bool")
                     boolean isColor)

\brief Initializes or reinitializes video writer.

The method opens video writer. Parameters are the same as in the constructor VideoWriter::VideoWriter.

open

@Cast(value="bool")
public boolean open(@opencv_core.Str
                     BytePointer filename,
                     int fourcc,
                     double fps,
                     @ByVal
                     opencv_core.Size frameSize)

open

@Cast(value="bool")
public boolean open(@opencv_core.Str
                     String filename,
                     int fourcc,
                     double fps,
                     @ByVal
                     opencv_core.Size frameSize,
                     @Cast(value="bool")
                     boolean isColor)

open

@Cast(value="bool")
public boolean open(@opencv_core.Str
                     String filename,
                     int fourcc,
                     double fps,
                     @ByVal
                     opencv_core.Size frameSize)

isOpened

@Cast(value="bool")
public boolean isOpened()

\brief Returns true if video writer has been successfully initialized.

release

public void release()

\brief Closes the video writer.

The methods are automatically called by subsequent VideoWriter::open and by the VideoWriter destructor.

shiftLeft

@ByRef
@Name(value="operator <<")
public opencv_videoio.VideoWriter shiftLeft(@Const@ByRef
                                                   opencv_core.Mat image)

write

public void write(@Const@ByRef
         opencv_core.Mat image)

\brief Writes the next video frame

Parameters:

image - The written frame

The functions/methods write the specified image to video file. It must have the same size as has been specified when opening the video writer.

set

@Cast(value="bool")
public boolean set(int propId,
                    double value)

\brief Sets a property in the VideoWriter.

Parameters:

propId - Property identifier. It can be one of the following: - **VIDEOWRITER_PROP_QUALITY** Quality (0..100%) of the videostream encoded. Can be adjusted dynamically in some codecs. - **VIDEOWRITER_PROP_NSTRIPES** Number of stripes for parallel encoding

value - Value of the property.

get

public double get(int propId)

\brief Returns the specified VideoWriter property

Parameters:

propId - Property identifier. It can be one of the following: - **VIDEOWRITER_PROP_QUALITY** Current quality of the encoded videostream. - **VIDEOWRITER_PROP_FRAMEBYTES** (Read-only) Size of just encoded video frame; note that the encoding order may be different from representation order. - **VIDEOWRITER_PROP_NSTRIPES** Number of stripes for parallel encoding

\note When querying a property that is not supported by the backend used by the VideoWriter class, value 0 is returned.

fourcc

public static int fourcc(@Cast(value="char")
         byte c1,
         @Cast(value="char")
         byte c2,
         @Cast(value="char")
         byte c3,
         @Cast(value="char")
         byte c4)

\brief Concatenates 4 chars to a fourcc code

This static method constructs the fourcc code of the codec to be used in the constructor VideoWriter::VideoWriter or VideoWriter::open.