au.edu.jcu.v4l4j

Class ResolutionInfo

java.lang.Object

au.edu.jcu.v4l4j.ResolutionInfo

public class ResolutionInfo
extends Object

This class encapsulates information about the supported capture resolutions and frame intervals for a given ImageFormat. The first step is to determine how the supported resolutions are expressed by calling getType(). This method returns either:

• ResolutionInfo.Type.UNSUPPORTED: no resolution information can be obtained from the driver. Calling any methods (except getType()) will throw a UnsupportedMethod exception.
• ResolutionInfo.Type.DISCRETE: supported resolutions and frame intervals are returned as a list of ResolutionInfo.DiscreteResolution objects, which encapsulate the width and height for this resolution as well as supported frame intervals. Calling getDiscreteResolutions() returns this list.
• ResolutionInfo.Type.STEPWISE: supported width and height values can be anywhere within a given minimum and maximum using a step value. These values, along with information on supported frame intervals are encapsulated in a ResolutionInfo.StepwiseResolution object which is retrieved by calling getStepwiseResolution().

ResolutionInfo.StepwiseResolution and ResolutionInfo.DiscreteResolution objects provide information on supported capture resolutions and frame intervals for a given image format.
ResolutionInfo objects are not instantiated directly. Instead, each ImageFormat carries a reference to a ResolutionInfo object, describing the supported resolutions for this format. A list of supported image formats is obtained by calling DeviceInfo.getFormatList() on a VideoDevice. See the ImageFormatList documentation for more information.

Author:

gilles

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResolutionInfo.DiscreteResolution This class represents a possible resolution supported by a video device.
static class	ResolutionInfo.StepwiseResolution This class encapsulates information about supported capture resolutions for a video device.
static class	ResolutionInfo.Type The Type enumeration defines how the supported resolutions are expressed.

Method Summary

Modifier and Type	Method and Description
List<ResolutionInfo.DiscreteResolution>	getDiscreteResolutions() This method returns a list of ResolutionInfo.DiscreteResolutions, or throws a UnsupportedMethod exception if this resolution info object is not of type ResolutionInfo.Type.DISCRETE.
ResolutionInfo.StepwiseResolution	getStepwiseResolution() This method returns a ResolutionInfo.StepwiseResolution object, or throws a UnsupportedMethod exception if this resolution info object is not of type ResolutionInfo.Type.STEPWISE.
ResolutionInfo.Type	getType() This method returns the resolution information type.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getType

public ResolutionInfo.Type getType()

This method returns the resolution information type. See ResolutionInfo.Type enumeration.

Returns:

the resolution information type. See ResolutionInfo.Type.

getDiscreteResolutions

public List<ResolutionInfo.DiscreteResolution> getDiscreteResolutions()
                                                               throws UnsupportedMethod

This method returns a list of ResolutionInfo.DiscreteResolutions, or throws a UnsupportedMethod exception if this resolution info object is not of type ResolutionInfo.Type.DISCRETE.

Returns:

a list of ResolutionInfo.DiscreteResolutions

Throws:

UnsupportedMethod - if this resolution info object is not of type ResolutionInfo.Type.DISCRETE.

getStepwiseResolution

public ResolutionInfo.StepwiseResolution getStepwiseResolution()
                                                        throws UnsupportedMethod

This method returns a ResolutionInfo.StepwiseResolution object, or throws a UnsupportedMethod exception if this resolution info object is not of type ResolutionInfo.Type.STEPWISE.

Returns:

a ResolutionInfo.StepwiseResolution object

Throws:

UnsupportedMethod - if this resolution info object is not of type ResolutionInfo.Type.STEPWISE.

toString

public String toString()

Overrides:

toString in class Object