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

# DlTdoaRangingParams

*** ** * ** ***

```
class DlTdoaRangingParams : Parcelable
```

|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||
| ↳ | [android.ranging.uwb.DlTdoaRangingParams](https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#) |

Class to represent UWB Downlink TDoA ranging parameters.

## Summary

| Nested classes ||
|---|---|
|   | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams.Builder` Builder for `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#`. |

| Constants ||
|---|---|
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#MEASUREMENT_VERSION_1:kotlin.Int` DL-TDoA Ranging Measurement version 1 |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#MEASUREMENT_VERSION_2:kotlin.Int` DL-TDoA Ranging Measurement version 2 |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#MEASUREMENT_VERSION_UNKNOWN:kotlin.Int` DL-TDoA Ranging Measurement version unknown |

| Inherited constants ||
|---|---|
| From class `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#` |---|---| | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int` Descriptor bit used with `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. <br /> | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int` Flag for use with `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.Int)`: 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)`". Some implementations may want to release resources at this point. <br /> | ||

| Public methods ||
|---|---|
| static [DlTdoaRangingParams](https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#createFromFiraConfigPacket(kotlin.ByteArray,%20kotlin.ByteArray)(config: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, rangingRoundIndexes: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?)` Creates a `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#` from a FiRa compliant configuration packet. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#describeContents()()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#equals(kotlin.Any)(other: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?)` Indicates whether some other object is "equal to" this one. |
| [UwbComplexChannel](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbComplexChannel) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getComplexChannel()()` Gets the complex channel used for the session. |
| [UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getDeviceAddress()()` Gets the UWB address of the device. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getMeasurementVersion()()` Gets the measurement version. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getRangingIntervalMillis()()` Gets the ranging interval in milliseconds. |
| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getRangingRoundIndexes()()` Gets the active ranging round indexes. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getSessionId()()` Gets the session ID. |
| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getSessionKeyInfo()()` Gets the session key information. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getSlotDuration()()` Gets the slot duration. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#getSlotsPerRangingRound()()` Gets the number of slots per ranging round. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#hashCode()()` Returns a hash code value for the object. |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#toString()()` Returns a string representation of the object. |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#writeToParcel(android.os.Parcel,%20kotlin.Int)(dest: https://developer.android.com/reference/kotlin/android/os/Parcel.html#, flags: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Flatten this object in to a Parcel. |

| Properties ||
|---|---|
| static [Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[DlTdoaRangingParams](https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#)!\> | `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#CREATOR:android.os.Parcelable.Creator` <br /> |

## Constants

### MEASUREMENT_VERSION_1

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

```
static val MEASUREMENT_VERSION_1: Int
```

DL-TDoA Ranging Measurement version 1

    Value: 1

### MEASUREMENT_VERSION_2

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

```
static val MEASUREMENT_VERSION_2: Int
```

DL-TDoA Ranging Measurement version 2

    Value: 2

### MEASUREMENT_VERSION_UNKNOWN

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

```
static val MEASUREMENT_VERSION_UNKNOWN: Int
```

DL-TDoA Ranging Measurement version unknown

    Value: 2147483647

## Public methods

### createFromFiraConfigPacket

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

```
static fun createFromFiraConfigPacket(
    config: ByteArray, 
    rangingRoundIndexes: ByteArray?
): DlTdoaRangingParams
```

Creates a `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#` from a FiRa compliant configuration packet.

| Parameters ||
|---|---|
| `config` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html): The byte array containing the FiRa Specific OOB Vendor Specific Element (VSE) for BLE or WiFi. This value cannot be `null`. |
| `rangingRoundIndexes` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)?: The active ranging round indexes. If `null`, the indexes may be extracted from the WiFi Time Sync sub-element in `config` if present; otherwise, the default value from `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams.Builder` is used. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#` | A `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#` instance. This value cannot be `null`. |

| Exceptions ||
|---|---|
| `java.lang.IllegalArgumentException` | if the configuration packet is malformed or missing mandatory fields. |

**See Also**

### describeContents

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

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

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | 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/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int` |

### equals

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

```
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 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.

| Parameters ||
|---|---|
| `obj` | the reference object with which to compare. |

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` if this object is the same as the obj argument; `false` otherwise. |

### getComplexChannel

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

```
fun getComplexChannel(): UwbComplexChannel
```

Gets the complex channel used for the session.

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

### getDeviceAddress

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

```
fun getDeviceAddress(): UwbAddress
```

Gets the UWB address of the device.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress` | The `https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress` of the device. This value cannot be `null`. |

### getMeasurementVersion

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

```
fun getMeasurementVersion(): Int
```

Gets the measurement version.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The measurement version. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#MEASUREMENT_VERSION_1:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#MEASUREMENT_VERSION_2:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/ranging/uwb/DlTdoaRangingParams#MEASUREMENT_VERSION_UNKNOWN:kotlin.Int` |

### getRangingIntervalMillis

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

```
fun getRangingIntervalMillis(): Int
```

Gets the ranging interval in milliseconds.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The ranging interval in milliseconds. |

### getRangingRoundIndexes

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

```
fun getRangingRoundIndexes(): ByteArray?
```

Gets the active ranging round indexes.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | This value may be `null`. |

### getSessionId

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

```
fun getSessionId(): Int
```

Gets the session ID.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The session ID as an integer. |

### getSessionKeyInfo

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

```
fun getSessionKeyInfo(): ByteArray?
```

Gets the session key information.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | A byte array containing session key info, or null if not available. |

### getSlotDuration

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

```
fun getSlotDuration(): Int
```

Gets the slot duration.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The slot duration. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbRangingParams#DURATION_1_MS:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbRangingParams#DURATION_2_MS:kotlin.Int` |

### getSlotsPerRangingRound

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

```
fun getSlotsPerRangingRound(): Int
```

Gets the number of slots per ranging round.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | The number of slots per ranging round. |

### hashCode

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

```
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 `https://developer.android.com/reference/kotlin/java/util/HashMap.html#`.

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/kotlin/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.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/kotlin/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.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | a hash code value for this object. |

### toString

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

```
fun toString(): String
```

Returns a string representation of the object.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | a string representation of the object. |

### writeToParcel

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

```
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit
```

Flatten this object in to a Parcel.

| Parameters ||
|---|---|
| `dest` | [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#): This value cannot be `null`. |
| `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int` |

## Properties

### CREATOR

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

```
static val CREATOR: Parcelable.Creator<DlTdoaRangingParams!>
```