UwbRangingParams
class UwbRangingParams : Parcelable
| kotlin.Any | |
| ↳ | android.ranging.uwb.UwbRangingParams |
UwbRangingParams encapsulates the parameters required for a UWB ranging session.
Summary
| Nested classes | |
|---|---|
|
Builder class for creating instances of |
|
| Constants | |
|---|---|
| static Int |
FiRa-defined multicast |
| static Int |
Same as |
| static Int |
Same as |
| static Int |
Same as |
| static Int |
Same as |
| static Int |
FiRa-defined unicast |
| static Int |
1 millisecond slot duration |
| static Int |
2 millisecond slot duration |
| static Int |
Sub session id not applicable. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| UwbComplexChannel |
Gets the complex channel information for this session. |
| Int |
Gets the configuration ID associated with this session. |
| UwbAddress |
Gets the UWB address of the device. |
| UwbAddress |
Returns the UwbAddress of the peer device. |
| Int |
Returns the update rate for ranging operations. |
| Int |
Gets the session ID associated with this ranging session. |
| ByteArray? |
Gets session key information, if available. |
| Int |
Returns slot duration of the session. |
| Int |
Gets the sub-session ID if applicable for the session. |
| ByteArray? |
Gets sub-session key information, if available. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<UwbRangingParams!> | |
Constants
CONFIG_MULTICAST_DS_TWR
static val CONFIG_MULTICAST_DS_TWR: Int
FiRa-defined multicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (200ms), Infrequent (600ms)
Value: 2CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR
static val CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR: Int
Same as CONFIG_UNICAST_DS_TWR, except P-STS individual controlee key mode is enabled.
Value: 5CONFIG_PROVISIONED_MULTICAST_DS_TWR
static val CONFIG_PROVISIONED_MULTICAST_DS_TWR: Int
Same as CONFIG_MULTICAST_DS_TWR, except P-STS security mode is enabled.
Value: 4CONFIG_PROVISIONED_UNICAST_DS_TWR
static val CONFIG_PROVISIONED_UNICAST_DS_TWR: Int
Same as CONFIG_UNICAST_DS_TWR, except P-STS security mode is enabled.
Value: 3CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST
static val CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST: Int
Same as CONFIG_ID_3, except fast ranging interval is 96 milliseconds.
Value: 6CONFIG_UNICAST_DS_TWR
static val CONFIG_UNICAST_DS_TWR: Int
FiRa-defined unicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (240ms), Infrequent (600ms)
Value: 1DURATION_1_MS
static val DURATION_1_MS: Int
1 millisecond slot duration
Value: 1DURATION_2_MS
static val DURATION_2_MS: Int
2 millisecond slot duration
Value: 2SUB_SESSION_UNDEFINED
static val SUB_SESSION_UNDEFINED: Int
Sub session id not applicable.
Value: -1Public methods
describeContents
fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getComplexChannel
fun getComplexChannel(): UwbComplexChannel
Gets the complex channel information for this session.
| Return | |
|---|---|
UwbComplexChannel |
A UwbComplexChannel object containing channel and preamble index. This value cannot be null. |
getConfigId
fun getConfigId(): Int
Gets the configuration ID associated with this session.
| Return | |
|---|---|
Int |
The configuration ID as an integer. |
getDeviceAddress
fun getDeviceAddress(): UwbAddress
Gets the UWB address of the device.
| Return | |
|---|---|
UwbAddress |
The UwbAddress of the device. This value cannot be null. |
getPeerAddress
fun getPeerAddress(): UwbAddress
Returns the UwbAddress of the peer device.
| Return | |
|---|---|
UwbAddress |
A UwbAddress corresponding to the peer device to range with. This value cannot be null. |
getRangingUpdateRate
fun getRangingUpdateRate(): Int
Returns the update rate for ranging operations.
| Return | |
|---|---|
Int |
The ranging update rate. |
getSessionId
fun getSessionId(): Int
Gets the session ID associated with this ranging session.
| Return | |
|---|---|
Int |
The session ID as an integer. |
getSessionKeyInfo
fun getSessionKeyInfo(): ByteArray?
Gets session key information, if available.
| Return | |
|---|---|
ByteArray? |
A byte array containing session key info, or null if not available. |
getSlotDuration
fun getSlotDuration(): Int
Returns slot duration of the session.
| Return | |
|---|---|
Int |
the slot duration. Value is one of the following: |
getSubSessionId
fun getSubSessionId(): Int
Gets the sub-session ID if applicable for the session.
| Return | |
|---|---|
Int |
The sub-session ID as an integer or SUB_SESSION_UNDEFINED if not applicable. |
getSubSessionKeyInfo
fun getSubSessionKeyInfo(): ByteArray?
Gets sub-session key information, if available.
| Return | |
|---|---|
ByteArray? |
A byte array containing sub-session key info, or null if not available. |
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|