com.github.hoary.javaav

Class CameraFormat

java.lang.Object

com.github.hoary.javaav.CameraFormat

All Implemented Interfaces:

Comparable<CameraFormat>

public class CameraFormat
extends Object
implements Comparable<CameraFormat>

CameraFormat represents the image size and frame rate with which a video input device is capturing frames. CameraFormat also implements Comparable to compare the image size with other formats.

Author:

Alex Andres

Constructor Summary

Constructors

Constructor and Description
CameraFormat() Create a new CameraFormat with image size and frame rate equal zero.
CameraFormat(int width, int height, double frameRate) Create a new CameraFormat with specified image size and frame rate.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(CameraFormat o)
double	getFrameRate() Get the frame rate.
int	getHeight() Get the image height.
int	getWidth() Get the image width.
boolean	isValid() Checks whether this format is valid.
void	setFrameRate(double frameRate) Set new frame rate.
void	setHeight(int height) Set new image height.
void	setWidth(int width) Set new image width.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CameraFormat

public CameraFormat()

Create a new CameraFormat with image size and frame rate equal zero.

CameraFormat

public CameraFormat(int width,
            int height,
            double frameRate)

Create a new CameraFormat with specified image size and frame rate.

Parameters:

width - image width.

height - image height.

frameRate - capturing frame rate.

Method Detail

getHeight

public int getHeight()

Get the image height.

Returns:

image height.

setHeight

public void setHeight(int height)

Set new image height.

Parameters:

height - new image height.

getWidth

public int getWidth()

Get the image width.

Returns:

image width.

setWidth

public void setWidth(int width)

Set new image width.

Parameters:

width - new image width.

getFrameRate

public double getFrameRate()

Get the frame rate.

Returns:

frame rate.

setFrameRate

public void setFrameRate(double frameRate)

Set new frame rate.

Parameters:

frameRate - new frame rate.

isValid

public boolean isValid()

Checks whether this format is valid. A CameraFormat is valid only if the image width and height and frame rate are greater zero.

Returns:

true if this format is valid, false otherwise.

compareTo

public int compareTo(CameraFormat o)

Specified by:

compareTo in interface Comparable<CameraFormat>

toString

public String toString()

Overrides:

toString in class Object