Added in API level 36

RangingPreference

Kotlin |Java

public final class RangingPreference
extends Object implements Parcelable

java.lang.Object
↳	android.ranging.RangingPreference

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 Builder to construct an instance with custom configurations.

Summary

Nested classes
`class`	`RangingPreference.Builder` Builder for creating instances of `RangingPreference`.

Constants
`int`	`DEVICE_ROLE_INITIATOR` The device that initiates the session.
`int`	`DEVICE_ROLE_RESPONDER` The device that responds to a session.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, 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)`".

Fields
`public static final Creator<RangingPreference>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getDeviceRole()` Returns the device role.
`RangingConfig`	`getRangingParams()` Returns the ranging parameters associated with this preference.
`SessionConfig`	`getSessionConfig()` Returns the ranging session configuration params.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

DEVICE_ROLE_INITIATOR

Added in API level 36

public static final int DEVICE_ROLE_INITIATOR

The device that initiates the session.

Constant Value: 1 (0x00000001)

DEVICE_ROLE_RESPONDER

Added in API level 36

public static final int DEVICE_ROLE_RESPONDER

The device that responds to a session.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 36

public static final Creator<RangingPreference> CREATOR

Public methods

describeContents

Added in API level 36

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 writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getDeviceRole

Added in API level 36

public int getDeviceRole ()

Returns the device role.

Returns
`int`	Value is `DEVICE_ROLE_RESPONDER`, or `DEVICE_ROLE_INITIATOR`

getRangingParams

Added in API level 36

public RangingConfig getRangingParams ()

Returns the ranging parameters associated with this preference.

Returns
`RangingConfig`	the `RangingConfig` or `null` if not set.

getSessionConfig

Added in API level 36

public SessionConfig getSessionConfig ()

Returns the ranging session configuration params.

Returns
`SessionConfig`	a non-null `SessionConfig` instance.

toString

Added in API level 36

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

RangingPreference

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

DEVICE_ROLE_INITIATOR

DEVICE_ROLE_RESPONDER

Fields

CREATOR

Public methods

describeContents

getDeviceRole

getRangingParams

getSessionConfig

toString

writeToParcel