org.jmisb.api.video

Class VideoStreamOutput

java.lang.Object

org.jmisb.api.video.VideoIO

org.jmisb.api.video.VideoOutput

org.jmisb.api.video.VideoStreamOutput

All Implemented Interfaces:

AutoCloseable, IVideoStreamOutput

public class VideoStreamOutput
extends VideoOutput
implements IVideoStreamOutput

Manages an outgoing video stream.

Field Summary

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

METADATA_AU_HEADER_LEN, options

Constructor Summary

Constructors

Constructor and Description
VideoStreamOutput(VideoOutputOptions options) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Close the stream.
OutputStatistics	getStatistics() Get output statistics.
boolean	isOpen() Check if the stream is open.
void	open(String url) Open a stream for writing.
void	queueMetadataFrame(MetadataFrame metadataFrame) Queue a MetadataFrame for output.
void	queueVideoFrame(VideoFrame videoFrame) Queue a VideoFrame for output.

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoStreamOutput

public VideoStreamOutput(VideoOutputOptions options)

Constructor.

Parameters:

options - Options for video output

Method Detail

open

public void open(String url)
          throws IOException

Description copied from interface: IVideoStreamOutput

Open a stream for writing.

The required syntax for the URL is udp://hostname:port.

Specified by:

open in interface IVideoStreamOutput

Parameters:

url - The URL to open

Throws:

IOException - if the stream could not be opened

isOpen

public boolean isOpen()

Description copied from interface: IVideoStreamOutput

Check if the stream is open.

Specified by:

isOpen in interface IVideoStreamOutput

Returns:

True if the stream is open

close

public void close()

Description copied from interface: IVideoStreamOutput

Close the stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IVideoStreamOutput

queueVideoFrame

public void queueVideoFrame(VideoFrame videoFrame)

Description copied from interface: IVideoStreamOutput

Queue a VideoFrame for output.

Specified by:

queueVideoFrame in interface IVideoStreamOutput

Parameters:

videoFrame - The video frame to send

queueMetadataFrame

public void queueMetadataFrame(MetadataFrame metadataFrame)
                        throws IOException

Description copied from interface: IVideoStreamOutput

Queue a MetadataFrame for output.

Note that metadata frames will be buffered internally based pts values. Queued metadata frames will be sent once a video frame with greater or equal pts has been sent.

Specified by:

queueMetadataFrame in interface IVideoStreamOutput

Parameters:

metadataFrame - The metadata frame to send

Throws:

IOException - if the stream could not be written

getStatistics

public OutputStatistics getStatistics()

Description copied from interface: IVideoStreamOutput

Get output statistics.

Specified by:

getStatistics in interface IVideoStreamOutput

Returns:

The output statistics