org.bytedeco.flycapture.FlyCapture2

Class FlyCapture2Video

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.flycapture.FlyCapture2.FlyCapture2Video

All Implemented Interfaces:

AutoCloseable

@Namespace(value="FlyCapture2")
 @NoOffset
 @Properties(inherit=FlyCapture2.class)
public class FlyCapture2Video
extends Pointer

The FlyCapture2Video class provides the functionality for the user to record images to an AVI file.

Nested Class Summary

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FlyCapture2Video() Default constructor.
FlyCapture2Video(long size) Native array allocator.
FlyCapture2Video(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Error	Append(Image pImage) Append an image to the AVI/MP4 file.
Error	Close() Close the AVI/MP4 file.
FlyCapture2Video	getPointer(long i)
Error	Open(BytePointer pFileName, AVIOption pOption) Open an AVI file in preparation for writing Images to disk.
Error	Open(BytePointer pFileName, H264Option pOption) Open an H.264 video file in preparation for writing Images to disk.
Error	Open(BytePointer pFileName, MJPGOption pOption) Open an MJPEG AVI file in preparation for writing Images to disk.
Error	Open(String pFileName, AVIOption pOption)
Error	Open(String pFileName, H264Option pOption)
Error	Open(String pFileName, MJPGOption pOption)
FlyCapture2Video	position(long position)
void	SetMaximumFileSize(int size) Set the maximum file size (in megabytes) of a AVI/MP4 file.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

FlyCapture2Video

public FlyCapture2Video(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FlyCapture2Video

public FlyCapture2Video(long size)

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

FlyCapture2Video

public FlyCapture2Video()

Default constructor.

Method Detail

position

public FlyCapture2Video position(long position)

Overrides:

position in class Pointer

getPointer

public FlyCapture2Video getPointer(long i)

Overrides:

getPointer in class Pointer

Open

@ByVal
public Error Open(@Cast(value="const char*")
                         BytePointer pFileName,
                         AVIOption pOption)

Open an AVI file in preparation for writing Images to disk. The size of AVI files is limited to 2GB. The filenames are automatically generated using the filename specified.

Parameters:

pFileName - The filename of the AVI file.

pOption - Options to apply to the AVI file.

Returns:

An Error indicating the success or failure of the function.

See Also:

SetMaximumFileSize(), Close()

Open

@ByVal
public Error Open(String pFileName,
                         AVIOption pOption)

Open

@ByVal
public Error Open(@Cast(value="const char*")
                         BytePointer pFileName,
                         MJPGOption pOption)

Open an MJPEG AVI file in preparation for writing Images to disk. The size of AVI files is limited to 2GB. The filenames are automatically generated using the filename specified.

Parameters:

pFileName - The filename of the AVI file.

pOption - MJPEG options to apply to the AVI file.

Returns:

An Error indicating the success or failure of the function.

See Also:

SetMaximumFileSize(), Close(), MJPGOption

Open

@ByVal
public Error Open(String pFileName,
                         MJPGOption pOption)

Open

@ByVal
public Error Open(@Cast(value="const char*")
                         BytePointer pFileName,
                         H264Option pOption)

Open an H.264 video file in preparation for writing Images to disk. If the file extension is not specified, MP4 will be used as the default container. Consult ffmpeg documentation for a list of supported containers.

Parameters:

pFileName - The filename of the video file.

pOption - H.264 options to apply to the video file.

Returns:

An Error indicating the success or failure of the function.

See Also:

Close(), H264Option

Open

@ByVal
public Error Open(String pFileName,
                         H264Option pOption)

Append

@ByVal
public Error Append(Image pImage)

Append an image to the AVI/MP4 file.

Parameters:

pImage - The image to append.

Returns:

An Error indicating the success or failure of the function.

Close

@ByVal
public Error Close()

Close the AVI/MP4 file.

Returns:

An Error indicating the success or failure of the function.

See Also:

Open()

SetMaximumFileSize

public void SetMaximumFileSize(@Cast(value="unsigned int")
                               int size)

Set the maximum file size (in megabytes) of a AVI/MP4 file. A new AVI/MP4 file is created automatically when file size limit is reached. Setting a maximum size of 0 indicates no limit on file size.

Parameters:

size - The maximum AVI file size in MB.

See Also:

Append()