Added in API level 36

RangingPreference


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 for creating instances of RangingPreference.

Constants
static Int

The device that initiates the session.

static Int

The device that responds to a session.

Inherited constants
Public methods
Int

Int

Returns the device role.

RangingConfig?

Returns the ranging parameters associated with this preference.

SessionConfig

Returns the ranging session configuration params.

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RangingPreference!>

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
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getDeviceRole

Added in API level 36
fun getDeviceRole(): Int

Returns the device role.

Return
Int Value is android.ranging.RangingPreference#DEVICE_ROLE_RESPONDER, or android.ranging.RangingPreference#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
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 36
static val CREATOR: Parcelable.Creator<RangingPreference!>