Added in Android Baklava

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SessionConfig

---

Kotlin |Java

public final class SessionConfig
extends Object implements Parcelable

java.lang.Object
↳	android.ranging.SessionConfig

---

Defines the ranging session configurations.

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

Summary

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

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<SessionConfig>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
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.
boolean	isAngleOfArrivalNeeded() Returns whether Angle-of-arrival was requested by the app.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in Android Baklava

public static final Creator<SessionConfig> CREATOR

Public methods

describeContents

Added in Android Baklava

public int describeContents ()

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.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getDataNotificationConfig

Added in Android Baklava

public DataNotificationConfig getDataNotificationConfig ()

Returns the data notification configuration for this preference.

Returns
DataNotificationConfig	a non-null DataNotificationConfig instance.

getRangingMeasurementsLimit

Added in Android Baklava

public int getRangingMeasurementsLimit ()

Returns the configured ranging measurements limit for the ranging session.

Returns
int	Value is between 0 and 65535 inclusive

getSensorFusionParams

Added in Android Baklava

public SensorFusionParams getSensorFusionParams ()

Returns the sensor fusion parameters used for this preference.

Returns
SensorFusionParams	a non-null SensorFusionParams instance.

isAngleOfArrivalNeeded

Added in Android Baklava

public boolean isAngleOfArrivalNeeded ()

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

Returns
boolean

toString

Added in Android Baklava

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in Android Baklava

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES