org.jmisb.api.video

Class VideoFileOutput

java.lang.Object

org.jmisb.api.video.VideoIO

org.jmisb.api.video.VideoOutput

org.jmisb.api.video.VideoFileOutput

All Implemented Interfaces:

AutoCloseable, IVideoFileOutput

public class VideoFileOutput
extends VideoOutput
implements IVideoFileOutput

Write video/metadata to a file.

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte	ASYNC_STREAM_ID
protected static byte	SYNC_STREAM_ID

Fields inherited from class org.jmisb.api.video.VideoOutput

METADATA_AU_HEADER_LEN, options

Constructor Summary

Constructors

Constructor and Description
VideoFileOutput(VideoOutputOptions options) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addMetadataFrame(MetadataFrame frame) Append a MetadataFrame to the file.
void	addVideoFrame(VideoFrame frame) Append a VideoFrame to the file.
void	close() Close the file.
boolean	isOpen() Check if a file is open.
void	open(String filename) Open a new file for writing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASYNC_STREAM_ID

protected static final byte ASYNC_STREAM_ID

See Also:

Constant Field Values

SYNC_STREAM_ID

protected static final byte SYNC_STREAM_ID

See Also:

Constant Field Values

Constructor Detail

VideoFileOutput

public VideoFileOutput(VideoOutputOptions options)

Constructor.

Parameters:

options - Options for video output

Method Detail

open

public void open(String filename)
          throws IOException

Description copied from interface: IVideoFileOutput

Open a new file for writing.

Specified by:

open in interface IVideoFileOutput

Parameters:

filename - The file name

Throws:

IOException - if the file could not be opened

isOpen

public boolean isOpen()

Description copied from interface: IVideoFileOutput

Check if a file is open.

Specified by:

isOpen in interface IVideoFileOutput

Returns:

True if a file is open

close

public void close()
           throws IOException

Description copied from interface: IVideoFileOutput

Close the file.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IVideoFileOutput

Throws:

IOException - if an error occurs while closing the file

addVideoFrame

public void addVideoFrame(VideoFrame frame)
                   throws IOException

Description copied from interface: IVideoFileOutput

Append a VideoFrame to the file.

Specified by:

addVideoFrame in interface IVideoFileOutput

Parameters:

frame - The video frame to add

Throws:

IOException - if the file could not be written

addMetadataFrame

public void addMetadataFrame(MetadataFrame frame)
                      throws IOException

Description copied from interface: IVideoFileOutput

Append a MetadataFrame to the file.

Specified by:

addMetadataFrame in interface IVideoFileOutput

Parameters:

frame - The metadata frame to add

Throws:

IOException - if the file could not be written