SessionConfig

Kotlin |Java

class SessionConfig : Parcelable

kotlin.Any
↳	android.ranging.SessionConfig

Defines the ranging session configurations.

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

Summary

Nested classes
	`Builder` Builder for creating instances of `SessionConfig`.

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.
Boolean	`equals(other: Any?)`
DataNotificationConfig	`getDataNotificationConfig()` Returns the data notification configuration for this preference.
Int	`getRangingMeasurementsLimit()` Returns the configured ranging measurements limit for the ranging session.
SensorFusionParams	`getSensorFusionParams()` Returns the sensor fusion parameters used for this preference.
Int	`hashCode()`
Boolean	`isAngleOfArrivalNeeded()` Returns whether Angle-of-arrival was requested by the app.
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<SessionConfig!>	`CREATOR`

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`

equals

Added in API level 36

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getDataNotificationConfig

Added in API level 36

fun getDataNotificationConfig(): DataNotificationConfig

Returns the data notification configuration for this preference.

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

getRangingMeasurementsLimit

Added in API level 36

fun getRangingMeasurementsLimit(): Int

Returns the configured ranging measurements limit for the ranging session.

Return
`Int`	Value is between 0 and 65535 inclusive

getSensorFusionParams

Added in API level 36

fun getSensorFusionParams(): SensorFusionParams

Returns the sensor fusion parameters used for this preference.

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

hashCode

Added in API level 36

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

isAngleOfArrivalNeeded

Added in API level 36

fun isAngleOfArrivalNeeded(): Boolean

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

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<SessionConfig!>