RangingPreference

Kotlin |Java

class RangingPreference : Parcelable

kotlin.Any
↳	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
	`Builder` Builder for creating instances of `RangingPreference`.

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

Inherited constants

From class 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: 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.

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.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RangingPreference!>	`CREATOR`

Constants

DEVICE_ROLE_INITIATOR

Added in API level 36

static val DEVICE_ROLE_INITIATOR: Int

The device that initiates the session.

Value: 1

DEVICE_ROLE_RESPONDER

Added in API level 36

static val DEVICE_ROLE_RESPONDER: Int

The device that responds to a session.

Value: 0

Public methods

describeContents

Added in API level 36

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(android.os.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 `CONTENTS_FILE_DESCRIPTOR`

getDeviceRole

Added in API level 36

fun getDeviceRole(): Int

Returns the device role.

Return
`Int`	Value is one of the following: `DEVICE_ROLE_RESPONDER` `DEVICE_ROLE_INITIATOR`

getRangingParams

Added in API level 36

fun getRangingParams(): RangingConfig?

Returns the ranging parameters associated with this preference.

Return
`RangingConfig?`	the `RangingConfig` or `null` if not set.

getSessionConfig

Added in API level 36

fun getSessionConfig(): SessionConfig

Returns the ranging session configuration params.

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

toString

Added in API level 36

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 36

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: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<RangingPreference!>