au.edu.jcu.v4l4j

Class ImageFormatList

java.lang.Object

au.edu.jcu.v4l4j.ImageFormatList

public class ImageFormatList
extends Object

ImageFormatList objects group together a list of native ImageFormats capture resolutions and frame intervals supported by a VideoDevice. A native (or raw) format is a format supported and used by the driver. This native format list is obtained by calling getNativeFormats(). Additionally, v4l4j can convert some native formats to RGB24, BGR24, JPEG, YUV420 and YVU420. The getRGBEncodableFormats(), getBGREncodableFormats(), getJPEGEncodableFormats(), getYUVEncodableFormats() & getYVUEncodableFormats() methods returns the subset of native formats that can be converted to these formats. ImageFormatLists are not directly instantiated. Instead, you can get the list of ImageFormats supported by a VideoDevice by calling DeviceInfo.getFormatList() on its associated DeviceInfo.

Author:

gilles

Method Summary

Modifier and Type	Method and Description
ImageFormat	getBGREncodableFormat(int i) This method looks for a native ImageFormat that can be converted to BGR24 by v4l4j given its index, and returns it, or null if not found.
ImageFormat	getBGREncodableFormat(String n) This method looks for a native ImageFormat that can be converted to BGR24 by v4l4j in this list given its name, and returns it, or null if not found.
List<ImageFormat>	getBGREncodableFormats() This method returns a list of native ImageFormats contained in this object, that can be converted to BGR24 by v4l4j.
ImageFormat	getJPEGEncodableFormat(int i) This method looks for a native ImageFormat that can be converted to JPEG by v4l4j given its index, and returns it, or null if not found.
ImageFormat	getJPEGEncodableFormat(String n) This method looks for a native ImageFormat that can be converted to JPEG by v4l4j in this list given its name, and returns it, or null if not found.
List<ImageFormat>	getJPEGEncodableFormats() This method returns a list of native ImageFormats contained in this object, that can be converted to JPEG by v4l4j.
ImageFormat	getNativeFormat(int i) This method looks for a native ImageFormat given its index, and returns it, or null if not found.
ImageFormat	getNativeFormat(String n) This method looks for a native ImageFormat in this list given its name, and returns it, or null if not found.
List<ImageFormat>	getNativeFormats() This method returns the native ImageFormats contained in this list.
ImageFormat	getRGBEncodableFormat(int i) This method looks for a native ImageFormat that can be converted to RGB24 by v4l4j given its index, and returns it, or null if not found.
ImageFormat	getRGBEncodableFormat(String n) This method looks for a native ImageFormat that can be converted to RGB24 by v4l4j in this list given its name, and returns it, or null if not found.
List<ImageFormat>	getRGBEncodableFormats() This method returns a list of native ImageFormats contained in this object, that can be converted to RGB24 by v4l4j.
ImageFormat	getYUVEncodableFormat(int i) This method looks for a native ImageFormat that can be converted to YUV420 by v4l4j given its index, and returns it, or null if not found.
ImageFormat	getYUVEncodableFormat(String n) This method looks for a native ImageFormat that can be converted to YUV420 by v4l4j in this list given its name, and returns it, or null if not found.
List<ImageFormat>	getYUVEncodableFormats() This method returns a list of native ImageFormats contained in this object, that can be converted to YUV420 by v4l4j.
ImageFormat	getYVUEncodableFormat(int i) This method looks for a native ImageFormat that can be converted to YVU420 by v4l4j given its index, and returns it, or null if not found.
ImageFormat	getYVUEncodableFormat(String n) This method looks for a native ImageFormat that can be converted to YVU420 by v4l4j in this list given its name, and returns it, or null if not found.
List<ImageFormat>	getYVUEncodableFormats() This method returns a list of native ImageFormats contained in this object, that can be converted to YVU420 by v4l4j.

Methods inherited from class java.lang.Object

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

Method Detail

getNativeFormats

public List<ImageFormat> getNativeFormats()

This method returns the native ImageFormats contained in this list.

Returns:

the ImageFormats contained in this list

getNativeFormat

public ImageFormat getNativeFormat(String n)

This method looks for a native ImageFormat in this list given its name, and returns it, or null if not found.

Parameters:

n - the name of the ImageFormat.

Returns:

the ImageFormat, or null if not found in the list.

getNativeFormat

public ImageFormat getNativeFormat(int i)

This method looks for a native ImageFormat given its index, and returns it, or null if not found. A list of all known format indexes can be found in V4L4JConstants.IMF_*.

Parameters:

i - the index of the ImageFormat to look up

Returns:

the ImageFormat or null if not found.

getJPEGEncodableFormats

public List<ImageFormat> getJPEGEncodableFormats()

This method returns a list of native ImageFormats contained in this object, that can be converted to JPEG by v4l4j. The list is sorted: image formats better suited for the conversion are listed first.

Returns:

a list of ImageFormats contained in this object, that can be converted to JPEG by v4l4j.

getJPEGEncodableFormat

public ImageFormat getJPEGEncodableFormat(String n)

This method looks for a native ImageFormat that can be converted to JPEG by v4l4j in this list given its name, and returns it, or null if not found.

Parameters:

n - the name of the ImageFormat.

Returns:

the ImageFormat, or null if not found in the list.

getJPEGEncodableFormat

public ImageFormat getJPEGEncodableFormat(int i)

This method looks for a native ImageFormat that can be converted to JPEG by v4l4j given its index, and returns it, or null if not found. A list of all known format indexes can be found in V4L4JConstants.IMF_* .

Parameters:

i - the index of the ImageFormat to look up

Returns:

the ImageFormat or null if not found.

getRGBEncodableFormats

public List<ImageFormat> getRGBEncodableFormats()

This method returns a list of native ImageFormats contained in this object, that can be converted to RGB24 by v4l4j. The list is sorted: image formats better suited for the conversion are listed first.

Returns:

a list of ImageFormats contained in this object, that can be converted to RGB24 by v4l4j.

getRGBEncodableFormat

public ImageFormat getRGBEncodableFormat(String n)

This method looks for a native ImageFormat that can be converted to RGB24 by v4l4j in this list given its name, and returns it, or null if not found.

Parameters:

n - the name of the ImageFormat.

Returns:

the ImageFormat, or null if not found in the list.

getRGBEncodableFormat

public ImageFormat getRGBEncodableFormat(int i)

This method looks for a native ImageFormat that can be converted to RGB24 by v4l4j given its index, and returns it, or null if not found. A list of all known format indexes can be found in V4L4JConstants.IMF_* .

Parameters:

i - the index of the ImageFormat to look up

Returns:

the ImageFormat or null if not found.

getBGREncodableFormats

public List<ImageFormat> getBGREncodableFormats()

This method returns a list of native ImageFormats contained in this object, that can be converted to BGR24 by v4l4j. The list is sorted: image formats better suited for the conversion are listed first.

Returns:

a list of ImageFormats contained in this object, that can be converted to BGR24 by v4l4j.

getBGREncodableFormat

public ImageFormat getBGREncodableFormat(String n)

This method looks for a native ImageFormat that can be converted to BGR24 by v4l4j in this list given its name, and returns it, or null if not found.

Parameters:

n - the name of the ImageFormat.

Returns:

the ImageFormat, or null if not found in the list.

getBGREncodableFormat

public ImageFormat getBGREncodableFormat(int i)

This method looks for a native ImageFormat that can be converted to BGR24 by v4l4j given its index, and returns it, or null if not found. A list of all known format indexes can be found in V4L4JConstants.IMF_* .

Parameters:

i - the index of the ImageFormat to look up

Returns:

the ImageFormat or null if not found.

getYUVEncodableFormats

public List<ImageFormat> getYUVEncodableFormats()

This method returns a list of native ImageFormats contained in this object, that can be converted to YUV420 by v4l4j. The list is sorted: image formats better suited for the conversion are listed first.

Returns:

a list of ImageFormats contained in this object, that can be converted to YUV420 by v4l4j.

getYUVEncodableFormat

public ImageFormat getYUVEncodableFormat(String n)

This method looks for a native ImageFormat that can be converted to YUV420 by v4l4j in this list given its name, and returns it, or null if not found.

Parameters:

n - the name of the ImageFormat.

Returns:

the ImageFormat, or null if not found in the list.

getYUVEncodableFormat

public ImageFormat getYUVEncodableFormat(int i)

This method looks for a native ImageFormat that can be converted to YUV420 by v4l4j given its index, and returns it, or null if not found. A list of all known format indexes can be found in V4L4JConstants.IMF_* .

Parameters:

i - the index of the ImageFormat to look up

Returns:

the ImageFormat or null if not found.

getYVUEncodableFormats

public List<ImageFormat> getYVUEncodableFormats()

This method returns a list of native ImageFormats contained in this object, that can be converted to YVU420 by v4l4j. The list is sorted: image formats better suited for the conversion are listed first.

Returns:

a list of ImageFormats contained in this object, that can be converted to YVU420 by v4l4j.

getYVUEncodableFormat

public ImageFormat getYVUEncodableFormat(String n)

This method looks for a native ImageFormat that can be converted to YVU420 by v4l4j in this list given its name, and returns it, or null if not found.

Parameters:

n - the name of the ImageFormat.

Returns:

the ImageFormat, or null if not found in the list.

getYVUEncodableFormat

public ImageFormat getYVUEncodableFormat(int i)

This method looks for a native ImageFormat that can be converted to YVU420 by v4l4j given its index, and returns it, or null if not found. A list of all known format indexes can be found in V4L4JConstantsV4L4JConstants.IMF_*

Parameters:

i - the index of the ImageFormat to look up

Returns:

the ImageFormat or null if not found.