Stay organized with collections
Save and categorize content based on your preferences.
DeviceStateSensorOrientationMap
class 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 |
Return the logical camera sensor orientation given a specific device fold state.
|
| Int |
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.
| 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 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.
| Return |
Int |
a hash code value for this object. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# DeviceStateSensorOrientationMap\n\nAdded in [API level 32](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nDeviceStateSensorOrientationMap\n===============================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/hardware/camera2/params/DeviceStateSensorOrientationMap \"View this page in Java\") \n\n```\nclass DeviceStateSensorOrientationMap\n```\n\n|---|----------------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.hardware.camera2.params.DeviceStateSensorOrientationMap](#) |\n\nImmutable class that maps the device fold state to sensor orientation.\n\nSome [logical](../CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_LOGICAL_MULTI_CAMERA:kotlin.Int) 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.\n\nThe 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.\n\nSummary\n-------\n\n| Nested classes ||\n|---|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [Builder](/reference/kotlin/android/hardware/camera2/params/DeviceStateSensorOrientationMap.Builder) Builds a DeviceStateSensorOrientationMap object. |\n\n| Constants ||\n|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|\n| static [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [FOLDED](#FOLDED:kotlin.Long) The device is folded. |\n| static [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [NORMAL](#NORMAL:kotlin.Long) The device is in its normal physical configuration. |\n\n| Public methods ||\n|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Check if this DeviceStateSensorOrientationMap is equal to another DeviceStateSensorOrientationMap. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getSensorOrientation](#getSensorOrientation(kotlin.Long))`(`deviceState:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` Return the logical camera sensor orientation given a specific device fold state. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` Returns a hash code value for the object. |\n\nConstants\n---------\n\n### FOLDED\n\nAdded in [API level 32](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val FOLDED: Long\n```\n\nThe 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. \n\n Value: 4L\n\n### NORMAL\n\nAdded in [API level 32](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val NORMAL: Long\n```\n\nThe device is in its normal physical configuration. This is the default if the device does not support multiple different states. \n\n Value: 0L\n\nPublic methods\n--------------\n\n### equals\n\nAdded in [API level 32](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nCheck if this DeviceStateSensorOrientationMap is equal to another DeviceStateSensorOrientationMap.\n\nTwo device state orientation maps are equal if and only if all of their elements are [equal](../../../../java/lang/Object.html#equals(kotlin.Any)).\n\n| Parameters ||\n|-------|---------------------------------------------|\n| `obj` | the reference object with which to compare. |\n\n| Return ||\n|------------------------------------------------------------------------------------|-----------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if the objects were equal, `false` otherwise |\n\n### getSensorOrientation\n\nAdded in [API level 32](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getSensorOrientation(deviceState: Long): Int\n```\n\nReturn the logical camera sensor orientation given a specific device fold state.\n\n| Parameters ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deviceState` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html): Device fold state Value is [android.hardware.camera2.params.DeviceStateSensorOrientationMap#NORMAL](#NORMAL:kotlin.Long), or [android.hardware.camera2.params.DeviceStateSensorOrientationMap#FOLDED](#FOLDED:kotlin.Long) |\n\n| Return ||\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | Valid [android.hardware.camera2.CameraCharacteristics#SENSOR_ORIENTATION](../CameraCharacteristics.html#SENSOR_ORIENTATION:android.hardware.camera2.CameraCharacteristics.Key) for any supported device fold state |\n\n| Exceptions ||\n|--------------------------------------|--------------------------------------|\n| `java.lang.IllegalArgumentException` | if the given device state is invalid |\n\n### hashCode\n\nAdded in [API level 32](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\nReturns 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](../../../../java/util/HashMap.html#).\n\nThe general contract of `hashCode` is:\n\n- 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.\n- If two objects are equal according to the [equals](../../../../java/lang/Object.html#equals(kotlin.Any)) method, then calling the `hashCode` method on each of the two objects must produce the same integer result.\n- It is *not* required that if two objects are unequal according to the [equals](../../../../java/lang/Object.html#equals(kotlin.Any)) 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.\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |"]]
