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/RangingPreference#nestedclasses) \| [Constants](https://developer.android.com/reference/android/ranging/RangingPreference#constants) \| [Inherited Constants](https://developer.android.com/reference/android/ranging/RangingPreference#inhconstants) \| [Fields](https://developer.android.com/reference/android/ranging/RangingPreference#lfields) \| [Methods](https://developer.android.com/reference/android/ranging/RangingPreference#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/ranging/RangingPreference#inhmethods)

# RangingPreference

*** ** * ** ***

` public final class RangingPreference `   
` 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.RangingPreference |

<br />

*** ** * ** ***

Represents the configuration preferences for a ranging session.

The `RangingPreference` class allows users to specify various parameters required for a ranging session, including ranging parameters, sensor fusion settings, and data notification configurations. It provides a `https://developer.android.com/reference/android/ranging/RangingPreference.Builder` to construct an instance with custom configurations.

<br />

## Summary

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

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_DT_TAG` The device that is a DT tag. |
| `int` | `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_INITIATOR` The device that initiates the session. |
| `int` | `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_RESPONDER` The device that responds to a session. |

### 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/RangingPreference>` | `https://developer.android.com/reference/android/ranging/RangingPreference#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/ranging/RangingPreference#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/ranging/RangingPreference#getDeviceRole()() ` Returns the device role. |
| ` https://developer.android.com/reference/android/ranging/RangingConfig` | ` https://developer.android.com/reference/android/ranging/RangingPreference#getRangingParams()() ` Returns the ranging parameters associated with this preference. |
| ` https://developer.android.com/reference/android/ranging/SessionConfig` | ` https://developer.android.com/reference/android/ranging/RangingPreference#getSessionConfig()() ` Returns the ranging session configuration params. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/ranging/RangingPreference#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/ranging/RangingPreference#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

### DEVICE_ROLE_DT_TAG

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

```
public static final int DEVICE_ROLE_DT_TAG
```

The device that is a DT tag.

This is only allowed in the RAW API usage.

<br />

Constant Value: 2 (0x00000002)

### DEVICE_ROLE_INITIATOR

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

```
public static final int DEVICE_ROLE_INITIATOR
```

The device that initiates the session.

<br />

Constant Value: 1 (0x00000001)

### DEVICE_ROLE_RESPONDER

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

```
public static final int DEVICE_ROLE_RESPONDER
```

The device that responds to a session.

<br />

Constant Value: 0 (0x00000000)

## Fields

### CREATOR

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

```
public static final Creator<RangingPreference> 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` |

### getDeviceRole

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

```
public int getDeviceRole ()
```

Returns the device role.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_RESPONDER` - `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_INITIATOR` - `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_DT_TAG` |

### getRangingParams

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

```
public RangingConfig getRangingParams ()
```

Returns the ranging parameters associated with this preference.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/RangingConfig` | the `https://developer.android.com/reference/android/ranging/RangingConfig` or `null` if not set. <br /> |

### getSessionConfig

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

```
public SessionConfig getSessionConfig ()
```

Returns the ranging session configuration params.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/SessionConfig` | a non-null `https://developer.android.com/reference/android/ranging/SessionConfig` instance. <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` |