Capability

public final class Capability
extends Object

java.lang.Object
   ↳ android.hardware.camera2.params.Capability


Immutable class to store the camera capability, its corresponding maximum streaming dimension and zoom range.

Summary

Public constructors

Capability(int mode, Size maxStreamingSize, Range<Float> zoomRatioRange)

Create a new Capability object.

Public methods

boolean equals(Object obj)

Compare two Capability objects to see if they are equal.

Size getMaxStreamingSize()

Return the maximum streaming dimension of this capability.

int getMode()

Return the supported mode for this capability.

Range<Float> getZoomRatioRange()

Return the zoom ratio range of this capability.

int hashCode()

Returns a hash code value for the object.

String toString()

Return the Capability as a string representation "(mode:%d, maxStreamingSize:%d x %d, zoomRatio: %f-%f)".

Inherited methods

Public constructors

Capability

Added in API level 30
public Capability (int mode, 
                Size maxStreamingSize, 
                Range<Float> zoomRatioRange)

Create a new Capability object.

The mode argument can be any integer value. maxStreamingWidth and maxStreamingHeight must be non-negative, while minZoomRatio and maxZoomRatio must be strictly positive.

This constructor is public to allow for easier application testing by creating custom object instances. It's not necessary to construct these objects during normal use of the camera API.

Parameters
mode int: supported mode for a camera capability.

maxStreamingSize Size: The maximum streaming size for this mode This value cannot be null.

zoomRatioRange Range: the minimum/maximum zoom ratio this mode supports This value cannot be null.

Throws
IllegalArgumentException if any of the arguments are not valid

Public methods

equals

Added in API level 30
public boolean equals (Object obj)

Compare two Capability objects to see if they are equal.

Parameters
obj Object: Another Capability object

Returns
boolean true if the mode, max size and zoom ratio range are equal, false otherwise

getMaxStreamingSize

Added in API level 30
public Size getMaxStreamingSize ()

Return the maximum streaming dimension of this capability.

Returns
Size a new Size with non-negative width and height This value cannot be null.

getMode

Added in API level 30
public int getMode ()

Return the supported mode for this capability.

Returns
int One of supported modes for the capability. For example, for available extended scene modes, this will be one of CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_DISABLED, CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_STILL_CAPTURE, and CameraMetadata#CONTROL_EXTENDED_SCENE_MODE_BOKEH_CONTINUOUS.

getZoomRatioRange

Added in API level 30
public Range<Float> getZoomRatioRange ()

Return the zoom ratio range of this capability.

Returns
Range<Float> The supported zoom ratio range supported by this capability This value cannot be null.

hashCode

Added in API level 30
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

Added in API level 30
public String toString ()

Return the Capability as a string representation "(mode:%d, maxStreamingSize:%d x %d, zoomRatio: %f-%f)".

Returns
String string representation of the capability and max streaming size.