Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#nestedclasses) \| [Constants](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#constants) \| [Inherited Constants](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#inhconstants) \| [Fields](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#lfields) \| [Methods](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#inhmethods)

# UwbRangingParams

*** ** * ** ***

` public final class UwbRangingParams `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.ranging.uwb.UwbRangingParams |

<br />

*** ** * ** ***

UwbRangingParams encapsulates the parameters required for a UWB ranging session.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams.Builder` Builder class for creating instances of `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams` |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#CONFIG_MULTICAST_DS_TWR` FiRa-defined multicast `STATIC STS DS-TWR` ranging, deferred mode, ranging interval Fast (120ms), Normal (200ms), Infrequent (600ms) |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR` Same as `CONFIG_UNICAST_DS_TWR`, except P-STS individual controlee key mode is enabled. |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#CONFIG_PROVISIONED_MULTICAST_DS_TWR` Same as `CONFIG_MULTICAST_DS_TWR`, except P-STS security mode is enabled. |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#CONFIG_PROVISIONED_UNICAST_DS_TWR` Same as `CONFIG_UNICAST_DS_TWR`, except P-STS security mode is enabled. |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST` Same as `CONFIG_ID_3`, except fast ranging interval is 96 milliseconds. |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#CONFIG_UNICAST_DS_TWR` FiRa-defined unicast `STATIC STS DS-TWR` ranging, deferred mode, ranging interval Fast (120ms), Normal (240ms), Infrequent (600ms) |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#DURATION_1_MS` 1 millisecond slot duration |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#DURATION_2_MS` 2 millisecond slot duration |
| `int` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#SUB_SESSION_UNDEFINED` Sub session id not applicable. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams>` | `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbComplexChannel` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getComplexChannel()() ` Gets the complex channel information for this session. |
| ` int` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getConfigId()() ` Gets the configuration ID associated with this session. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbAddress` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getDeviceAddress()() ` Gets the UWB address of the device. |
| ` https://developer.android.com/reference/android/ranging/uwb/UwbAddress` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getPeerAddress()() ` Returns the UwbAddress of the peer device. |
| ` int` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getRangingUpdateRate()() ` Returns the update rate for ranging operations. |
| ` int` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getSessionId()() ` Gets the session ID associated with this ranging session. |
| ` byte[]` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getSessionKeyInfo()() ` Gets session key information, if available. |
| ` int` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getSlotDuration()() ` Returns slot duration of the session. |
| ` int` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getSubSessionId()() ` Gets the sub-session ID if applicable for the session. |
| ` byte[]` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#getSubSessionKeyInfo()() ` Gets sub-session key information, if available. |
| ` int` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### CONFIG_MULTICAST_DS_TWR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int CONFIG_MULTICAST_DS_TWR
```

FiRa-defined multicast `STATIC STS DS-TWR` ranging, deferred mode, ranging interval Fast (120ms), Normal (200ms), Infrequent (600ms)

<br />

Constant Value: 2 (0x00000002)

### CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR
```

Same as `CONFIG_UNICAST_DS_TWR`, except P-STS individual controlee key mode is enabled.

<br />

Constant Value: 5 (0x00000005)

### CONFIG_PROVISIONED_MULTICAST_DS_TWR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int CONFIG_PROVISIONED_MULTICAST_DS_TWR
```

Same as `CONFIG_MULTICAST_DS_TWR`, except P-STS security mode is enabled.

<br />

Constant Value: 4 (0x00000004)

### CONFIG_PROVISIONED_UNICAST_DS_TWR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int CONFIG_PROVISIONED_UNICAST_DS_TWR
```

Same as `CONFIG_UNICAST_DS_TWR`, except P-STS security mode is enabled.

<br />

Constant Value: 3 (0x00000003)

### CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST
```

Same as `CONFIG_ID_3`, except fast ranging interval is 96 milliseconds.

<br />

Constant Value: 6 (0x00000006)

### CONFIG_UNICAST_DS_TWR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int CONFIG_UNICAST_DS_TWR
```

FiRa-defined unicast `STATIC STS DS-TWR` ranging, deferred mode, ranging interval Fast (120ms), Normal (240ms), Infrequent (600ms)

<br />

Constant Value: 1 (0x00000001)

### DURATION_1_MS

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int DURATION_1_MS
```

1 millisecond slot duration

<br />

Constant Value: 1 (0x00000001)

### DURATION_2_MS

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int DURATION_2_MS
```

2 millisecond slot duration

<br />

Constant Value: 2 (0x00000002)

### SUB_SESSION_UNDEFINED

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SUB_SESSION_UNDEFINED
```

Sub session id not applicable.

<br />

Constant Value: -1 (0xffffffff)

## Fields

### CREATOR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<UwbRangingParams> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object o)
```

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 return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.

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.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getComplexChannel

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public UwbComplexChannel getComplexChannel ()
```

Gets the complex channel information for this session.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/uwb/UwbComplexChannel` | A `https://developer.android.com/reference/android/ranging/uwb/UwbComplexChannel` object containing channel and preamble index. This value cannot be `null`. <br /> |

### getConfigId

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getConfigId ()
```

Gets the configuration ID associated with this session.

<br />

| Returns ||
|---|---|
| `int` | The configuration ID as an integer. <br /> |

### getDeviceAddress

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public UwbAddress getDeviceAddress ()
```

Gets the UWB address of the device.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/uwb/UwbAddress` | The `https://developer.android.com/reference/android/ranging/uwb/UwbAddress` of the device. This value cannot be `null`. <br /> |

### getPeerAddress

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public UwbAddress getPeerAddress ()
```

Returns the UwbAddress of the peer device.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/uwb/UwbAddress` | A `https://developer.android.com/reference/android/ranging/uwb/UwbAddress` corresponding to the peer device to range with. This value cannot be `null`. <br /> |

### getRangingUpdateRate

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRangingUpdateRate ()
```

Returns the update rate for ranging operations.

<br />

| Returns ||
|---|---|
| `int` | The ranging update rate. <br /> |

### getSessionId

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSessionId ()
```

Gets the session ID associated with this ranging session.

<br />

| Returns ||
|---|---|
| `int` | The session ID as an integer. <br /> |

### getSessionKeyInfo

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getSessionKeyInfo ()
```

Gets session key information, if available.

<br />

| Returns ||
|---|---|
| `byte[]` | A byte array containing session key info, or null if not available. <br /> |

### getSlotDuration

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSlotDuration ()
```

Returns slot duration of the session.

<br />

| Returns ||
|---|---|
| `int` | the slot duration. Value is one of the following: - `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#DURATION_1_MS` - `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#DURATION_2_MS` |

### getSubSessionId

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSubSessionId ()
```

Gets the sub-session ID if applicable for the session.

<br />

| Returns ||
|---|---|
| `int` | The sub-session ID as an integer or `https://developer.android.com/reference/android/ranging/uwb/UwbRangingParams#SUB_SESSION_UNDEFINED` if not applicable. <br /> |

### getSubSessionKeyInfo

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getSubSessionKeyInfo ()
```

Gets sub-session key information, if available.

<br />

| Returns ||
|---|---|
| `byte[]` | A byte array containing sub-session key info, or null if not available. <br /> |

### hashCode

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### toString

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |