SessionConfig


class SessionConfig : Parcelable

Defines the ranging session configurations.

This class allows apps to set various parameters related to a ranging session.

Summary

Nested classes

Builder for creating instances of SessionConfig.

Inherited constants
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

DataNotificationConfig

Returns the data notification configuration for this preference.

Int

Returns the configured ranging measurements limit for the ranging session.

SensorFusionParams

Returns the sensor fusion parameters used for this preference.

Boolean

Returns whether Angle-of-arrival was requested by the app.

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Public methods

describeContents

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

getDataNotificationConfig

fun getDataNotificationConfig(): DataNotificationConfig

Returns the data notification configuration for this preference.

Return
DataNotificationConfig a non-null DataNotificationConfig instance.

getRangingMeasurementsLimit

fun getRangingMeasurementsLimit(): Int

Returns the configured ranging measurements limit for the ranging session.

Return
Int Value is between 0 and 65535 inclusive

getSensorFusionParams

fun getSensorFusionParams(): SensorFusionParams

Returns the sensor fusion parameters used for this preference.

Return
SensorFusionParams a non-null SensorFusionParams instance.

isAngleOfArrivalNeeded

fun isAngleOfArrivalNeeded(): Boolean

Returns whether Angle-of-arrival was requested by the app.

toString

fun toString(): String
Return
String a string representation of the object.

writeToParcel

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

static val CREATOR: Parcelable.Creator<SessionConfig!>