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`.

Constants
static Int	`ANTENNA_MODE_DIRECTIONAL` The "patch" antenna is used for both Tx and Rx.
static Int	`ANTENNA_MODE_OMNI` The "ranging" antenna is used for both Tx and Rx.

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?)` Indicates whether some other object is "equal to" this one.
Int	`getAntennaMode()` Returns antenna mode of the session.
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()` Returns a hash code value for the object.
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`

Constants

ANTENNA_MODE_DIRECTIONAL

Added in API level 37

static val ANTENNA_MODE_DIRECTIONAL: Int

The "patch" antenna is used for both Tx and Rx. *

Value: 1

ANTENNA_MODE_OMNI

Added in API level 37

static val ANTENNA_MODE_OMNI: Int

The "ranging" antenna is used for both Tx and Rx. *

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(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

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

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

getAntennaMode

Added in API level 37

fun getAntennaMode(): Int

Returns antenna mode of the session.

Return
`Int`	the antenna mode. Value is one of the following: `ANTENNA_MODE_OMNI` `ANTENNA_MODE_DIRECTIONAL`

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

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

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