Capability
class Capability
kotlin.Any | |
↳ | android.hardware.camera2.params.Capability |
Immutable class to store the camera capability, its corresponding maximum streaming dimension and zoom range.
Summary
Public constructors | |
---|---|
Capability(mode: Int, maxStreamingSize: Size, zoomRatioRange: Range<Float!>) Create a new Capability object. |
Public methods | |
---|---|
Boolean |
Compare two Capability objects to see if they are equal. |
Size |
Return the maximum streaming dimension of this capability. |
Int |
getMode() Return the supported mode for this capability. |
Range<Float!> |
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 |
Public constructors
Capability
Capability(
mode: Int,
maxStreamingSize: Size,
zoomRatioRange: Range<Float!>)
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<Float!>: the minimum/maximum zoom ratio this mode supports This value cannot be null . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if any of the arguments are not valid |
Public methods
equals
fun equals(other: Any?): Boolean
Compare two Capability objects to see if they are equal.
Parameters | |
---|---|
obj |
Another Capability object |
Return | |
---|---|
Boolean |
true if the mode, max size and zoom ratio range are equal, false otherwise |
getMaxStreamingSize
fun getMaxStreamingSize(): Size
Return the maximum streaming dimension of this capability.
Return | |
---|---|
Size |
a new Size with non-negative width and height This value cannot be null . |
getMode
fun getMode(): Int
Return the supported mode for this capability.
Return | |
---|---|
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
fun getZoomRatioRange(): Range<Float!>
Return the zoom ratio range of this capability.
Return | |
---|---|
Range<Float!> |
The supported zoom ratio range supported by this capability This value cannot be null . |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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 inequals
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 thehashCode
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 thehashCode
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.
Return | |
---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Return the Capability as a string representation "(mode:%d, maxStreamingSize:%d x %d, zoomRatio: %f-%f)"
.
Return | |
---|---|
String |
string representation of the capability and max streaming size. |