au.edu.jcu.v4l4j

Class FrameInterval

java.lang.Object

au.edu.jcu.v4l4j.FrameInterval

public class FrameInterval
extends Object

This class encapsulates information about supported frame intervals for a given image format and resolution. A frame interval represents the amount of time elapsed between two captured frames. It is a floating-point number (in seconds) given as a numerator and denominator. Given a frame interval 'fi', the corresponding frame rate 'fr' is 'fr = 1 / fi'. A frame interval object is not directly instantiated. Instead, it can be obtained through either a ResolutionInfo.DiscreteResolution object, a ResolutionInfo.StepwiseResolution object or by calling DeviceInfo.listIntervals(ImageFormat, int, int).

Author:

gilles

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FrameInterval.DiscreteInterval This class encapsulates information about a discrete frame interval, expressed as a numerator and denominator.
static class	FrameInterval.StepwiseInterval A continuous frame interval is a bounded frame interval.
static class	FrameInterval.Type

Method Summary

Modifier and Type	Method and Description
List<FrameInterval.DiscreteInterval>	getDiscreteIntervals() This method returns a list of FrameInterval.DiscreteIntervals, or throws a UnsupportedMethod exception if this frame interval object is not of type FrameInterval.Type.DISCRETE.
FrameInterval.StepwiseInterval	getStepwiseInterval() This method returns a FrameInterval.StepwiseInterval object, or throws a UnsupportedMethod exception if this frame interval object is not of type FrameInterval.Type.STEPWISE.
FrameInterval.Type	getType() This method returns the FrameInterval.Type of this frame interval object.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getType

public FrameInterval.Type getType()

This method returns the FrameInterval.Type of this frame interval object.

Returns:

the FrameInterval.Type of this frame interval object.

getDiscreteIntervals

public List<FrameInterval.DiscreteInterval> getDiscreteIntervals()

This method returns a list of FrameInterval.DiscreteIntervals, or throws a UnsupportedMethod exception if this frame interval object is not of type FrameInterval.Type.DISCRETE.

Returns:

a list of FrameInterval.DiscreteIntervals

Throws:

UnsupportedMethod - if this frame interval object is not of type FrameInterval.Type.DISCRETE.

getStepwiseInterval

public FrameInterval.StepwiseInterval getStepwiseInterval()

This method returns a FrameInterval.StepwiseInterval object, or throws a UnsupportedMethod exception if this frame interval object is not of type FrameInterval.Type.STEPWISE.

Returns:

a FrameInterval.StepwiseInterval object

Throws:

UnsupportedMethod - if this frame interval object is not of type FrameInterval.Type.STEPWISE.

toString

public String toString()

Overrides:

toString in class Object