DeviceStateSensorOrientationMap
class DeviceStateSensorOrientationMap
kotlin.Any | |
↳ | android.hardware.camera2.params.DeviceStateSensorOrientationMap |
Immutable class that maps the device fold state to sensor orientation.
Some logical
cameras on foldables can include physical sensors with different sensor orientation values. As a result, the values of the logical camera device can potentially change depending on the device fold state.
The device fold state to sensor orientation map will contain information about the respective logical camera sensor orientation given a device state. Clients can query the mapping for all possible supported folded states.
Summary
Nested classes | |
---|---|
Builds a DeviceStateSensorOrientationMap object. |
Constants | |
---|---|
static Long |
The device is folded. |
static Long |
The device is in its normal physical configuration. |
Public methods | |
---|---|
Boolean |
Check if this DeviceStateSensorOrientationMap is equal to another DeviceStateSensorOrientationMap. |
Int |
getSensorOrientation(deviceState: Long) Return the logical camera sensor orientation given a specific device fold state. |
Int |
hashCode() Returns a hash code value for the object. |
Constants
FOLDED
static val FOLDED: Long
The device is folded. If not set, the device is unfolded or does not support folding. The exact point when this status change happens during the folding operation is device-specific.
Value: 4L
NORMAL
static val NORMAL: Long
The device is in its normal physical configuration. This is the default if the device does not support multiple different states.
Value: 0L
Public methods
equals
fun equals(other: Any?): Boolean
Check if this DeviceStateSensorOrientationMap is equal to another DeviceStateSensorOrientationMap.
Two device state orientation maps are equal if and only if all of their elements are equal
.
Parameters | |
---|---|
obj |
the reference object with which to compare. |
Return | |
---|---|
Boolean |
true if the objects were equal, false otherwise |
getSensorOrientation
fun getSensorOrientation(deviceState: Long): Int
Return the logical camera sensor orientation given a specific device fold state.
Parameters | |
---|---|
deviceState |
Long: Device fold state Value is android.hardware.camera2.params.DeviceStateSensorOrientationMap#NORMAL , or android.hardware.camera2.params.DeviceStateSensorOrientationMap#FOLDED |
Return | |
---|---|
Int |
Valid android.hardware.camera2.CameraCharacteristics#SENSOR_ORIENTATION for any supported device fold state |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the given device state is invalid |
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. |