boofcv.io.image

Interface SimpleImageSequence<T extends ImageBase>

All Known Implementing Classes:

BufferedFileImageSequence, ImageStreamSequence, JpegByteImageSequence, LoadFileImageSequence, MjpegStreamSequence

public interface SimpleImageSequence<T extends ImageBase>

Simplified interface for reading in a sequence of images. This interface hides the complexities of reading from different file formats and from live video streams.

Method Summary

Modifier and Type	Method and Description
void	close() Call when done reading the image sequence.
int	getFrameNumber() Returns the number of the current frame in the sequence.
<InternalImage> InternalImage	getGuiImage() Returns the image in the original format that it was read in as.
ImageType<T>	getImageType() Returns the type of class used to store the output image
int	getNextHeight() Returns the height of the next image
int	getNextWidth() Returns the width of the next image
boolean	hasNext() If a new image is available.
T	next() Returns the next image available in the sequence.
void	reset() Start reading the sequence from the start
void	setLoop(boolean loop) Sets if the video should loop or not

Method Detail

getNextWidth

int getNextWidth()

Returns the width of the next image

getNextHeight

int getNextHeight()

Returns the height of the next image

hasNext

boolean hasNext()

If a new image is available.

Returns:

true if a new image is available.

next

T next()

Returns the next image available in the sequence.

Returns:

Next image in the sequence.

getGuiImage

<InternalImage> InternalImage getGuiImage()

Returns the image in the original format that it was read in as. When dealing with swing or any standard Java SE environment this will almost always be BufferedImage. The type has been abstracted out to provide better Android support.

Returns:

close

void close()

Call when done reading the image sequence.

getFrameNumber

int getFrameNumber()

Returns the number of the current frame in the sequence.

Returns:

Frame ID number.

setLoop

void setLoop(boolean loop)

Sets if the video should loop or not

Parameters:

loop - true for looping forever, false for once

getImageType

ImageType<T> getImageType()

Returns the type of class used to store the output image

reset

void reset()

Start reading the sequence from the start