SessionConfig
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 |
Inherited constants |
|---|
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 | |
|---|---|
Fields
Public methods
describeContents
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
public DataNotificationConfig getDataNotificationConfig ()
Returns the data notification configuration for this preference.
| Returns | |
|---|---|
DataNotificationConfig | a non-null DataNotificationConfig instance. |
getRangingMeasurementsLimit
public int getRangingMeasurementsLimit ()
Returns the configured ranging measurements limit for the ranging session.
| Returns | |
|---|---|
int | Value is between 0 and 65535 inclusive |
getSensorFusionParams
public SensorFusionParams getSensorFusionParams ()
Returns the sensor fusion parameters used for this preference.
| Returns | |
|---|---|
SensorFusionParams | a non-null SensorFusionParams instance. |
isAngleOfArrivalNeeded
public boolean isAngleOfArrivalNeeded ()
Returns whether Angle-of-arrival was requested by the app.
| Returns | |
|---|---|
boolean | |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String | a string representation of the object. |
writeToParcel
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.